Documentation ¶
Index ¶
- Variables
- type FallbackPolicy
- func (FallbackPolicy) Descriptor() protoreflect.EnumDescriptor
- func (x FallbackPolicy) Enum() *FallbackPolicy
- func (FallbackPolicy) EnumDescriptor() ([]byte, []int)deprecated
- func (x FallbackPolicy) Number() protoreflect.EnumNumber
- func (x FallbackPolicy) String() string
- func (FallbackPolicy) Type() protoreflect.EnumType
- type Selector
- func (m *Selector) Clone() proto.Message
- func (*Selector) Descriptor() ([]byte, []int)deprecated
- func (m *Selector) Equal(that interface{}) bool
- func (x *Selector) GetKeys() []string
- func (x *Selector) GetSingleHostPerSubset() bool
- func (m *Selector) Hash(hasher hash.Hash64) (uint64, error)deprecated
- func (m *Selector) HashUnique(hasher hash.Hash64) (uint64, error)
- func (*Selector) ProtoMessage()
- func (x *Selector) ProtoReflect() protoreflect.Message
- func (x *Selector) Reset()
- func (x *Selector) String() string
- type ServiceSpec
- func (m *ServiceSpec) Clone() proto.Message
- func (*ServiceSpec) Descriptor() ([]byte, []int)deprecated
- func (m *ServiceSpec) Equal(that interface{}) bool
- func (x *ServiceSpec) GetGraphql() *graphql.ServiceSpec
- func (x *ServiceSpec) GetGrpc() *grpc.ServiceSpecdeprecated
- func (x *ServiceSpec) GetGrpcJsonTranscoder() *grpc_json.GrpcJsonTranscoder
- func (m *ServiceSpec) GetPluginType() isServiceSpec_PluginType
- func (x *ServiceSpec) GetRest() *rest.ServiceSpec
- func (m *ServiceSpec) Hash(hasher hash.Hash64) (uint64, error)deprecated
- func (m *ServiceSpec) HashUnique(hasher hash.Hash64) (uint64, error)
- func (*ServiceSpec) ProtoMessage()
- func (x *ServiceSpec) ProtoReflect() protoreflect.Message
- func (x *ServiceSpec) Reset()
- func (x *ServiceSpec) String() string
- type ServiceSpec_Graphql
- type ServiceSpec_Grpc
- type ServiceSpec_GrpcJsonTranscoder
- type ServiceSpec_Rest
- type Subset
- func (m *Subset) Clone() proto.Message
- func (*Subset) Descriptor() ([]byte, []int)deprecated
- func (m *Subset) Equal(that interface{}) bool
- func (x *Subset) GetValues() map[string]string
- func (m *Subset) Hash(hasher hash.Hash64) (uint64, error)deprecated
- func (m *Subset) HashUnique(hasher hash.Hash64) (uint64, error)
- func (*Subset) ProtoMessage()
- func (x *Subset) ProtoReflect() protoreflect.Message
- func (x *Subset) Reset()
- func (x *Subset) String() string
- type SubsetSpec
- func (m *SubsetSpec) Clone() proto.Message
- func (*SubsetSpec) Descriptor() ([]byte, []int)deprecated
- func (m *SubsetSpec) Equal(that interface{}) bool
- func (x *SubsetSpec) GetDefaultSubset() *Subset
- func (x *SubsetSpec) GetFallbackPolicy() FallbackPolicy
- func (x *SubsetSpec) GetSelectors() []*Selector
- func (m *SubsetSpec) Hash(hasher hash.Hash64) (uint64, error)deprecated
- func (m *SubsetSpec) HashUnique(hasher hash.Hash64) (uint64, error)
- func (*SubsetSpec) ProtoMessage()
- func (x *SubsetSpec) ProtoReflect() protoreflect.Message
- func (x *SubsetSpec) Reset()
- func (x *SubsetSpec) String() string
Constants ¶
This section is empty.
Variables ¶
var ( FallbackPolicy_name = map[int32]string{ 0: "ANY_ENDPOINT", 1: "DEFAULT_SUBSET", 2: "NO_FALLBACK", } FallbackPolicy_value = map[string]int32{ "ANY_ENDPOINT": 0, "DEFAULT_SUBSET": 1, "NO_FALLBACK": 2, } )
Enum value maps for FallbackPolicy.
var File_github_com_solo_io_gloo_projects_gloo_api_v1_options_service_spec_proto protoreflect.FileDescriptor
var File_github_com_solo_io_gloo_projects_gloo_api_v1_options_subset_spec_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type FallbackPolicy ¶ added in v1.9.0
type FallbackPolicy int32
const ( // Any cluster endpoint may be returned (default) FallbackPolicy_ANY_ENDPOINT FallbackPolicy = 0 // Load balancing over the endpoints matching the values from the default_subset field FallbackPolicy_DEFAULT_SUBSET FallbackPolicy = 1 // A result equivalent to no healthy hosts is reported FallbackPolicy_NO_FALLBACK FallbackPolicy = 2 )
func (FallbackPolicy) Descriptor ¶ added in v1.9.0
func (FallbackPolicy) Descriptor() protoreflect.EnumDescriptor
func (FallbackPolicy) Enum ¶ added in v1.9.0
func (x FallbackPolicy) Enum() *FallbackPolicy
func (FallbackPolicy) EnumDescriptor
deprecated
added in
v1.9.0
func (FallbackPolicy) EnumDescriptor() ([]byte, []int)
Deprecated: Use FallbackPolicy.Descriptor instead.
func (FallbackPolicy) Number ¶ added in v1.9.0
func (x FallbackPolicy) Number() protoreflect.EnumNumber
func (FallbackPolicy) String ¶ added in v1.9.0
func (x FallbackPolicy) String() string
func (FallbackPolicy) Type ¶ added in v1.9.0
func (FallbackPolicy) Type() protoreflect.EnumType
type Selector ¶
type Selector struct { // A subset is created for each unique combination of key and value Keys []string `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"` // Selects a mode of operation in which each subset has only one host. Default is false. SingleHostPerSubset bool `protobuf:"varint,2,opt,name=single_host_per_subset,json=singleHostPerSubset,proto3" json:"single_host_per_subset,omitempty"` // contains filtered or unexported fields }
func (*Selector) Descriptor
deprecated
func (*Selector) GetSingleHostPerSubset ¶ added in v1.9.0
func (*Selector) Hash
deprecated
added in
v1.2.13
func (*Selector) HashUnique ¶ added in v1.18.0
HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.
func (*Selector) ProtoMessage ¶
func (*Selector) ProtoMessage()
func (*Selector) ProtoReflect ¶ added in v1.6.0
func (x *Selector) ProtoReflect() protoreflect.Message
type ServiceSpec ¶
type ServiceSpec struct { // Note to developers: new Service plugins must be added to this oneof field // to be usable by Gloo. (plugins currently need to be compiled into Gloo) // The GraphQL feature is deprecated and will be removed in a future release. // // Types that are assignable to PluginType: // // *ServiceSpec_Rest // *ServiceSpec_Grpc // *ServiceSpec_GrpcJsonTranscoder // *ServiceSpec_Graphql PluginType isServiceSpec_PluginType `protobuf_oneof:"plugin_type"` // contains filtered or unexported fields }
Describes APIs and application-level information for services Gloo routes to. ServiceSpec is contained within the UpstreamSpec for certain types of upstreams, including Kubernetes, Consul, and Static. ServiceSpec configuration is opaque to Gloo and handled by Service Options.
func (*ServiceSpec) Clone ¶ added in v1.8.24
func (m *ServiceSpec) Clone() proto.Message
Clone function
func (*ServiceSpec) Descriptor
deprecated
func (*ServiceSpec) Descriptor() ([]byte, []int)
Deprecated: Use ServiceSpec.ProtoReflect.Descriptor instead.
func (*ServiceSpec) GetGraphql ¶ added in v1.14.0
func (x *ServiceSpec) GetGraphql() *graphql.ServiceSpec
func (*ServiceSpec) GetGrpc
deprecated
func (x *ServiceSpec) GetGrpc() *grpc.ServiceSpec
Deprecated: Marked as deprecated in github.com/solo-io/gloo/projects/gloo/api/v1/options/service_spec.proto.
func (*ServiceSpec) GetGrpcJsonTranscoder ¶ added in v1.14.0
func (x *ServiceSpec) GetGrpcJsonTranscoder() *grpc_json.GrpcJsonTranscoder
func (*ServiceSpec) GetPluginType ¶
func (m *ServiceSpec) GetPluginType() isServiceSpec_PluginType
func (*ServiceSpec) GetRest ¶
func (x *ServiceSpec) GetRest() *rest.ServiceSpec
func (*ServiceSpec) Hash
deprecated
added in
v1.2.13
func (m *ServiceSpec) Hash(hasher hash.Hash64) (uint64, error)
Hash function
Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.
func (*ServiceSpec) HashUnique ¶ added in v1.18.0
func (m *ServiceSpec) HashUnique(hasher hash.Hash64) (uint64, error)
HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.
func (*ServiceSpec) ProtoMessage ¶
func (*ServiceSpec) ProtoMessage()
func (*ServiceSpec) ProtoReflect ¶ added in v1.6.0
func (x *ServiceSpec) ProtoReflect() protoreflect.Message
func (*ServiceSpec) Reset ¶
func (x *ServiceSpec) Reset()
func (*ServiceSpec) String ¶
func (x *ServiceSpec) String() string
type ServiceSpec_Graphql ¶ added in v1.14.0
type ServiceSpec_Graphql struct {
Graphql *graphql.ServiceSpec `protobuf:"bytes,4,opt,name=graphql,proto3,oneof"`
}
type ServiceSpec_Grpc ¶
type ServiceSpec_Grpc struct { // Deprecated: Marked as deprecated in github.com/solo-io/gloo/projects/gloo/api/v1/options/service_spec.proto. Grpc *grpc.ServiceSpec `protobuf:"bytes,2,opt,name=grpc,proto3,oneof"` }
type ServiceSpec_GrpcJsonTranscoder ¶ added in v1.14.0
type ServiceSpec_GrpcJsonTranscoder struct {
GrpcJsonTranscoder *grpc_json.GrpcJsonTranscoder `protobuf:"bytes,3,opt,name=grpc_json_transcoder,json=grpcJsonTranscoder,proto3,oneof"`
}
type ServiceSpec_Rest ¶
type ServiceSpec_Rest struct {
Rest *rest.ServiceSpec `protobuf:"bytes,1,opt,name=rest,proto3,oneof"`
}
type Subset ¶ added in v1.9.0
type Subset struct { // Any host that matches all key/value pairs is part of this subset Values map[string]string `` /* 153-byte string literal not displayed */ // contains filtered or unexported fields }
func (*Subset) Descriptor
deprecated
added in
v1.9.0
func (*Subset) Hash
deprecated
added in
v1.9.0
func (*Subset) HashUnique ¶ added in v1.18.0
HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.
func (*Subset) ProtoMessage ¶ added in v1.9.0
func (*Subset) ProtoMessage()
func (*Subset) ProtoReflect ¶ added in v1.9.0
func (x *Subset) ProtoReflect() protoreflect.Message
type SubsetSpec ¶
type SubsetSpec struct { // Defines the set of subsets of the upstream Selectors []*Selector `protobuf:"bytes,1,rep,name=selectors,proto3" json:"selectors,omitempty"` // The behavior used when no endpoint subset matches the selected route’s metadata // The default value is ANY_ENDPOINT FallbackPolicy FallbackPolicy `protobuf:"varint,2,opt,name=fallbackPolicy,proto3,enum=options.gloo.solo.io.FallbackPolicy" json:"fallbackPolicy,omitempty"` // Specifies the default subset of endpoints used during fallback if fallback_policy is DEFAULT_SUBSET DefaultSubset *Subset `protobuf:"bytes,3,opt,name=default_subset,json=defaultSubset,proto3" json:"default_subset,omitempty"` // contains filtered or unexported fields }
See envoy docs for details: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#config-cluster-v3-cluster-lbsubsetconfig
func (*SubsetSpec) Clone ¶ added in v1.8.24
func (m *SubsetSpec) Clone() proto.Message
Clone function
func (*SubsetSpec) Descriptor
deprecated
func (*SubsetSpec) Descriptor() ([]byte, []int)
Deprecated: Use SubsetSpec.ProtoReflect.Descriptor instead.
func (*SubsetSpec) GetDefaultSubset ¶ added in v1.9.0
func (x *SubsetSpec) GetDefaultSubset() *Subset
func (*SubsetSpec) GetFallbackPolicy ¶ added in v1.9.0
func (x *SubsetSpec) GetFallbackPolicy() FallbackPolicy
func (*SubsetSpec) GetSelectors ¶
func (x *SubsetSpec) GetSelectors() []*Selector
func (*SubsetSpec) Hash
deprecated
added in
v1.2.13
func (m *SubsetSpec) Hash(hasher hash.Hash64) (uint64, error)
Hash function
Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.
func (*SubsetSpec) HashUnique ¶ added in v1.18.0
func (m *SubsetSpec) HashUnique(hasher hash.Hash64) (uint64, error)
HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.
func (*SubsetSpec) ProtoMessage ¶
func (*SubsetSpec) ProtoMessage()
func (*SubsetSpec) ProtoReflect ¶ added in v1.6.0
func (x *SubsetSpec) ProtoReflect() protoreflect.Message
func (*SubsetSpec) Reset ¶
func (x *SubsetSpec) Reset()
func (*SubsetSpec) String ¶
func (x *SubsetSpec) String() string