api

package
v0.17.82 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 28, 2025 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	SearchOption_Enum_name = map[int32]string{
		0:   "None",
		1:   "Facet",
		2:   "NoIndex",
		4:   "Exclude",
		8:   "Store",
		16:  "Sortable",
		32:  "Hidden",
		64:  "WithKeyword",
		128: "WithText",
	}
	SearchOption_Enum_value = map[string]int32{
		"None":        0,
		"Facet":       1,
		"NoIndex":     2,
		"Exclude":     4,
		"Store":       8,
		"Sortable":    16,
		"Hidden":      32,
		"WithKeyword": 64,
		"WithText":    128,
	}
)

Enum value maps for SearchOption_Enum.

View Source
var (
	// optional string allowed_roles = 1071;
	E_AllowedRoles = &file_annotations_proto_extTypes[0]
	// optional string cli_cmd = 1072;
	E_CliCmd = &file_annotations_proto_extTypes[1]
)

Extension fields to descriptorpb.MethodOptions.

View Source
var (
	// search is the option for OpenSearch Index.
	// It can include Index type:
	// facet|store|nested|object|flat_object|no_index,exclude.
	// - `object` for fields that should be indexed as object.
	// - `nested` for fields that should be indexed as nested.
	// - `flat_object` for nested fields that should not be indexed.
	// - `no_index` for fields that should not be indexed.
	// - `exclude` for fields that should not be included in the search results.
	// - `facet` for fields that should be indexed as facet.
	// - `store` for fields that should be stored.
	// - `hide` for fields that should be hidden in the search query by UI.
	// - `with_keyword` for text fields that also need keyword sub-index.
	// - `with_text` for keyword fields that also need text sub-index.
	// - other values are define type:
	// keyword|text|integer|float|double|boolean|date|geo_point|ip.
	//
	// optional string search = 51001;
	E_Search = &file_annotations_proto_extTypes[2]
	// display is the option for the field's Display Name in the UI.
	//
	// optional string display = 51002;
	E_Display = &file_annotations_proto_extTypes[3]
	// description is the option for the field's description.
	//
	// optional string description = 51003;
	E_Description = &file_annotations_proto_extTypes[4]
	// csv is the option for the field's Name in CSV header.
	//
	// optional string csv = 51004;
	E_Csv = &file_annotations_proto_extTypes[5]
	// required is the option for the field to be required.
	//
	// optional bool required = 51005;
	E_Required = &file_annotations_proto_extTypes[6]
	// required_or is the option for the field to be required, if one of the
	// other values is provided.
	//
	// optional string required_or = 51006;
	E_RequiredOr = &file_annotations_proto_extTypes[7]
	// min is the option for the field minimum length for strings, and minimum
	// value for numbers.
	//
	// optional uint32 min = 51007;
	E_Min = &file_annotations_proto_extTypes[8]
	// max is the option for the field maximum length for strings, and maximum
	// value for numbers.
	//
	// optional uint32 max = 51008;
	E_Max = &file_annotations_proto_extTypes[9]
)

Extension fields to descriptorpb.FieldOptions.

View Source
var (
	// args is the option for the field's arguments,
	// it can be used to specify the arguments for the enum value, as a string
	// of comma-separated values.
	// For example, "arg1,arg2,arg3" will be parsed as a list of strings
	//
	// optional string enum_args = 52001;
	E_EnumArgs = &file_annotations_proto_extTypes[11]
	// enum_display is the option for the field's Display Name in the UI.
	//
	// optional string enum_display = 52002;
	E_EnumDisplay = &file_annotations_proto_extTypes[12]
	// enum_description is the option for the field's description.
	//
	// optional string enum_description = 52003;
	E_EnumDescription = &file_annotations_proto_extTypes[13]
)

Extension fields to descriptorpb.EnumValueOptions.

View Source
var (
	// generate_meta is the option for generating the message's meta
	// information. By default, only for Request messages.
	//
	// optional bool generate_meta = 53001;
	E_GenerateMeta = &file_annotations_proto_extTypes[14]
	// message_display is the option for the message's Display Name in the UI.
	//
	// optional string message_display = 53002;
	E_MessageDisplay = &file_annotations_proto_extTypes[15]
	// message_description is the option for the message's description.
	//
	// optional string message_description = 53003;
	E_MessageDescription = &file_annotations_proto_extTypes[16]
	// table_source is the option for the message's field name to populate
	// table.
	//
	// optional string table_source = 53004;
	E_TableSource = &file_annotations_proto_extTypes[17]
	// table_header is the option for the default table header,
	// it can be a comma-separated list of field names.
	//
	// optional string table_header = 53005;
	E_TableHeader = &file_annotations_proto_extTypes[18]
)

Extension fields to descriptorpb.MessageOptions.

View Source
var DefaultDescriber = NewDescriber()
View Source
var (
	// is_bitmask marks the enum as a bitmask enum.
	//
	// optional bool is_bitmask = 54001;
	E_IsBitmask = &file_annotations_proto_extTypes[10]
)

Extension fields to descriptorpb.EnumOptions.

View Source
var File_annotations_proto protoreflect.FileDescriptor
View Source
var File_resources_proto protoreflect.FileDescriptor

Functions

func Describe added in v0.17.80

func Describe(w io.Writer, msg proto.Message)

Describe prints protobuf message to a human readable text

func DescribeMessage added in v0.17.80

func DescribeMessage(msg proto.Message) values.MapAny

DescribeMessage converts protobuf message to a human readable dictionary

func DocumentMessage added in v0.15.69

func DocumentMessage(w io.Writer, dscr *MessageDescription, indent string)

func Documentation added in v0.17.80

func Documentation(w io.Writer, doc string, indent string, noFirstIndent bool)

func DocumentationOneLine added in v0.17.80

func DocumentationOneLine(w io.Writer, doc string)

func GetEnumDisplayValue added in v0.17.80

func GetEnumDisplayValue(enumDescriptor protoreflect.EnumDescriptor, value int32) string

GetEnumDisplayValue function to dynamically call DisplayName on an enum

Types

type ClientStreamAdapter

type ClientStreamAdapter[T any] struct {
	Msgs    <-chan *T
	ErrOnce sync.Once
	Err     error
	Ctx     context.Context
}

ClientStreamAdapter implements grpc.ServerStreamingClient[T] (and its underlying grpc.ClientStream) by reading from a channel.

func (*ClientStreamAdapter[T]) CloseSend

func (c *ClientStreamAdapter[T]) CloseSend() error

CloseSend is a no‑op for server‑streaming RPCs.

func (*ClientStreamAdapter[T]) Context

func (c *ClientStreamAdapter[T]) Context() context.Context

Context returns the caller’s context.

func (*ClientStreamAdapter[T]) Header

func (c *ClientStreamAdapter[T]) Header() (metadata.MD, error)

Header is a no‑op here.

func (*ClientStreamAdapter[T]) Recv

func (c *ClientStreamAdapter[T]) Recv() (*T, error)

Recv gives you the next value from the channel, or EOF/error when done.

func (*ClientStreamAdapter[T]) RecvMsg

func (c *ClientStreamAdapter[T]) RecvMsg(m any) error

RecvMsg must fill in the supplied pointer with the next message.

func (*ClientStreamAdapter[T]) SendMsg

func (c *ClientStreamAdapter[T]) SendMsg(_ any) error

SendMsg is a no‑op (unconditionally nil) for server‑streaming.

func (*ClientStreamAdapter[T]) Trailer

func (c *ClientStreamAdapter[T]) Trailer() metadata.MD

Trailer is a no‑op here.

type Describer added in v0.15.69

type Describer struct {
	EnumNameTypes map[string]reflect.Type
	// contains filtered or unexported fields
}

func NewDescriber added in v0.15.69

func NewDescriber(enumNameTypes ...map[string]reflect.Type) *Describer

func (*Describer) Describe added in v0.15.69

func (d *Describer) Describe(w io.Writer, msg proto.Message)

Describe prints protobuf message to a human readable text

func (*Describer) DescribeMessage added in v0.15.69

func (d *Describer) DescribeMessage(msg proto.Message) values.MapAny

DescribeMessage converts protobuf message to a human readable dictionary

func (*Describer) GetEnumDisplayValue added in v0.15.69

func (d *Describer) GetEnumDisplayValue(enumDescriptor protoreflect.EnumDescriptor, value int32) string

GetEnumDisplayValue function to dynamically call DisplayName on an enum

func (*Describer) RegisterEnumNameTypes added in v0.17.80

func (d *Describer) RegisterEnumNameTypes(enumNameTypes map[string]reflect.Type)

type DummyServerStream

type DummyServerStream struct {
	grpc.ServerStream
	Ctx context.Context
}

DummyServerStream implements the non‑message pieces of grpc.ServerStream.

func (DummyServerStream) Context

func (d DummyServerStream) Context() context.Context

func (DummyServerStream) SendHeader

func (d DummyServerStream) SendHeader(md metadata.MD) error

func (DummyServerStream) SetHeader

func (d DummyServerStream) SetHeader(md metadata.MD) error

func (DummyServerStream) SetTrailer

func (d DummyServerStream) SetTrailer(md metadata.MD)

type EnumDescription

type EnumDescription struct {
	Name          string      `protobuf:"bytes,1,opt,name=Name,proto3" json:"Name,omitempty"`
	Enums         []*EnumMeta `protobuf:"bytes,2,rep,name=Enums,proto3" json:"Enums,omitempty"`
	Documentation string      `protobuf:"bytes,3,opt,name=Documentation,proto3" json:"Documentation,omitempty"`
	// IsBitmask is the option for the enum to be a bitmask enum.
	IsBitmask bool   `protobuf:"varint,4,opt,name=IsBitmask,proto3" json:"IsBitmask,omitempty"`
	FullName  string `protobuf:"bytes,5,opt,name=FullName,proto3" json:"FullName,omitempty"`
	// contains filtered or unexported fields
}

func (*EnumDescription) Descriptor deprecated

func (*EnumDescription) Descriptor() ([]byte, []int)

Deprecated: Use EnumDescription.ProtoReflect.Descriptor instead.

func (*EnumDescription) GetDocumentation

func (x *EnumDescription) GetDocumentation() string

func (*EnumDescription) GetEnums

func (x *EnumDescription) GetEnums() []*EnumMeta

func (*EnumDescription) GetFullName added in v0.17.78

func (x *EnumDescription) GetFullName() string

func (*EnumDescription) GetIsBitmask added in v0.17.78

func (x *EnumDescription) GetIsBitmask() bool

func (*EnumDescription) GetName

func (x *EnumDescription) GetName() string

func (*EnumDescription) ProtoMessage

func (*EnumDescription) ProtoMessage()

func (*EnumDescription) ProtoReflect

func (x *EnumDescription) ProtoReflect() protoreflect.Message

func (*EnumDescription) Reset

func (x *EnumDescription) Reset()

func (*EnumDescription) String

func (x *EnumDescription) String() string

type EnumMeta

type EnumMeta struct {
	Value         int32    `protobuf:"varint,1,opt,name=Value,proto3" json:"Value,omitempty"`
	Name          string   `protobuf:"bytes,2,opt,name=Name,proto3" json:"Name,omitempty"`
	FullName      string   `protobuf:"bytes,3,opt,name=FullName,proto3" json:"FullName,omitempty"`
	Display       string   `protobuf:"bytes,4,opt,name=Display,proto3" json:"Display,omitempty"`
	Documentation string   `protobuf:"bytes,5,opt,name=Documentation,proto3" json:"Documentation,omitempty"`
	Args          []string `protobuf:"bytes,6,rep,name=Args,proto3" json:"Args,omitempty"`
	// contains filtered or unexported fields
}

func (*EnumMeta) Descriptor deprecated

func (*EnumMeta) Descriptor() ([]byte, []int)

Deprecated: Use EnumMeta.ProtoReflect.Descriptor instead.

func (*EnumMeta) GetArgs

func (x *EnumMeta) GetArgs() []string

func (*EnumMeta) GetDisplay

func (x *EnumMeta) GetDisplay() string

func (*EnumMeta) GetDocumentation

func (x *EnumMeta) GetDocumentation() string

func (*EnumMeta) GetFullName

func (x *EnumMeta) GetFullName() string

func (*EnumMeta) GetName

func (x *EnumMeta) GetName() string

func (*EnumMeta) GetValue

func (x *EnumMeta) GetValue() int32

func (*EnumMeta) ProtoMessage

func (*EnumMeta) ProtoMessage()

func (*EnumMeta) ProtoReflect

func (x *EnumMeta) ProtoReflect() protoreflect.Message

func (*EnumMeta) Reset

func (x *EnumMeta) Reset()

func (*EnumMeta) String

func (x *EnumMeta) String() string

type FieldMeta

type FieldMeta struct {
	Name          string `protobuf:"bytes,1,opt,name=Name,proto3" json:"Name,omitempty"`
	FullName      string `protobuf:"bytes,2,opt,name=FullName,proto3" json:"FullName,omitempty"`
	Display       string `protobuf:"bytes,3,opt,name=Display,proto3" json:"Display,omitempty"`
	Documentation string `protobuf:"bytes,4,opt,name=Documentation,proto3" json:"Documentation,omitempty"`
	Type          string `protobuf:"bytes,5,opt,name=Type,proto3" json:"Type,omitempty"`
	GoType        string `protobuf:"bytes,6,opt,name=GoType,proto3" json:"GoType,omitempty"`
	// SearchType is the type of search for the field.
	// It can be one of the following:
	// keyword|text|integer|float|double|boolean|date|geo_point|ip|object|nested|flat_object.
	SearchType string `protobuf:"bytes,7,opt,name=SearchType,proto3" json:"SearchType,omitempty"`
	// SearchOptions is populated from es.api.search option.
	SearchOptions SearchOption_Enum `protobuf:"varint,8,opt,name=SearchOptions,proto3,enum=es.api.SearchOption_Enum" json:"SearchOptions,omitempty"`
	// Required is the option for the field to be required.
	Required bool `protobuf:"varint,9,opt,name=Required,proto3" json:"Required,omitempty"`
	// RequiredOr is the option for the field to be required, if one of the
	// other values is provided.
	RequiredOr []string `protobuf:"bytes,10,rep,name=RequiredOr,proto3" json:"RequiredOr,omitempty"`
	// Fields is provided for nested messages
	Fields []*FieldMeta `protobuf:"bytes,12,rep,name=Fields,proto3" json:"Fields,omitempty"`
	// EnumDescription is provided for enum fields
	EnumDescription *EnumDescription `protobuf:"bytes,13,opt,name=EnumDescription,proto3" json:"EnumDescription,omitempty"`
	// Min is the option for the field minimum length for strings, and minimum
	// value for numbers.
	Min int32 `protobuf:"varint,14,opt,name=Min,proto3" json:"Min,omitempty"`
	// Max is the option for the field maximum length for strings, and maximum
	// value for numbers.
	Max int32 `protobuf:"varint,15,opt,name=Max,proto3" json:"Max,omitempty"`
	// contains filtered or unexported fields
}

func (*FieldMeta) Descriptor deprecated

func (*FieldMeta) Descriptor() ([]byte, []int)

Deprecated: Use FieldMeta.ProtoReflect.Descriptor instead.

func (*FieldMeta) GetDisplay

func (x *FieldMeta) GetDisplay() string

func (*FieldMeta) GetDocumentation

func (x *FieldMeta) GetDocumentation() string

func (*FieldMeta) GetEnumDescription

func (x *FieldMeta) GetEnumDescription() *EnumDescription

func (*FieldMeta) GetFields

func (x *FieldMeta) GetFields() []*FieldMeta

func (*FieldMeta) GetFullName

func (x *FieldMeta) GetFullName() string

func (*FieldMeta) GetGoType

func (x *FieldMeta) GetGoType() string

func (*FieldMeta) GetMax added in v0.17.80

func (x *FieldMeta) GetMax() int32

func (*FieldMeta) GetMin added in v0.17.80

func (x *FieldMeta) GetMin() int32

func (*FieldMeta) GetName

func (x *FieldMeta) GetName() string

func (*FieldMeta) GetRequired added in v0.17.80

func (x *FieldMeta) GetRequired() bool

func (*FieldMeta) GetRequiredOr added in v0.17.80

func (x *FieldMeta) GetRequiredOr() []string

func (*FieldMeta) GetSearchOptions

func (x *FieldMeta) GetSearchOptions() SearchOption_Enum

func (*FieldMeta) GetSearchType

func (x *FieldMeta) GetSearchType() string

func (*FieldMeta) GetType

func (x *FieldMeta) GetType() string

func (*FieldMeta) ProtoMessage

func (*FieldMeta) ProtoMessage()

func (*FieldMeta) ProtoReflect

func (x *FieldMeta) ProtoReflect() protoreflect.Message

func (*FieldMeta) Reset

func (x *FieldMeta) Reset()

func (*FieldMeta) String

func (x *FieldMeta) String() string

type ListMeta added in v0.17.79

type ListMeta struct {
	NextCursor string `protobuf:"bytes,1,opt,name=NextCursor,proto3" json:"NextCursor,omitempty"`
	HasMore    bool   `protobuf:"varint,2,opt,name=HasMore,proto3" json:"HasMore,omitempty"`
	// TotalCount is the total number of items in the list,
	// available for the responses from Search when facets exist.
	// TotalCount may not be present in all responses, like from RDS.
	TotalCount int64 `protobuf:"varint,3,opt,name=TotalCount,proto3" json:"TotalCount,omitempty"`
	// contains filtered or unexported fields
}

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

func (*ListMeta) Descriptor deprecated added in v0.17.79

func (*ListMeta) Descriptor() ([]byte, []int)

Deprecated: Use ListMeta.ProtoReflect.Descriptor instead.

func (*ListMeta) GetHasMore added in v0.17.79

func (x *ListMeta) GetHasMore() bool

func (*ListMeta) GetNextCursor added in v0.17.79

func (x *ListMeta) GetNextCursor() string

func (*ListMeta) GetTotalCount added in v0.17.79

func (x *ListMeta) GetTotalCount() int64

func (*ListMeta) ProtoMessage added in v0.17.79

func (*ListMeta) ProtoMessage()

func (*ListMeta) ProtoReflect added in v0.17.79

func (x *ListMeta) ProtoReflect() protoreflect.Message

func (*ListMeta) Reset added in v0.17.79

func (x *ListMeta) Reset()

func (*ListMeta) String added in v0.17.79

func (x *ListMeta) String() string

type MessageDescription

type MessageDescription struct {
	Name          string       `protobuf:"bytes,1,opt,name=Name,proto3" json:"Name,omitempty"`
	Display       string       `protobuf:"bytes,2,opt,name=Display,proto3" json:"Display,omitempty"`
	Fields        []*FieldMeta `protobuf:"bytes,3,rep,name=Fields,proto3" json:"Fields,omitempty"`
	Documentation string       `protobuf:"bytes,4,opt,name=Documentation,proto3" json:"Documentation,omitempty"`
	FullName      string       `protobuf:"bytes,5,opt,name=FullName,proto3" json:"FullName,omitempty"`
	// TableSource is the option for the message's table source.
	TableSource string `protobuf:"bytes,6,opt,name=TableSource,proto3" json:"TableSource,omitempty"`
	// TableHeader is the option for the message's table header.
	TableHeader []string `protobuf:"bytes,7,rep,name=TableHeader,proto3" json:"TableHeader,omitempty"`
	// contains filtered or unexported fields
}

func (*MessageDescription) Descriptor deprecated

func (*MessageDescription) Descriptor() ([]byte, []int)

Deprecated: Use MessageDescription.ProtoReflect.Descriptor instead.

func (*MessageDescription) GetDisplay

func (x *MessageDescription) GetDisplay() string

func (*MessageDescription) GetDocumentation

func (x *MessageDescription) GetDocumentation() string

func (*MessageDescription) GetFields

func (x *MessageDescription) GetFields() []*FieldMeta

func (*MessageDescription) GetFullName added in v0.17.78

func (x *MessageDescription) GetFullName() string

func (*MessageDescription) GetName

func (x *MessageDescription) GetName() string

func (*MessageDescription) GetTableHeader added in v0.17.80

func (x *MessageDescription) GetTableHeader() []string

func (*MessageDescription) GetTableSource added in v0.17.80

func (x *MessageDescription) GetTableSource() string

func (*MessageDescription) ProtoMessage

func (*MessageDescription) ProtoMessage()

func (*MessageDescription) ProtoReflect

func (x *MessageDescription) ProtoReflect() protoreflect.Message

func (*MessageDescription) Reset

func (x *MessageDescription) Reset()

func (*MessageDescription) String

func (x *MessageDescription) String() string

type ObjectMeta added in v0.17.79

type ObjectMeta struct {

	// ID is the identifier for the resource, or empty if the resource is a list
	ID string `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"`
	// Kind is the type of resource this table represents.
	Kind string `protobuf:"bytes,2,opt,name=Kind,proto3" json:"Kind,omitempty"`
	// URI is the URI of the resource.
	URI string `protobuf:"bytes,3,opt,name=URI,proto3" json:"URI,omitempty"`
	// contains filtered or unexported fields
}

func (*ObjectMeta) Descriptor deprecated added in v0.17.79

func (*ObjectMeta) Descriptor() ([]byte, []int)

Deprecated: Use ObjectMeta.ProtoReflect.Descriptor instead.

func (*ObjectMeta) GetID added in v0.17.79

func (x *ObjectMeta) GetID() string

func (*ObjectMeta) GetKind added in v0.17.79

func (x *ObjectMeta) GetKind() string

func (*ObjectMeta) GetURI added in v0.17.79

func (x *ObjectMeta) GetURI() string

func (*ObjectMeta) ProtoMessage added in v0.17.79

func (*ObjectMeta) ProtoMessage()

func (*ObjectMeta) ProtoReflect added in v0.17.79

func (x *ObjectMeta) ProtoReflect() protoreflect.Message

func (*ObjectMeta) Reset added in v0.17.79

func (x *ObjectMeta) Reset()

func (*ObjectMeta) String added in v0.17.79

func (x *ObjectMeta) String() string

type ProxyClientStream

type ProxyClientStream[T any] struct {
	Msgs    <-chan *T
	ErrOnce sync.Once
	Err     error
	Ctx     context.Context
}

ProxyClientStream adapts that channel back into a grpc.ServerStreamingClient.

func (*ProxyClientStream[T]) CloseSend

func (p *ProxyClientStream[T]) CloseSend() error

func (*ProxyClientStream[T]) Context

func (p *ProxyClientStream[T]) Context() context.Context

func (*ProxyClientStream[T]) Header

func (p *ProxyClientStream[T]) Header() (metadata.MD, error)

implement ClientStream for grpc.ServerStreamingClient:

func (*ProxyClientStream[T]) Recv

func (p *ProxyClientStream[T]) Recv() (*T, error)

func (*ProxyClientStream[T]) RecvMsg

func (p *ProxyClientStream[T]) RecvMsg(m any) error

RecvMsg must populate the passed-in message. We call our Recv() to get the next *e2e.Basic, then copy it into m.

func (*ProxyClientStream[T]) SendMsg

func (p *ProxyClientStream[T]) SendMsg(m any) error

SendMsg is a no-op for server‑streaming RPCs.

func (*ProxyClientStream[T]) Trailer

func (p *ProxyClientStream[T]) Trailer() metadata.MD

type ResourceDefinition added in v0.17.80

type ResourceDefinition struct {

	// Service is the service name providing a resource.
	Service string `protobuf:"bytes,1,opt,name=Service,proto3" json:"Service,omitempty"`
	// Name is the plural name of the resource.
	Name string `protobuf:"bytes,2,opt,name=Name,proto3" json:"Name,omitempty"`
	// SingularName is the singular name of the resource.  This allows clients
	// to handle plural and singular opaquely. The SingularName is more correct
	// for reporting status on a single item and both singular and plural are
	// allowed from the CLI interface.
	SingularName string `protobuf:"bytes,3,opt,name=SingularName,proto3" json:"SingularName,omitempty"`
	// Kind is the type of resource.
	Kind string `protobuf:"bytes,4,opt,name=Kind,proto3" json:"Kind,omitempty"`
	// Scope is the scope of the resource.
	Scope string `protobuf:"bytes,5,opt,name=Scope,proto3" json:"Scope,omitempty"`
	// Verbs is the list of verbs that can be performed on the resource:
	// Get, List, Create, Update, Delete
	Verbs []string `protobuf:"bytes,6,rep,name=Verbs,proto3" json:"Verbs,omitempty"`
	// contains filtered or unexported fields
}

func (*ResourceDefinition) Descriptor deprecated added in v0.17.80

func (*ResourceDefinition) Descriptor() ([]byte, []int)

Deprecated: Use ResourceDefinition.ProtoReflect.Descriptor instead.

func (*ResourceDefinition) GetKind added in v0.17.80

func (x *ResourceDefinition) GetKind() string

func (*ResourceDefinition) GetName added in v0.17.80

func (x *ResourceDefinition) GetName() string

func (*ResourceDefinition) GetScope added in v0.17.80

func (x *ResourceDefinition) GetScope() string

func (*ResourceDefinition) GetService added in v0.17.80

func (x *ResourceDefinition) GetService() string

func (*ResourceDefinition) GetSingularName added in v0.17.80

func (x *ResourceDefinition) GetSingularName() string

func (*ResourceDefinition) GetVerbs added in v0.17.80

func (x *ResourceDefinition) GetVerbs() []string

func (*ResourceDefinition) ProtoMessage added in v0.17.80

func (*ResourceDefinition) ProtoMessage()

func (*ResourceDefinition) ProtoReflect added in v0.17.80

func (x *ResourceDefinition) ProtoReflect() protoreflect.Message

func (*ResourceDefinition) Reset added in v0.17.80

func (x *ResourceDefinition) Reset()

func (*ResourceDefinition) String added in v0.17.80

func (x *ResourceDefinition) String() string

type SearchOption

type SearchOption struct {
	// contains filtered or unexported fields
}

func (*SearchOption) Descriptor deprecated

func (*SearchOption) Descriptor() ([]byte, []int)

Deprecated: Use SearchOption.ProtoReflect.Descriptor instead.

func (*SearchOption) ProtoMessage

func (*SearchOption) ProtoMessage()

func (*SearchOption) ProtoReflect

func (x *SearchOption) ProtoReflect() protoreflect.Message

func (*SearchOption) Reset

func (x *SearchOption) Reset()

func (*SearchOption) String

func (x *SearchOption) String() string

type SearchOption_Enum

type SearchOption_Enum int32
const (
	// None is the default value.
	SearchOption_None SearchOption_Enum = 0
	// Facet is the option for the field to be indexed as facet.
	SearchOption_Facet SearchOption_Enum = 1
	// NoIndex is the option for the field to be not indexed.
	SearchOption_NoIndex SearchOption_Enum = 2
	// Exclude is the option for the field to be excluded from the search
	// results.
	SearchOption_Exclude SearchOption_Enum = 4
	// Store is the option for the field to be stored.
	SearchOption_Store SearchOption_Enum = 8
	// Sortable is the option for the field to be sortable.
	SearchOption_Sortable SearchOption_Enum = 16
	// Hidden is the option for the field to be hidden in the search query
	// builder or by UI.
	SearchOption_Hidden SearchOption_Enum = 32
	// WithKeyword is the option for text fields that also need
	// keyword sub-index.
	SearchOption_WithKeyword SearchOption_Enum = 64
	// WithText is the option for keyword fields that also need text
	// sub-index.
	SearchOption_WithText SearchOption_Enum = 128
)

func (SearchOption_Enum) Descriptor

func (SearchOption_Enum) Enum

func (SearchOption_Enum) EnumDescriptor deprecated

func (SearchOption_Enum) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchOption_Enum.Descriptor instead.

func (SearchOption_Enum) Number

func (SearchOption_Enum) String

func (x SearchOption_Enum) String() string

func (SearchOption_Enum) Type

type ServerStreamAdapter

type ServerStreamAdapter[T any] struct {
	DummyServerStream
	Msgs chan<- *T
}

ServerStreamAdapter lets us capture Send() calls into a channel.

func (*ServerStreamAdapter[T]) Send

func (s *ServerStreamAdapter[T]) Send(m *T) error

type Table added in v0.17.79

type Table struct {

	// ObjectMeta is the metadata of the resource.
	ObjectMeta *ObjectMeta `protobuf:"bytes,1,opt,name=ObjectMeta,proto3" json:"ObjectMeta,omitempty"`
	// ListMeta is the metadata of the list.
	ListMeta *ListMeta `protobuf:"bytes,2,opt,name=ListMeta,proto3" json:"ListMeta,omitempty"`
	// Columns is an array of column definitions.
	Columns []*TableColumnDefinition `protobuf:"bytes,3,rep,name=Columns,proto3" json:"Columns,omitempty"`
	// Rows is an array of rows.
	Rows []*TableRow `protobuf:"bytes,4,rep,name=Rows,proto3" json:"Rows,omitempty"`
	// contains filtered or unexported fields
}

Table is a generic table structure for representing tabular data.

func (*Table) Descriptor deprecated added in v0.17.79

func (*Table) Descriptor() ([]byte, []int)

Deprecated: Use Table.ProtoReflect.Descriptor instead.

func (*Table) GetColumns added in v0.17.79

func (x *Table) GetColumns() []*TableColumnDefinition

func (*Table) GetListMeta added in v0.17.79

func (x *Table) GetListMeta() *ListMeta

func (*Table) GetObjectMeta added in v0.17.79

func (x *Table) GetObjectMeta() *ObjectMeta

func (*Table) GetRows added in v0.17.79

func (x *Table) GetRows() []*TableRow

func (*Table) ProtoMessage added in v0.17.79

func (*Table) ProtoMessage()

func (*Table) ProtoReflect added in v0.17.79

func (x *Table) ProtoReflect() protoreflect.Message

func (*Table) Reset added in v0.17.79

func (x *Table) Reset()

func (*Table) String added in v0.17.79

func (x *Table) String() string

type TableColumnDefinition added in v0.17.79

type TableColumnDefinition struct {

	// ID is the identifier for the column, corresponds to the resource field
	// name
	ID string `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"`
	// Name is a human readable name for the column.
	Name string `protobuf:"bytes,2,opt,name=Name,proto3" json:"Name,omitempty"`
	// Type is an OpenAPI type definition for this column, such as number,
	// integer, string, or array. See
	// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types
	// for more.
	Type string `protobuf:"bytes,3,opt,name=Type,proto3" json:"Type,omitempty"`
	// Format is an optional OpenAPI type modifier for this column. A format
	// modifies the type and imposes additional rules, like date or time
	// formatting for a string. The 'name' format is applied to the primary
	// identifier column which has type 'string' to assist in clients
	// identifying column is the resource name. See
	// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types
	// for more.
	Format string `protobuf:"bytes,4,opt,name=Format,proto3" json:"Format,omitempty"`
	// Description is a human readable description of this column.
	Description string `protobuf:"bytes,5,opt,name=Description,proto3" json:"Description,omitempty"`
	// SearchOptions is populated from es.api.search option.
	SearchOptions SearchOption_Enum `protobuf:"varint,6,opt,name=SearchOptions,proto3,enum=es.api.SearchOption_Enum" json:"SearchOptions,omitempty"`
	// contains filtered or unexported fields
}

func (*TableColumnDefinition) Descriptor deprecated added in v0.17.79

func (*TableColumnDefinition) Descriptor() ([]byte, []int)

Deprecated: Use TableColumnDefinition.ProtoReflect.Descriptor instead.

func (*TableColumnDefinition) GetDescription added in v0.17.79

func (x *TableColumnDefinition) GetDescription() string

func (*TableColumnDefinition) GetFormat added in v0.17.79

func (x *TableColumnDefinition) GetFormat() string

func (*TableColumnDefinition) GetID added in v0.17.79

func (x *TableColumnDefinition) GetID() string

func (*TableColumnDefinition) GetName added in v0.17.79

func (x *TableColumnDefinition) GetName() string

func (*TableColumnDefinition) GetSearchOptions added in v0.17.79

func (x *TableColumnDefinition) GetSearchOptions() SearchOption_Enum

func (*TableColumnDefinition) GetType added in v0.17.79

func (x *TableColumnDefinition) GetType() string

func (*TableColumnDefinition) ProtoMessage added in v0.17.79

func (*TableColumnDefinition) ProtoMessage()

func (*TableColumnDefinition) ProtoReflect added in v0.17.79

func (x *TableColumnDefinition) ProtoReflect() protoreflect.Message

func (*TableColumnDefinition) Reset added in v0.17.79

func (x *TableColumnDefinition) Reset()

func (*TableColumnDefinition) String added in v0.17.79

func (x *TableColumnDefinition) String() string

type TableRow added in v0.17.79

type TableRow struct {

	// Cells will be as wide as the column definitions array and contain string
	// representation of basic types as:
	// strings, numbers (float64 or int64), booleans, simple maps, lists, or
	// null.
	// See the type field of the column definition for a more detailed
	// description.
	Cells []string `protobuf:"bytes,1,rep,name=Cells,proto3" json:"Cells,omitempty"`
	// contains filtered or unexported fields
}

TableRow is an individual row in a table.

func (*TableRow) Descriptor deprecated added in v0.17.79

func (*TableRow) Descriptor() ([]byte, []int)

Deprecated: Use TableRow.ProtoReflect.Descriptor instead.

func (*TableRow) GetCells added in v0.17.79

func (x *TableRow) GetCells() []string

func (*TableRow) ProtoMessage added in v0.17.79

func (*TableRow) ProtoMessage()

func (*TableRow) ProtoReflect added in v0.17.79

func (x *TableRow) ProtoReflect() protoreflect.Message

func (*TableRow) Reset added in v0.17.79

func (x *TableRow) Reset()

func (*TableRow) String added in v0.17.79

func (x *TableRow) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL