grpc_service_config

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Oct 26, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ServiceConfig_LoadBalancingPolicy_name = map[int32]string{
	0: "UNSPECIFIED",
	1: "ROUND_ROBIN",
}
View Source 
var ServiceConfig_LoadBalancingPolicy_value = map[string]int32{
	"UNSPECIFIED": 0,
	"ROUND_ROBIN": 1,
}

Functions

This section is empty.

Types

type CdsConfig 

type CdsConfig struct {
	Cluster              string   `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Configuration for the cds LB policy.

func (*CdsConfig) Descriptor 

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

func (*CdsConfig) GetCluster 

func (m *CdsConfig) GetCluster() string

func (*CdsConfig) ProtoMessage 

func (*CdsConfig) ProtoMessage()

func (*CdsConfig) Reset 

func (m *CdsConfig) Reset()

func (*CdsConfig) String 

func (m *CdsConfig) String() string

func (*CdsConfig) XXX_DiscardUnknown 

func (m *CdsConfig) XXX_DiscardUnknown()

func (*CdsConfig) XXX_Marshal 

func (m *CdsConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CdsConfig) XXX_Merge 

func (m *CdsConfig) XXX_Merge(src proto.Message)

func (*CdsConfig) XXX_Size 

func (m *CdsConfig) XXX_Size() int

func (*CdsConfig) XXX_Unmarshal 

func (m *CdsConfig) XXX_Unmarshal(b []byte) error

type GrpcLbConfig 

type GrpcLbConfig struct {
	// Optional.  What LB policy to use for routing between the backend
	// addresses.  If unset, defaults to round_robin.
	// Currently, the only supported values are round_robin and pick_first.
	// Note that this will be used both in balancer mode and in fallback mode.
	// Multiple LB policies can be specified; clients will iterate through
	// the list in order and stop at the first policy that they support.
	ChildPolicy []*LoadBalancingConfig `protobuf:"bytes,1,rep,name=child_policy,json=childPolicy,proto3" json:"child_policy,omitempty"`
	// Optional.  If specified, overrides the name of the service to be sent to
	// the balancer.
	ServiceName          string   `protobuf:"bytes,2,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Configuration for grpclb LB policy.

func (*GrpcLbConfig) Descriptor 

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

func (*GrpcLbConfig) GetChildPolicy 

func (m *GrpcLbConfig) GetChildPolicy() []*LoadBalancingConfig

func (*GrpcLbConfig) GetServiceName 

func (m *GrpcLbConfig) GetServiceName() string

func (*GrpcLbConfig) ProtoMessage 

func (*GrpcLbConfig) ProtoMessage()

func (*GrpcLbConfig) Reset 

func (m *GrpcLbConfig) Reset()

func (*GrpcLbConfig) String 

func (m *GrpcLbConfig) String() string

func (*GrpcLbConfig) XXX_DiscardUnknown 

func (m *GrpcLbConfig) XXX_DiscardUnknown()

func (*GrpcLbConfig) XXX_Marshal 

func (m *GrpcLbConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GrpcLbConfig) XXX_Merge 

func (m *GrpcLbConfig) XXX_Merge(src proto.Message)

func (*GrpcLbConfig) XXX_Size 

func (m *GrpcLbConfig) XXX_Size() int

func (*GrpcLbConfig) XXX_Unmarshal 

func (m *GrpcLbConfig) XXX_Unmarshal(b []byte) error

type LoadBalancingConfig 

type LoadBalancingConfig struct {
	// Exactly one LB policy may be configured.
	//
	// Types that are valid to be assigned to Policy:
	//	*LoadBalancingConfig_PickFirst
	//	*LoadBalancingConfig_RoundRobin
	//	*LoadBalancingConfig_Grpclb
	//	*LoadBalancingConfig_Cds
	//	*LoadBalancingConfig_Xds
	//	*LoadBalancingConfig_XdsExperimental
	Policy               isLoadBalancingConfig_Policy `protobuf_oneof:"policy"`
	XXX_NoUnkeyedLiteral struct{}                     `json:"-"`
	XXX_unrecognized     []byte                       `json:"-"`
	XXX_sizecache        int32                        `json:"-"`
}

Selects LB policy and provides corresponding configuration.

In general, all instances of this field should be repeated. Clients will iterate through the list in order and stop at the first policy that they support. This allows the service config to specify custom policies that may not be known to all clients.

  • If the config for the first supported policy is invalid, the whole service config is invalid.
  • If the list doesn't contain any supported policy, the whole service config is invalid.

func (*LoadBalancingConfig) Descriptor 

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

func (*LoadBalancingConfig) GetCds 

func (m *LoadBalancingConfig) GetCds() *CdsConfig

func (*LoadBalancingConfig) GetGrpclb 

func (m *LoadBalancingConfig) GetGrpclb() *GrpcLbConfig

func (*LoadBalancingConfig) GetPickFirst 

func (m *LoadBalancingConfig) GetPickFirst() *PickFirstConfig

func (*LoadBalancingConfig) GetPolicy 

func (m *LoadBalancingConfig) GetPolicy() isLoadBalancingConfig_Policy

func (*LoadBalancingConfig) GetRoundRobin 

func (m *LoadBalancingConfig) GetRoundRobin() *RoundRobinConfig

func (*LoadBalancingConfig) GetXds 

func (m *LoadBalancingConfig) GetXds() *XdsConfig

func (*LoadBalancingConfig) GetXdsExperimental 

func (m *LoadBalancingConfig) GetXdsExperimental() *XdsConfig

func (*LoadBalancingConfig) ProtoMessage 

func (*LoadBalancingConfig) ProtoMessage()

func (*LoadBalancingConfig) Reset 

func (m *LoadBalancingConfig) Reset()

func (*LoadBalancingConfig) String 

func (m *LoadBalancingConfig) String() string

func (*LoadBalancingConfig) XXX_DiscardUnknown 

func (m *LoadBalancingConfig) XXX_DiscardUnknown()

func (*LoadBalancingConfig) XXX_Marshal 

func (m *LoadBalancingConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LoadBalancingConfig) XXX_Merge 

func (m *LoadBalancingConfig) XXX_Merge(src proto.Message)

func (*LoadBalancingConfig) XXX_OneofWrappers 

func (*LoadBalancingConfig) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*LoadBalancingConfig) XXX_Size 

func (m *LoadBalancingConfig) XXX_Size() int

func (*LoadBalancingConfig) XXX_Unmarshal 

func (m *LoadBalancingConfig) XXX_Unmarshal(b []byte) error

type LoadBalancingConfig_Cds 

type LoadBalancingConfig_Cds struct {
	Cds *CdsConfig `protobuf:"bytes,6,opt,name=cds,proto3,oneof"`
}

type LoadBalancingConfig_Grpclb 

type LoadBalancingConfig_Grpclb struct {
	Grpclb *GrpcLbConfig `protobuf:"bytes,3,opt,name=grpclb,proto3,oneof"`
}

type LoadBalancingConfig_PickFirst 

type LoadBalancingConfig_PickFirst struct {
	PickFirst *PickFirstConfig `protobuf:"bytes,4,opt,name=pick_first,proto3,oneof"`
}

type LoadBalancingConfig_RoundRobin 

type LoadBalancingConfig_RoundRobin struct {
	RoundRobin *RoundRobinConfig `protobuf:"bytes,1,opt,name=round_robin,proto3,oneof"`
}

type LoadBalancingConfig_Xds 

type LoadBalancingConfig_Xds struct {
	Xds *XdsConfig `protobuf:"bytes,2,opt,name=xds,proto3,oneof"`
}

type LoadBalancingConfig_XdsExperimental 

type LoadBalancingConfig_XdsExperimental struct {
	XdsExperimental *XdsConfig `protobuf:"bytes,5,opt,name=xds_experimental,proto3,oneof"`
}

type MethodConfig 

type MethodConfig struct {
	Name []*MethodConfig_Name `protobuf:"bytes,1,rep,name=name,proto3" json:"name,omitempty"`
	// Whether RPCs sent to this method should wait until the connection is
	// ready by default. If false, the RPC will abort immediately if there is
	// a transient failure connecting to the server. Otherwise, gRPC will
	// attempt to connect until the deadline is exceeded.
	//
	// The value specified via the gRPC client API will override the value
	// set here. However, note that setting the value in the client API will
	// also affect transient errors encountered during name resolution, which
	// cannot be caught by the value here, since the service config is
	// obtained by the gRPC client via name resolution.
	WaitForReady *wrappers.BoolValue `protobuf:"bytes,2,opt,name=wait_for_ready,json=waitForReady,proto3" json:"wait_for_ready,omitempty"`
	// The default timeout in seconds for RPCs sent to this method. This can be
	// overridden in code. If no reply is received in the specified amount of
	// time, the request is aborted and a DEADLINE_EXCEEDED error status
	// is returned to the caller.
	//
	// The actual deadline used will be the minimum of the value specified here
	// and the value set by the application via the gRPC client API.  If either
	// one is not set, then the other will be used.  If neither is set, then the
	// request has no deadline.
	Timeout *duration.Duration `protobuf:"bytes,3,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// The maximum allowed payload size for an individual request or object in a
	// stream (client->server) in bytes. The size which is measured is the
	// serialized payload after per-message compression (but before stream
	// compression) in bytes. This applies both to streaming and non-streaming
	// requests.
	//
	// The actual value used is the minimum of the value specified here and the
	// value set by the application via the gRPC client API.  If either one is
	// not set, then the other will be used.  If neither is set, then the
	// built-in default is used.
	//
	// If a client attempts to send an object larger than this value, it will not
	// be sent and the client will see a ClientError.
	// Note that 0 is a valid value, meaning that the request message
	// must be empty.
	MaxRequestMessageBytes *wrappers.UInt32Value `` /* 131-byte string literal not displayed */
	// The maximum allowed payload size for an individual response or object in a
	// stream (server->client) in bytes. The size which is measured is the
	// serialized payload after per-message compression (but before stream
	// compression) in bytes. This applies both to streaming and non-streaming
	// requests.
	//
	// The actual value used is the minimum of the value specified here and the
	// value set by the application via the gRPC client API.  If either one is
	// not set, then the other will be used.  If neither is set, then the
	// built-in default is used.
	//
	// If a server attempts to send an object larger than this value, it will not
	// be sent, and a ServerError will be sent to the client instead.
	// Note that 0 is a valid value, meaning that the response message
	// must be empty.
	MaxResponseMessageBytes *wrappers.UInt32Value `` /* 134-byte string literal not displayed */
	// Only one of retry_policy or hedging_policy may be set. If neither is set,
	// RPCs will not be retried or hedged.
	//
	// Types that are valid to be assigned to RetryOrHedgingPolicy:
	//	*MethodConfig_RetryPolicy_
	//	*MethodConfig_HedgingPolicy_
	RetryOrHedgingPolicy isMethodConfig_RetryOrHedgingPolicy `protobuf_oneof:"retry_or_hedging_policy"`
	XXX_NoUnkeyedLiteral struct{}                            `json:"-"`
	XXX_unrecognized     []byte                              `json:"-"`
	XXX_sizecache        int32                               `json:"-"`
}

Configuration for a method.

func (*MethodConfig) Descriptor 

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

func (*MethodConfig) GetHedgingPolicy 

func (m *MethodConfig) GetHedgingPolicy() *MethodConfig_HedgingPolicy

func (*MethodConfig) GetMaxRequestMessageBytes 

func (m *MethodConfig) GetMaxRequestMessageBytes() *wrappers.UInt32Value

func (*MethodConfig) GetMaxResponseMessageBytes 

func (m *MethodConfig) GetMaxResponseMessageBytes() *wrappers.UInt32Value

func (*MethodConfig) GetName 

func (m *MethodConfig) GetName() []*MethodConfig_Name

func (*MethodConfig) GetRetryOrHedgingPolicy 

func (m *MethodConfig) GetRetryOrHedgingPolicy() isMethodConfig_RetryOrHedgingPolicy

func (*MethodConfig) GetRetryPolicy 

func (m *MethodConfig) GetRetryPolicy() *MethodConfig_RetryPolicy

func (*MethodConfig) GetTimeout 

func (m *MethodConfig) GetTimeout() *duration.Duration

func (*MethodConfig) GetWaitForReady 

func (m *MethodConfig) GetWaitForReady() *wrappers.BoolValue

func (*MethodConfig) ProtoMessage 

func (*MethodConfig) ProtoMessage()

func (*MethodConfig) Reset 

func (m *MethodConfig) Reset()

func (*MethodConfig) String 

func (m *MethodConfig) String() string

func (*MethodConfig) XXX_DiscardUnknown 

func (m *MethodConfig) XXX_DiscardUnknown()

func (*MethodConfig) XXX_Marshal 

func (m *MethodConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MethodConfig) XXX_Merge 

func (m *MethodConfig) XXX_Merge(src proto.Message)

func (*MethodConfig) XXX_OneofWrappers 

func (*MethodConfig) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*MethodConfig) XXX_Size 

func (m *MethodConfig) XXX_Size() int

func (*MethodConfig) XXX_Unmarshal 

func (m *MethodConfig) XXX_Unmarshal(b []byte) error

type MethodConfig_HedgingPolicy 

type MethodConfig_HedgingPolicy struct {
	// The hedging policy will send up to max_requests RPCs.
	// This number represents the total number of all attempts, including
	// the original attempt.
	//
	// This field is required and must be greater than 1.
	// Any value greater than 5 will be treated as if it were 5.
	MaxAttempts uint32 `protobuf:"varint,1,opt,name=max_attempts,json=maxAttempts,proto3" json:"max_attempts,omitempty"`
	// The first RPC will be sent immediately, but the max_requests-1 subsequent
	// hedged RPCs will be sent at intervals of every hedging_delay. Set this
	// to 0 to immediately send all max_requests RPCs.
	HedgingDelay *duration.Duration `protobuf:"bytes,2,opt,name=hedging_delay,json=hedgingDelay,proto3" json:"hedging_delay,omitempty"`
	// The set of status codes which indicate other hedged RPCs may still
	// succeed. If a non-fatal status code is returned by the server, hedged
	// RPCs will continue. Otherwise, outstanding requests will be canceled and
	// the error returned to the client application layer.
	//
	// This field is optional.
	NonFatalStatusCodes  []code.Code `` /* 151-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

The hedging policy for outgoing RPCs. Hedged RPCs may execute more than once on the server, so only idempotent methods should specify a hedging policy.

func (*MethodConfig_HedgingPolicy) Descriptor 

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

func (*MethodConfig_HedgingPolicy) GetHedgingDelay 

func (m *MethodConfig_HedgingPolicy) GetHedgingDelay() *duration.Duration

func (*MethodConfig_HedgingPolicy) GetMaxAttempts 

func (m *MethodConfig_HedgingPolicy) GetMaxAttempts() uint32

func (*MethodConfig_HedgingPolicy) GetNonFatalStatusCodes 

func (m *MethodConfig_HedgingPolicy) GetNonFatalStatusCodes() []code.Code

func (*MethodConfig_HedgingPolicy) ProtoMessage 

func (*MethodConfig_HedgingPolicy) ProtoMessage()

func (*MethodConfig_HedgingPolicy) Reset 

func (m *MethodConfig_HedgingPolicy) Reset()

func (*MethodConfig_HedgingPolicy) String 

func (m *MethodConfig_HedgingPolicy) String() string

func (*MethodConfig_HedgingPolicy) XXX_DiscardUnknown 

func (m *MethodConfig_HedgingPolicy) XXX_DiscardUnknown()

func (*MethodConfig_HedgingPolicy) XXX_Marshal 

func (m *MethodConfig_HedgingPolicy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MethodConfig_HedgingPolicy) XXX_Merge 

func (m *MethodConfig_HedgingPolicy) XXX_Merge(src proto.Message)

func (*MethodConfig_HedgingPolicy) XXX_Size 

func (m *MethodConfig_HedgingPolicy) XXX_Size() int

func (*MethodConfig_HedgingPolicy) XXX_Unmarshal 

func (m *MethodConfig_HedgingPolicy) XXX_Unmarshal(b []byte) error

type MethodConfig_HedgingPolicy_ 

type MethodConfig_HedgingPolicy_ struct {
	HedgingPolicy *MethodConfig_HedgingPolicy `protobuf:"bytes,7,opt,name=hedging_policy,json=hedgingPolicy,proto3,oneof"`
}

type MethodConfig_Name 

type MethodConfig_Name struct {
	Service              string   `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	Method               string   `protobuf:"bytes,2,opt,name=method,proto3" json:"method,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The names of the methods to which this configuration applies.

  • MethodConfig without names (empty list) will be skipped.
  • Each name entry must be unique across the entire ServiceConfig.
  • If the 'method' field is empty, this MethodConfig specifies the defaults for all methods for the specified service.
  • If the 'service' field is empty, the 'method' field must be empty, and this MethodConfig specifies the default for all methods (it's the default config).

When determining which MethodConfig to use for a given RPC, the most specific match wins. For example, let's say that the service config contains the following MethodConfig entries:

method_config { name { } ... } method_config { name { service: "MyService" } ... } method_config { name { service: "MyService" method: "Foo" } ... }

MyService/Foo will use the third entry, because it exactly matches the service and method name. MyService/Bar will use the second entry, because it provides the default for all methods of MyService. AnotherService/Baz will use the first entry, because it doesn't match the other two.

In JSON representation, value "", value `null`, and not present are the same. The following are the same Name: - { "service": "s" } - { "service": "s", "method": null } - { "service": "s", "method": "" }

func (*MethodConfig_Name) Descriptor 

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

func (*MethodConfig_Name) GetMethod 

func (m *MethodConfig_Name) GetMethod() string

func (*MethodConfig_Name) GetService 

func (m *MethodConfig_Name) GetService() string

func (*MethodConfig_Name) ProtoMessage 

func (*MethodConfig_Name) ProtoMessage()

func (*MethodConfig_Name) Reset 

func (m *MethodConfig_Name) Reset()

func (*MethodConfig_Name) String 

func (m *MethodConfig_Name) String() string

func (*MethodConfig_Name) XXX_DiscardUnknown 

func (m *MethodConfig_Name) XXX_DiscardUnknown()

func (*MethodConfig_Name) XXX_Marshal 

func (m *MethodConfig_Name) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MethodConfig_Name) XXX_Merge 

func (m *MethodConfig_Name) XXX_Merge(src proto.Message)

func (*MethodConfig_Name) XXX_Size 

func (m *MethodConfig_Name) XXX_Size() int

func (*MethodConfig_Name) XXX_Unmarshal 

func (m *MethodConfig_Name) XXX_Unmarshal(b []byte) error

type MethodConfig_RetryPolicy 

type MethodConfig_RetryPolicy struct {
	// The maximum number of RPC attempts, including the original attempt.
	//
	// This field is required and must be greater than 1.
	// Any value greater than 5 will be treated as if it were 5.
	MaxAttempts uint32 `protobuf:"varint,1,opt,name=max_attempts,json=maxAttempts,proto3" json:"max_attempts,omitempty"`
	// Exponential backoff parameters. The initial retry attempt will occur at
	// random(0, initial_backoff). In general, the nth attempt will occur at
	// random(0,
	//   min(initial_backoff*backoff_multiplier**(n-1), max_backoff)).
	// Required. Must be greater than zero.
	InitialBackoff *duration.Duration `protobuf:"bytes,2,opt,name=initial_backoff,json=initialBackoff,proto3" json:"initial_backoff,omitempty"`
	// Required. Must be greater than zero.
	MaxBackoff        *duration.Duration `protobuf:"bytes,3,opt,name=max_backoff,json=maxBackoff,proto3" json:"max_backoff,omitempty"`
	BackoffMultiplier float32            `protobuf:"fixed32,4,opt,name=backoff_multiplier,json=backoffMultiplier,proto3" json:"backoff_multiplier,omitempty"`
	// The set of status codes which may be retried.
	//
	// This field is required and must be non-empty.
	RetryableStatusCodes []code.Code `` /* 152-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

The retry policy for outgoing RPCs.

func (*MethodConfig_RetryPolicy) Descriptor 

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

func (*MethodConfig_RetryPolicy) GetBackoffMultiplier 

func (m *MethodConfig_RetryPolicy) GetBackoffMultiplier() float32

func (*MethodConfig_RetryPolicy) GetInitialBackoff 

func (m *MethodConfig_RetryPolicy) GetInitialBackoff() *duration.Duration

func (*MethodConfig_RetryPolicy) GetMaxAttempts 

func (m *MethodConfig_RetryPolicy) GetMaxAttempts() uint32

func (*MethodConfig_RetryPolicy) GetMaxBackoff 

func (m *MethodConfig_RetryPolicy) GetMaxBackoff() *duration.Duration

func (*MethodConfig_RetryPolicy) GetRetryableStatusCodes 

func (m *MethodConfig_RetryPolicy) GetRetryableStatusCodes() []code.Code

func (*MethodConfig_RetryPolicy) ProtoMessage 

func (*MethodConfig_RetryPolicy) ProtoMessage()

func (*MethodConfig_RetryPolicy) Reset 

func (m *MethodConfig_RetryPolicy) Reset()

func (*MethodConfig_RetryPolicy) String 

func (m *MethodConfig_RetryPolicy) String() string

func (*MethodConfig_RetryPolicy) XXX_DiscardUnknown 

func (m *MethodConfig_RetryPolicy) XXX_DiscardUnknown()

func (*MethodConfig_RetryPolicy) XXX_Marshal 

func (m *MethodConfig_RetryPolicy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MethodConfig_RetryPolicy) XXX_Merge 

func (m *MethodConfig_RetryPolicy) XXX_Merge(src proto.Message)

func (*MethodConfig_RetryPolicy) XXX_Size 

func (m *MethodConfig_RetryPolicy) XXX_Size() int

func (*MethodConfig_RetryPolicy) XXX_Unmarshal 

func (m *MethodConfig_RetryPolicy) XXX_Unmarshal(b []byte) error

type MethodConfig_RetryPolicy_ 

type MethodConfig_RetryPolicy_ struct {
	RetryPolicy *MethodConfig_RetryPolicy `protobuf:"bytes,6,opt,name=retry_policy,json=retryPolicy,proto3,oneof"`
}

type PickFirstConfig 

type PickFirstConfig struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Configuration for pick_first LB policy.

func (*PickFirstConfig) Descriptor 

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

func (*PickFirstConfig) ProtoMessage 

func (*PickFirstConfig) ProtoMessage()

func (*PickFirstConfig) Reset 

func (m *PickFirstConfig) Reset()

func (*PickFirstConfig) String 

func (m *PickFirstConfig) String() string

func (*PickFirstConfig) XXX_DiscardUnknown 

func (m *PickFirstConfig) XXX_DiscardUnknown()

func (*PickFirstConfig) XXX_Marshal 

func (m *PickFirstConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PickFirstConfig) XXX_Merge 

func (m *PickFirstConfig) XXX_Merge(src proto.Message)

func (*PickFirstConfig) XXX_Size 

func (m *PickFirstConfig) XXX_Size() int

func (*PickFirstConfig) XXX_Unmarshal 

func (m *PickFirstConfig) XXX_Unmarshal(b []byte) error

type RoundRobinConfig 

type RoundRobinConfig struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Configuration for round_robin LB policy.

func (*RoundRobinConfig) Descriptor 

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

func (*RoundRobinConfig) ProtoMessage 

func (*RoundRobinConfig) ProtoMessage()

func (*RoundRobinConfig) Reset 

func (m *RoundRobinConfig) Reset()

func (*RoundRobinConfig) String 

func (m *RoundRobinConfig) String() string

func (*RoundRobinConfig) XXX_DiscardUnknown 

func (m *RoundRobinConfig) XXX_DiscardUnknown()

func (*RoundRobinConfig) XXX_Marshal 

func (m *RoundRobinConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RoundRobinConfig) XXX_Merge 

func (m *RoundRobinConfig) XXX_Merge(src proto.Message)

func (*RoundRobinConfig) XXX_Size 

func (m *RoundRobinConfig) XXX_Size() int

func (*RoundRobinConfig) XXX_Unmarshal 

func (m *RoundRobinConfig) XXX_Unmarshal(b []byte) error

type ServiceConfig 

type ServiceConfig struct {
	LoadBalancingPolicy ServiceConfig_LoadBalancingPolicy `` // Deprecated: Do not use.
	/* 180-byte string literal not displayed */
	// Multiple LB policies can be specified; clients will iterate through
	// the list in order and stop at the first policy that they support. If none
	// are supported, the service config is considered invalid.
	LoadBalancingConfig []*LoadBalancingConfig `protobuf:"bytes,4,rep,name=load_balancing_config,json=loadBalancingConfig,proto3" json:"load_balancing_config,omitempty"`
	// Per-method configuration.
	MethodConfig         []*MethodConfig                      `protobuf:"bytes,2,rep,name=method_config,json=methodConfig,proto3" json:"method_config,omitempty"`
	RetryThrottling      *ServiceConfig_RetryThrottlingPolicy `protobuf:"bytes,3,opt,name=retry_throttling,json=retryThrottling,proto3" json:"retry_throttling,omitempty"`
	HealthCheckConfig    *ServiceConfig_HealthCheckConfig     `protobuf:"bytes,5,opt,name=health_check_config,json=healthCheckConfig,proto3" json:"health_check_config,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                             `json:"-"`
	XXX_unrecognized     []byte                               `json:"-"`
	XXX_sizecache        int32                                `json:"-"`
}

A ServiceConfig represents information about a service but is not specific to any name resolver.

func (*ServiceConfig) Descriptor 

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

func (*ServiceConfig) GetHealthCheckConfig 

func (m *ServiceConfig) GetHealthCheckConfig() *ServiceConfig_HealthCheckConfig

func (*ServiceConfig) GetLoadBalancingConfig 

func (m *ServiceConfig) GetLoadBalancingConfig() []*LoadBalancingConfig

func (*ServiceConfig) GetLoadBalancingPolicy deprecated 

func (m *ServiceConfig) GetLoadBalancingPolicy() ServiceConfig_LoadBalancingPolicy

Deprecated: Do not use.

func (*ServiceConfig) GetMethodConfig 

func (m *ServiceConfig) GetMethodConfig() []*MethodConfig

func (*ServiceConfig) GetRetryThrottling 

func (m *ServiceConfig) GetRetryThrottling() *ServiceConfig_RetryThrottlingPolicy

func (*ServiceConfig) ProtoMessage 

func (*ServiceConfig) ProtoMessage()

func (*ServiceConfig) Reset 

func (m *ServiceConfig) Reset()

func (*ServiceConfig) String 

func (m *ServiceConfig) String() string

func (*ServiceConfig) XXX_DiscardUnknown 

func (m *ServiceConfig) XXX_DiscardUnknown()

func (*ServiceConfig) XXX_Marshal 

func (m *ServiceConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServiceConfig) XXX_Merge 

func (m *ServiceConfig) XXX_Merge(src proto.Message)

func (*ServiceConfig) XXX_Size 

func (m *ServiceConfig) XXX_Size() int

func (*ServiceConfig) XXX_Unmarshal 

func (m *ServiceConfig) XXX_Unmarshal(b []byte) error

type ServiceConfig_HealthCheckConfig 

type ServiceConfig_HealthCheckConfig struct {
	// Service name to use in the health-checking request.
	ServiceName          *wrappers.StringValue `protobuf:"bytes,1,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{}              `json:"-"`
	XXX_unrecognized     []byte                `json:"-"`
	XXX_sizecache        int32                 `json:"-"`
}

func (*ServiceConfig_HealthCheckConfig) Descriptor 

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

func (*ServiceConfig_HealthCheckConfig) GetServiceName 

func (m *ServiceConfig_HealthCheckConfig) GetServiceName() *wrappers.StringValue

func (*ServiceConfig_HealthCheckConfig) ProtoMessage 

func (*ServiceConfig_HealthCheckConfig) ProtoMessage()

func (*ServiceConfig_HealthCheckConfig) Reset 

func (m *ServiceConfig_HealthCheckConfig) Reset()

func (*ServiceConfig_HealthCheckConfig) String 

func (m *ServiceConfig_HealthCheckConfig) String() string

func (*ServiceConfig_HealthCheckConfig) XXX_DiscardUnknown 

func (m *ServiceConfig_HealthCheckConfig) XXX_DiscardUnknown()

func (*ServiceConfig_HealthCheckConfig) XXX_Marshal 

func (m *ServiceConfig_HealthCheckConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServiceConfig_HealthCheckConfig) XXX_Merge 

func (m *ServiceConfig_HealthCheckConfig) XXX_Merge(src proto.Message)

func (*ServiceConfig_HealthCheckConfig) XXX_Size 

func (m *ServiceConfig_HealthCheckConfig) XXX_Size() int

func (*ServiceConfig_HealthCheckConfig) XXX_Unmarshal 

func (m *ServiceConfig_HealthCheckConfig) XXX_Unmarshal(b []byte) error

type ServiceConfig_LoadBalancingPolicy 

type ServiceConfig_LoadBalancingPolicy int32

Load balancing policy.

Note that load_balancing_policy is deprecated in favor of load_balancing_config; the former will be used only if the latter is unset.

If no LB policy is configured here, then the default is pick_first. If the policy name is set via the client API, that value overrides the value specified here.

If the deprecated load_balancing_policy field is used, note that if the resolver returns at least one balancer address (as opposed to backend addresses), gRPC will use grpclb (see https://github.com/grpc/grpc/blob/master/doc/load-balancing.md), regardless of what policy is configured here. However, if the resolver returns at least one backend address in addition to the balancer address(es), the client may fall back to the requested policy if it is unable to reach any of the grpclb load balancers. 

const (
	ServiceConfig_UNSPECIFIED ServiceConfig_LoadBalancingPolicy = 0
	ServiceConfig_ROUND_ROBIN ServiceConfig_LoadBalancingPolicy = 1
)

func (ServiceConfig_LoadBalancingPolicy) EnumDescriptor 

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

func (ServiceConfig_LoadBalancingPolicy) String 

func (x ServiceConfig_LoadBalancingPolicy) String() string

type ServiceConfig_RetryThrottlingPolicy 

type ServiceConfig_RetryThrottlingPolicy struct {
	// The number of tokens starts at max_tokens. The token_count will always be
	// between 0 and max_tokens.
	//
	// This field is required and must be greater than zero.
	MaxTokens uint32 `protobuf:"varint,1,opt,name=max_tokens,json=maxTokens,proto3" json:"max_tokens,omitempty"`
	// The amount of tokens to add on each successful RPC. Typically this will
	// be some number between 0 and 1, e.g., 0.1.
	//
	// This field is required and must be greater than zero. Up to 3 decimal
	// places are supported.
	TokenRatio           float32  `protobuf:"fixed32,2,opt,name=token_ratio,json=tokenRatio,proto3" json:"token_ratio,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

If a RetryThrottlingPolicy is provided, gRPC will automatically throttle retry attempts and hedged RPCs when the client's ratio of failures to successes exceeds a threshold.

For each server name, the gRPC client will maintain a token_count which is initially set to max_tokens. Every outgoing RPC (regardless of service or method invoked) will change token_count as follows:

  • Every failed RPC will decrement the token_count by 1.
  • Every successful RPC will increment the token_count by token_ratio.

If token_count is less than or equal to max_tokens / 2, then RPCs will not be retried and hedged RPCs will not be sent.

func (*ServiceConfig_RetryThrottlingPolicy) Descriptor 

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

func (*ServiceConfig_RetryThrottlingPolicy) GetMaxTokens 

func (m *ServiceConfig_RetryThrottlingPolicy) GetMaxTokens() uint32

func (*ServiceConfig_RetryThrottlingPolicy) GetTokenRatio 

func (m *ServiceConfig_RetryThrottlingPolicy) GetTokenRatio() float32

func (*ServiceConfig_RetryThrottlingPolicy) ProtoMessage 

func (*ServiceConfig_RetryThrottlingPolicy) ProtoMessage()

func (*ServiceConfig_RetryThrottlingPolicy) Reset 

func (m *ServiceConfig_RetryThrottlingPolicy) Reset()

func (*ServiceConfig_RetryThrottlingPolicy) String 

func (m *ServiceConfig_RetryThrottlingPolicy) String() string

func (*ServiceConfig_RetryThrottlingPolicy) XXX_DiscardUnknown 

func (m *ServiceConfig_RetryThrottlingPolicy) XXX_DiscardUnknown()

func (*ServiceConfig_RetryThrottlingPolicy) XXX_Marshal 

func (m *ServiceConfig_RetryThrottlingPolicy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServiceConfig_RetryThrottlingPolicy) XXX_Merge 

func (m *ServiceConfig_RetryThrottlingPolicy) XXX_Merge(src proto.Message)

func (*ServiceConfig_RetryThrottlingPolicy) XXX_Size 

func (m *ServiceConfig_RetryThrottlingPolicy) XXX_Size() int

func (*ServiceConfig_RetryThrottlingPolicy) XXX_Unmarshal 

func (m *ServiceConfig_RetryThrottlingPolicy) XXX_Unmarshal(b []byte) error

type XdsConfig 

type XdsConfig struct {
	// Name of balancer to connect to.
	BalancerName string `protobuf:"bytes,1,opt,name=balancer_name,json=balancerName,proto3" json:"balancer_name,omitempty"` // Deprecated: Do not use.
	// Optional.  What LB policy to use for intra-locality routing.
	// If unset, will use whatever algorithm is specified by the balancer.
	// Multiple LB policies can be specified; clients will iterate through
	// the list in order and stop at the first policy that they support.
	ChildPolicy []*LoadBalancingConfig `protobuf:"bytes,2,rep,name=child_policy,json=childPolicy,proto3" json:"child_policy,omitempty"`
	// Optional.  What LB policy to use in fallback mode.  If not
	// specified, defaults to round_robin.
	// Multiple LB policies can be specified; clients will iterate through
	// the list in order and stop at the first policy that they support.
	FallbackPolicy []*LoadBalancingConfig `protobuf:"bytes,3,rep,name=fallback_policy,json=fallbackPolicy,proto3" json:"fallback_policy,omitempty"`
	// Optional.  Name to use in EDS query.  If not present, defaults to
	// the server name from the target URI.
	EdsServiceName string `protobuf:"bytes,4,opt,name=eds_service_name,json=edsServiceName,proto3" json:"eds_service_name,omitempty"`
	// LRS server to send load reports to.
	// If not present, load reporting will be disabled.
	// If set to the empty string, load reporting will be sent to the same
	// server that we obtained CDS data from.
	LrsLoadReportingServerName *wrappers.StringValue `` /* 145-byte string literal not displayed */
	XXX_NoUnkeyedLiteral       struct{}              `json:"-"`
	XXX_unrecognized           []byte                `json:"-"`
	XXX_sizecache              int32                 `json:"-"`
}

Configuration for xds LB policy.

func (*XdsConfig) Descriptor 

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

func (*XdsConfig) GetBalancerName deprecated 

func (m *XdsConfig) GetBalancerName() string

Deprecated: Do not use.

func (*XdsConfig) GetChildPolicy 

func (m *XdsConfig) GetChildPolicy() []*LoadBalancingConfig

func (*XdsConfig) GetEdsServiceName 

func (m *XdsConfig) GetEdsServiceName() string

func (*XdsConfig) GetFallbackPolicy 

func (m *XdsConfig) GetFallbackPolicy() []*LoadBalancingConfig

func (*XdsConfig) GetLrsLoadReportingServerName 

func (m *XdsConfig) GetLrsLoadReportingServerName() *wrappers.StringValue

func (*XdsConfig) ProtoMessage 

func (*XdsConfig) ProtoMessage()

func (*XdsConfig) Reset 

func (m *XdsConfig) Reset()

func (*XdsConfig) String 

func (m *XdsConfig) String() string

func (*XdsConfig) XXX_DiscardUnknown 

func (m *XdsConfig) XXX_DiscardUnknown()

func (*XdsConfig) XXX_Marshal 

func (m *XdsConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*XdsConfig) XXX_Merge 

func (m *XdsConfig) XXX_Merge(src proto.Message)

func (*XdsConfig) XXX_Size 

func (m *XdsConfig) XXX_Size() int

func (*XdsConfig) XXX_Unmarshal 

func (m *XdsConfig) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.