Documentation ¶
Index ¶
- Variables
- func RegisterRouteLookupServiceServer(s *grpc.Server, srv RouteLookupServiceServer)
- type GrpcKeyBuilder
- func (*GrpcKeyBuilder) Descriptor() ([]byte, []int)
- func (m *GrpcKeyBuilder) GetHeaders() []*NameMatcher
- func (m *GrpcKeyBuilder) GetNames() []*GrpcKeyBuilder_Name
- func (*GrpcKeyBuilder) ProtoMessage()
- func (m *GrpcKeyBuilder) Reset()
- func (m *GrpcKeyBuilder) String() string
- func (m *GrpcKeyBuilder) XXX_DiscardUnknown()
- func (m *GrpcKeyBuilder) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *GrpcKeyBuilder) XXX_Merge(src proto.Message)
- func (m *GrpcKeyBuilder) XXX_Size() int
- func (m *GrpcKeyBuilder) XXX_Unmarshal(b []byte) error
- type GrpcKeyBuilder_Name
- func (*GrpcKeyBuilder_Name) Descriptor() ([]byte, []int)
- func (m *GrpcKeyBuilder_Name) GetMethod() string
- func (m *GrpcKeyBuilder_Name) GetService() string
- func (*GrpcKeyBuilder_Name) ProtoMessage()
- func (m *GrpcKeyBuilder_Name) Reset()
- func (m *GrpcKeyBuilder_Name) String() string
- func (m *GrpcKeyBuilder_Name) XXX_DiscardUnknown()
- func (m *GrpcKeyBuilder_Name) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *GrpcKeyBuilder_Name) XXX_Merge(src proto.Message)
- func (m *GrpcKeyBuilder_Name) XXX_Size() int
- func (m *GrpcKeyBuilder_Name) XXX_Unmarshal(b []byte) error
- type HttpKeyBuilder
- func (*HttpKeyBuilder) Descriptor() ([]byte, []int)
- func (m *HttpKeyBuilder) GetHeaders() []*NameMatcher
- func (m *HttpKeyBuilder) GetHostPatterns() []string
- func (m *HttpKeyBuilder) GetPathPatterns() []string
- func (m *HttpKeyBuilder) GetQueryParameters() []*NameMatcher
- func (*HttpKeyBuilder) ProtoMessage()
- func (m *HttpKeyBuilder) Reset()
- func (m *HttpKeyBuilder) String() string
- func (m *HttpKeyBuilder) XXX_DiscardUnknown()
- func (m *HttpKeyBuilder) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *HttpKeyBuilder) XXX_Merge(src proto.Message)
- func (m *HttpKeyBuilder) XXX_Size() int
- func (m *HttpKeyBuilder) XXX_Unmarshal(b []byte) error
- type NameMatcher
- func (*NameMatcher) Descriptor() ([]byte, []int)
- func (m *NameMatcher) GetKey() string
- func (m *NameMatcher) GetNames() []string
- func (m *NameMatcher) GetRequiredMatch() bool
- func (*NameMatcher) ProtoMessage()
- func (m *NameMatcher) Reset()
- func (m *NameMatcher) String() string
- func (m *NameMatcher) XXX_DiscardUnknown()
- func (m *NameMatcher) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *NameMatcher) XXX_Merge(src proto.Message)
- func (m *NameMatcher) XXX_Size() int
- func (m *NameMatcher) XXX_Unmarshal(b []byte) error
- type RouteLookupConfig
- func (*RouteLookupConfig) Descriptor() ([]byte, []int)
- func (m *RouteLookupConfig) GetCacheSizeBytes() int64
- func (m *RouteLookupConfig) GetDefaultTarget() string
- func (m *RouteLookupConfig) GetGrpcKeybuilders() []*GrpcKeyBuilder
- func (m *RouteLookupConfig) GetHttpKeybuilders() []*HttpKeyBuilder
- func (m *RouteLookupConfig) GetLookupService() string
- func (m *RouteLookupConfig) GetLookupServiceTimeout() *duration.Duration
- func (m *RouteLookupConfig) GetMaxAge() *duration.Duration
- func (m *RouteLookupConfig) GetRequestProcessingStrategy() RouteLookupConfig_RequestProcessingStrategy
- func (m *RouteLookupConfig) GetStaleAge() *duration.Duration
- func (m *RouteLookupConfig) GetValidTargets() []string
- func (*RouteLookupConfig) ProtoMessage()
- func (m *RouteLookupConfig) Reset()
- func (m *RouteLookupConfig) String() string
- func (m *RouteLookupConfig) XXX_DiscardUnknown()
- func (m *RouteLookupConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RouteLookupConfig) XXX_Merge(src proto.Message)
- func (m *RouteLookupConfig) XXX_Size() int
- func (m *RouteLookupConfig) XXX_Unmarshal(b []byte) error
- type RouteLookupConfig_RequestProcessingStrategy
- type RouteLookupRequest
- func (*RouteLookupRequest) Descriptor() ([]byte, []int)
- func (m *RouteLookupRequest) GetKeyMap() map[string]string
- func (m *RouteLookupRequest) GetPath() string
- func (m *RouteLookupRequest) GetServer() string
- func (m *RouteLookupRequest) GetTargetType() string
- func (*RouteLookupRequest) ProtoMessage()
- func (m *RouteLookupRequest) Reset()
- func (m *RouteLookupRequest) String() string
- func (m *RouteLookupRequest) XXX_DiscardUnknown()
- func (m *RouteLookupRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RouteLookupRequest) XXX_Merge(src proto.Message)
- func (m *RouteLookupRequest) XXX_Size() int
- func (m *RouteLookupRequest) XXX_Unmarshal(b []byte) error
- type RouteLookupResponse
- func (*RouteLookupResponse) Descriptor() ([]byte, []int)
- func (m *RouteLookupResponse) GetHeaderData() string
- func (m *RouteLookupResponse) GetTargets() []string
- func (*RouteLookupResponse) ProtoMessage()
- func (m *RouteLookupResponse) Reset()
- func (m *RouteLookupResponse) String() string
- func (m *RouteLookupResponse) XXX_DiscardUnknown()
- func (m *RouteLookupResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RouteLookupResponse) XXX_Merge(src proto.Message)
- func (m *RouteLookupResponse) XXX_Size() int
- func (m *RouteLookupResponse) XXX_Unmarshal(b []byte) error
- type RouteLookupServiceClient
- type RouteLookupServiceServer
- type UnimplementedRouteLookupServiceServer
Constants ¶
This section is empty.
Variables ¶
var RouteLookupConfig_RequestProcessingStrategy_name = map[int32]string{
0: "STRATEGY_UNSPECIFIED",
1: "SYNC_LOOKUP_DEFAULT_TARGET_ON_ERROR",
2: "SYNC_LOOKUP_CLIENT_SEES_ERROR",
3: "ASYNC_LOOKUP_DEFAULT_TARGET_ON_MISS",
}
var RouteLookupConfig_RequestProcessingStrategy_value = map[string]int32{
"STRATEGY_UNSPECIFIED": 0,
"SYNC_LOOKUP_DEFAULT_TARGET_ON_ERROR": 1,
"SYNC_LOOKUP_CLIENT_SEES_ERROR": 2,
"ASYNC_LOOKUP_DEFAULT_TARGET_ON_MISS": 3,
}
Functions ¶
func RegisterRouteLookupServiceServer ¶
func RegisterRouteLookupServiceServer(s *grpc.Server, srv RouteLookupServiceServer)
Types ¶
type GrpcKeyBuilder ¶
type GrpcKeyBuilder struct { Names []*GrpcKeyBuilder_Name `protobuf:"bytes,1,rep,name=names,proto3" json:"names,omitempty"` // Extract keys from all listed headers. // For gRPC, it is an error to specify "required_match" on the NameMatcher // protos. Headers []*NameMatcher `protobuf:"bytes,2,rep,name=headers,proto3" json:"headers,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
A GrpcKeyBuilder applies to a given gRPC service, name, and headers.
func (*GrpcKeyBuilder) Descriptor ¶
func (*GrpcKeyBuilder) Descriptor() ([]byte, []int)
func (*GrpcKeyBuilder) GetHeaders ¶
func (m *GrpcKeyBuilder) GetHeaders() []*NameMatcher
func (*GrpcKeyBuilder) GetNames ¶
func (m *GrpcKeyBuilder) GetNames() []*GrpcKeyBuilder_Name
func (*GrpcKeyBuilder) ProtoMessage ¶
func (*GrpcKeyBuilder) ProtoMessage()
func (*GrpcKeyBuilder) Reset ¶
func (m *GrpcKeyBuilder) Reset()
func (*GrpcKeyBuilder) String ¶
func (m *GrpcKeyBuilder) String() string
func (*GrpcKeyBuilder) XXX_DiscardUnknown ¶
func (m *GrpcKeyBuilder) XXX_DiscardUnknown()
func (*GrpcKeyBuilder) XXX_Marshal ¶
func (m *GrpcKeyBuilder) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*GrpcKeyBuilder) XXX_Merge ¶
func (m *GrpcKeyBuilder) XXX_Merge(src proto.Message)
func (*GrpcKeyBuilder) XXX_Size ¶
func (m *GrpcKeyBuilder) XXX_Size() int
func (*GrpcKeyBuilder) XXX_Unmarshal ¶
func (m *GrpcKeyBuilder) XXX_Unmarshal(b []byte) error
type GrpcKeyBuilder_Name ¶
type GrpcKeyBuilder_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:"-"` }
To match, one of the given Name fields must match; the service and method fields are specified as fixed strings. The service name is required and includes the proto package name. The method name may be omitted, in which case any method on the given service is matched.
func (*GrpcKeyBuilder_Name) Descriptor ¶
func (*GrpcKeyBuilder_Name) Descriptor() ([]byte, []int)
func (*GrpcKeyBuilder_Name) GetMethod ¶
func (m *GrpcKeyBuilder_Name) GetMethod() string
func (*GrpcKeyBuilder_Name) GetService ¶
func (m *GrpcKeyBuilder_Name) GetService() string
func (*GrpcKeyBuilder_Name) ProtoMessage ¶
func (*GrpcKeyBuilder_Name) ProtoMessage()
func (*GrpcKeyBuilder_Name) Reset ¶
func (m *GrpcKeyBuilder_Name) Reset()
func (*GrpcKeyBuilder_Name) String ¶
func (m *GrpcKeyBuilder_Name) String() string
func (*GrpcKeyBuilder_Name) XXX_DiscardUnknown ¶
func (m *GrpcKeyBuilder_Name) XXX_DiscardUnknown()
func (*GrpcKeyBuilder_Name) XXX_Marshal ¶
func (m *GrpcKeyBuilder_Name) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*GrpcKeyBuilder_Name) XXX_Merge ¶
func (m *GrpcKeyBuilder_Name) XXX_Merge(src proto.Message)
func (*GrpcKeyBuilder_Name) XXX_Size ¶
func (m *GrpcKeyBuilder_Name) XXX_Size() int
func (*GrpcKeyBuilder_Name) XXX_Unmarshal ¶
func (m *GrpcKeyBuilder_Name) XXX_Unmarshal(b []byte) error
type HttpKeyBuilder ¶
type HttpKeyBuilder struct { // host_pattern is an ordered list of host template patterns for the desired // value. If any host_pattern values are specified, then at least one must // match, and the last one wins and sets any specified variables. A host // consists of labels separated by dots. Each label is matched against the // label in the pattern as follows: // - "*": Matches any single label. // - "**": Matches zero or more labels (first or last part of host only). // - "{<name>=...}": One or more label capture, where "..." can be any // template that does not include a capture. // - "{<name>}": A single label capture. Identical to {<name>=*}. // // Examples: // - "example.com": Only applies to the exact host example.com. // - "*.example.com": Matches subdomains of example.com. // - "**.example.com": matches example.com, and all levels of subdomains. // - "{project}.example.com": Extracts the third level subdomain. // - "{project=**}.example.com": Extracts the third level+ subdomains. // - "{project=**}": Extracts the entire host. HostPatterns []string `protobuf:"bytes,1,rep,name=host_patterns,json=hostPatterns,proto3" json:"host_patterns,omitempty"` // path_pattern is an ordered list of path template patterns for the desired // value. If any path_pattern values are specified, then at least one must // match, and the last one wins and sets any specified variables. A path // consists of segments separated by slashes. Each segment is matched against // the segment in the pattern as follows: // - "*": Matches any single segment. // - "**": Matches zero or more segments (first or last part of path only). // - "{<name>=...}": One or more segment capture, where "..." can be any // template that does not include a capture. // - "{<name>}": A single segment capture. Identical to {<name>=*}. // A custom method may also be specified by appending ":" and the custom // method name or "*" to indicate any custom method (including no custom // method). For example, "/*/projects/{project_id}/**:*" extracts // `{project_id}` for any version, resource and custom method that includes // it. By default, any custom method will be matched. // // Examples: // - "/v1/{name=messages/*}": extracts a name like "messages/12345". // - "/v1/messages/{message_id}": extracts a message_id like "12345". // - "/v1/users/{user_id}/messages/{message_id}": extracts two key values. PathPatterns []string `protobuf:"bytes,2,rep,name=path_patterns,json=pathPatterns,proto3" json:"path_patterns,omitempty"` // List of query parameter names to try to match. // For example: ["parent", "name", "resource.name"] // We extract all the specified query_parameters (case-sensitively). If any // are marked as "required_match" and are not present, this keybuilder fails // to match. If a given parameter appears multiple times (?foo=a&foo=b) we // will report it as a comma-separated string (foo=a,b). QueryParameters []*NameMatcher `protobuf:"bytes,3,rep,name=query_parameters,json=queryParameters,proto3" json:"query_parameters,omitempty"` // List of headers to try to match. // We extract all the specified header values (case-insensitively). If any // are marked as "required_match" and are not present, this keybuilder fails // to match. If a given header appears multiple times in the request we will // report it as a comma-separated string, in standard HTTP fashion. Headers []*NameMatcher `protobuf:"bytes,4,rep,name=headers,proto3" json:"headers,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
An HttpKeyBuilder applies to a given HTTP URL and headers.
Path and host patterns use the matching syntax from gRPC transcoding to extract named key/value pairs from the path and host components of the URL: https://github.com/googleapis/googleapis/blob/master/google/api/http.proto
It is invalid to specify the same key name in multiple places in a pattern.
For a service where the project id can be expressed either as a subdomain or in the path, separate HttpKeyBuilders must be used:
host_pattern: 'example.com' path_pattern: '/{id}/{object}/**' host_pattern: '{id}.example.com' path_pattern: '/{object}/**'
If the host is exactly 'example.com', the first path segment will be used as the id and the second segment as the object. If the host has a subdomain, the subdomain will be used as the id and the first segment as the object. If neither pattern matches, no keys will be extracted.
func (*HttpKeyBuilder) Descriptor ¶
func (*HttpKeyBuilder) Descriptor() ([]byte, []int)
func (*HttpKeyBuilder) GetHeaders ¶
func (m *HttpKeyBuilder) GetHeaders() []*NameMatcher
func (*HttpKeyBuilder) GetHostPatterns ¶
func (m *HttpKeyBuilder) GetHostPatterns() []string
func (*HttpKeyBuilder) GetPathPatterns ¶
func (m *HttpKeyBuilder) GetPathPatterns() []string
func (*HttpKeyBuilder) GetQueryParameters ¶
func (m *HttpKeyBuilder) GetQueryParameters() []*NameMatcher
func (*HttpKeyBuilder) ProtoMessage ¶
func (*HttpKeyBuilder) ProtoMessage()
func (*HttpKeyBuilder) Reset ¶
func (m *HttpKeyBuilder) Reset()
func (*HttpKeyBuilder) String ¶
func (m *HttpKeyBuilder) String() string
func (*HttpKeyBuilder) XXX_DiscardUnknown ¶
func (m *HttpKeyBuilder) XXX_DiscardUnknown()
func (*HttpKeyBuilder) XXX_Marshal ¶
func (m *HttpKeyBuilder) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*HttpKeyBuilder) XXX_Merge ¶
func (m *HttpKeyBuilder) XXX_Merge(src proto.Message)
func (*HttpKeyBuilder) XXX_Size ¶
func (m *HttpKeyBuilder) XXX_Size() int
func (*HttpKeyBuilder) XXX_Unmarshal ¶
func (m *HttpKeyBuilder) XXX_Unmarshal(b []byte) error
type NameMatcher ¶
type NameMatcher struct { // The name that will be used in the RLS key_map to refer to this value. Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // Ordered list of names (headers or query parameter names) that can supply // this value; the first one with a non-empty value is used. Names []string `protobuf:"bytes,2,rep,name=names,proto3" json:"names,omitempty"` // If true, make this extraction required; the key builder will not match // if no value is found. RequiredMatch bool `protobuf:"varint,3,opt,name=required_match,json=requiredMatch,proto3" json:"required_match,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Extract a key based on a given name (e.g. header name or query parameter name). The name must match one of the names listed in the "name" field. If the "required_match" field is true, one of the specified names must be present for the keybuilder to match.
func (*NameMatcher) Descriptor ¶
func (*NameMatcher) Descriptor() ([]byte, []int)
func (*NameMatcher) GetKey ¶
func (m *NameMatcher) GetKey() string
func (*NameMatcher) GetNames ¶
func (m *NameMatcher) GetNames() []string
func (*NameMatcher) GetRequiredMatch ¶
func (m *NameMatcher) GetRequiredMatch() bool
func (*NameMatcher) ProtoMessage ¶
func (*NameMatcher) ProtoMessage()
func (*NameMatcher) Reset ¶
func (m *NameMatcher) Reset()
func (*NameMatcher) String ¶
func (m *NameMatcher) String() string
func (*NameMatcher) XXX_DiscardUnknown ¶
func (m *NameMatcher) XXX_DiscardUnknown()
func (*NameMatcher) XXX_Marshal ¶
func (m *NameMatcher) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*NameMatcher) XXX_Merge ¶
func (m *NameMatcher) XXX_Merge(src proto.Message)
func (*NameMatcher) XXX_Size ¶
func (m *NameMatcher) XXX_Size() int
func (*NameMatcher) XXX_Unmarshal ¶
func (m *NameMatcher) XXX_Unmarshal(b []byte) error
type RouteLookupConfig ¶
type RouteLookupConfig struct { // Ordered specifications for constructing keys for HTTP requests. Last // match wins. If no HttpKeyBuilder matches, an empty key_map will be sent to // the lookup service; it should likely reply with a global default route // and raise an alert. HttpKeybuilders []*HttpKeyBuilder `protobuf:"bytes,1,rep,name=http_keybuilders,json=httpKeybuilders,proto3" json:"http_keybuilders,omitempty"` // Unordered specifications for constructing keys for gRPC requests. All // GrpcKeyBuilders on this list must have unique "name" fields so that the // client is free to prebuild a hash map keyed by name. If no GrpcKeyBuilder // matches, an empty key_map will be sent to the lookup service; it should // likely reply with a global default route and raise an alert. GrpcKeybuilders []*GrpcKeyBuilder `protobuf:"bytes,2,rep,name=grpc_keybuilders,json=grpcKeybuilders,proto3" json:"grpc_keybuilders,omitempty"` // The name of the lookup service as a gRPC URI. Typically, this will be // a subdomain of the target, such as "lookup.datastore.googleapis.com". LookupService string `protobuf:"bytes,3,opt,name=lookup_service,json=lookupService,proto3" json:"lookup_service,omitempty"` // Configure a timeout value for lookup service requests. // Defaults to 10 seconds if not specified. LookupServiceTimeout *duration.Duration `protobuf:"bytes,4,opt,name=lookup_service_timeout,json=lookupServiceTimeout,proto3" json:"lookup_service_timeout,omitempty"` // How long are responses valid for (like HTTP Cache-Control). // If omitted or zero, the longest valid cache time is used. // This value is clamped to 5 minutes to avoid unflushable bad responses. MaxAge *duration.Duration `protobuf:"bytes,5,opt,name=max_age,json=maxAge,proto3" json:"max_age,omitempty"` // After a response has been in the client cache for this amount of time // and is re-requested, start an asynchronous RPC to re-validate it. // This value should be less than max_age by at least the length of a // typical RTT to the Route Lookup Service to fully mask the RTT latency. // If omitted, keys are only re-requested after they have expired. StaleAge *duration.Duration `protobuf:"bytes,6,opt,name=stale_age,json=staleAge,proto3" json:"stale_age,omitempty"` // Rough indicator of amount of memory to use for the client cache. Some of // the data structure overhead is not accounted for, so actual memory consumed // will be somewhat greater than this value. If this field is omitted or set // to zero, a client default will be used. The value may be capped to a lower // amount based on client configuration. CacheSizeBytes int64 `protobuf:"varint,7,opt,name=cache_size_bytes,json=cacheSizeBytes,proto3" json:"cache_size_bytes,omitempty"` // This is a list of all the possible targets that can be returned by the // lookup service. If a target not on this list is returned, it will be // treated the same as an RPC error from the RLS. ValidTargets []string `protobuf:"bytes,8,rep,name=valid_targets,json=validTargets,proto3" json:"valid_targets,omitempty"` // This value provides a default target to use if needed. It will be used for // request processing strategy SYNC_LOOKUP_DEFAULT_TARGET_ON_ERROR if RLS // returns an error, or strategy ASYNC_LOOKUP_DEFAULT_TARGET_ON_MISS if RLS // returns an error or there is a cache miss in the client. It will also be // used if there are no healthy backends for an RLS target. Note that // requests can be routed only to a subdomain of the original target, // e.g. "us_east_1.cloudbigtable.googleapis.com". DefaultTarget string `protobuf:"bytes,9,opt,name=default_target,json=defaultTarget,proto3" json:"default_target,omitempty"` RequestProcessingStrategy RouteLookupConfig_RequestProcessingStrategy `` /* 204-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*RouteLookupConfig) Descriptor ¶
func (*RouteLookupConfig) Descriptor() ([]byte, []int)
func (*RouteLookupConfig) GetCacheSizeBytes ¶
func (m *RouteLookupConfig) GetCacheSizeBytes() int64
func (*RouteLookupConfig) GetDefaultTarget ¶
func (m *RouteLookupConfig) GetDefaultTarget() string
func (*RouteLookupConfig) GetGrpcKeybuilders ¶
func (m *RouteLookupConfig) GetGrpcKeybuilders() []*GrpcKeyBuilder
func (*RouteLookupConfig) GetHttpKeybuilders ¶
func (m *RouteLookupConfig) GetHttpKeybuilders() []*HttpKeyBuilder
func (*RouteLookupConfig) GetLookupService ¶
func (m *RouteLookupConfig) GetLookupService() string
func (*RouteLookupConfig) GetLookupServiceTimeout ¶
func (m *RouteLookupConfig) GetLookupServiceTimeout() *duration.Duration
func (*RouteLookupConfig) GetMaxAge ¶
func (m *RouteLookupConfig) GetMaxAge() *duration.Duration
func (*RouteLookupConfig) GetRequestProcessingStrategy ¶
func (m *RouteLookupConfig) GetRequestProcessingStrategy() RouteLookupConfig_RequestProcessingStrategy
func (*RouteLookupConfig) GetStaleAge ¶
func (m *RouteLookupConfig) GetStaleAge() *duration.Duration
func (*RouteLookupConfig) GetValidTargets ¶
func (m *RouteLookupConfig) GetValidTargets() []string
func (*RouteLookupConfig) ProtoMessage ¶
func (*RouteLookupConfig) ProtoMessage()
func (*RouteLookupConfig) Reset ¶
func (m *RouteLookupConfig) Reset()
func (*RouteLookupConfig) String ¶
func (m *RouteLookupConfig) String() string
func (*RouteLookupConfig) XXX_DiscardUnknown ¶
func (m *RouteLookupConfig) XXX_DiscardUnknown()
func (*RouteLookupConfig) XXX_Marshal ¶
func (m *RouteLookupConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RouteLookupConfig) XXX_Merge ¶
func (m *RouteLookupConfig) XXX_Merge(src proto.Message)
func (*RouteLookupConfig) XXX_Size ¶
func (m *RouteLookupConfig) XXX_Size() int
func (*RouteLookupConfig) XXX_Unmarshal ¶
func (m *RouteLookupConfig) XXX_Unmarshal(b []byte) error
type RouteLookupConfig_RequestProcessingStrategy ¶
type RouteLookupConfig_RequestProcessingStrategy int32
Specify how to process a request when not already in the cache.
const ( RouteLookupConfig_STRATEGY_UNSPECIFIED RouteLookupConfig_RequestProcessingStrategy = 0 // Query the RLS and process the request using target returned by the // lookup. The target will then be cached and used for processing // subsequent requests for the same key. Any errors during lookup service // processing will fall back to default target for request processing. RouteLookupConfig_SYNC_LOOKUP_DEFAULT_TARGET_ON_ERROR RouteLookupConfig_RequestProcessingStrategy = 1 // Query the RLS and process the request using target returned by the // lookup. The target will then be cached and used for processing // subsequent requests for the same key. Any errors during lookup service // processing will return an error back to the client. Services with // strict regional routing requirements should use this strategy. RouteLookupConfig_SYNC_LOOKUP_CLIENT_SEES_ERROR RouteLookupConfig_RequestProcessingStrategy = 2 // Query the RLS asynchronously but respond with the default target. The // target in the lookup response will then be cached and used for // subsequent requests. Services with strict latency requirements (but not // strict regional routing requirements) should use this strategy. RouteLookupConfig_ASYNC_LOOKUP_DEFAULT_TARGET_ON_MISS RouteLookupConfig_RequestProcessingStrategy = 3 )
func (RouteLookupConfig_RequestProcessingStrategy) EnumDescriptor ¶
func (RouteLookupConfig_RequestProcessingStrategy) EnumDescriptor() ([]byte, []int)
func (RouteLookupConfig_RequestProcessingStrategy) String ¶
func (x RouteLookupConfig_RequestProcessingStrategy) String() string
type RouteLookupRequest ¶
type RouteLookupRequest struct { // Full host name of the target server, e.g. firestore.googleapis.com. // Only set for gRPC requests; HTTP requests must use key_map explicitly. Server string `protobuf:"bytes,1,opt,name=server,proto3" json:"server,omitempty"` // Full path of the request, i.e. "/service/method". // Only set for gRPC requests; HTTP requests must use key_map explicitly. Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"` // Target type allows the client to specify what kind of target format it // would like from RLS to allow it to find the regional server, e.g. "grpc". TargetType string `protobuf:"bytes,3,opt,name=target_type,json=targetType,proto3" json:"target_type,omitempty"` // Map of key values extracted via key builders for the gRPC or HTTP request. KeyMap map[string]string `` /* 167-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*RouteLookupRequest) Descriptor ¶
func (*RouteLookupRequest) Descriptor() ([]byte, []int)
func (*RouteLookupRequest) GetKeyMap ¶
func (m *RouteLookupRequest) GetKeyMap() map[string]string
func (*RouteLookupRequest) GetPath ¶
func (m *RouteLookupRequest) GetPath() string
func (*RouteLookupRequest) GetServer ¶
func (m *RouteLookupRequest) GetServer() string
func (*RouteLookupRequest) GetTargetType ¶
func (m *RouteLookupRequest) GetTargetType() string
func (*RouteLookupRequest) ProtoMessage ¶
func (*RouteLookupRequest) ProtoMessage()
func (*RouteLookupRequest) Reset ¶
func (m *RouteLookupRequest) Reset()
func (*RouteLookupRequest) String ¶
func (m *RouteLookupRequest) String() string
func (*RouteLookupRequest) XXX_DiscardUnknown ¶
func (m *RouteLookupRequest) XXX_DiscardUnknown()
func (*RouteLookupRequest) XXX_Marshal ¶
func (m *RouteLookupRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RouteLookupRequest) XXX_Merge ¶
func (m *RouteLookupRequest) XXX_Merge(src proto.Message)
func (*RouteLookupRequest) XXX_Size ¶
func (m *RouteLookupRequest) XXX_Size() int
func (*RouteLookupRequest) XXX_Unmarshal ¶
func (m *RouteLookupRequest) XXX_Unmarshal(b []byte) error
type RouteLookupResponse ¶
type RouteLookupResponse struct { // Prioritized list (best one first) of addressable entities to use // for routing, using syntax requested by the request target_type. // The targets will be tried in order until a healthy one is found. Targets []string `protobuf:"bytes,3,rep,name=targets,proto3" json:"targets,omitempty"` // Optional header value to pass along to AFE in the X-Google-RLS-Data header. // Cached with "target" and sent with all requests that match the request key. // Allows the RLS to pass its work product to the eventual target. HeaderData string `protobuf:"bytes,2,opt,name=header_data,json=headerData,proto3" json:"header_data,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*RouteLookupResponse) Descriptor ¶
func (*RouteLookupResponse) Descriptor() ([]byte, []int)
func (*RouteLookupResponse) GetHeaderData ¶
func (m *RouteLookupResponse) GetHeaderData() string
func (*RouteLookupResponse) GetTargets ¶
func (m *RouteLookupResponse) GetTargets() []string
func (*RouteLookupResponse) ProtoMessage ¶
func (*RouteLookupResponse) ProtoMessage()
func (*RouteLookupResponse) Reset ¶
func (m *RouteLookupResponse) Reset()
func (*RouteLookupResponse) String ¶
func (m *RouteLookupResponse) String() string
func (*RouteLookupResponse) XXX_DiscardUnknown ¶
func (m *RouteLookupResponse) XXX_DiscardUnknown()
func (*RouteLookupResponse) XXX_Marshal ¶
func (m *RouteLookupResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RouteLookupResponse) XXX_Merge ¶
func (m *RouteLookupResponse) XXX_Merge(src proto.Message)
func (*RouteLookupResponse) XXX_Size ¶
func (m *RouteLookupResponse) XXX_Size() int
func (*RouteLookupResponse) XXX_Unmarshal ¶
func (m *RouteLookupResponse) XXX_Unmarshal(b []byte) error
type RouteLookupServiceClient ¶
type RouteLookupServiceClient interface { // Lookup returns a target for a single key. RouteLookup(ctx context.Context, in *RouteLookupRequest, opts ...grpc.CallOption) (*RouteLookupResponse, error) }
RouteLookupServiceClient is the client API for RouteLookupService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewRouteLookupServiceClient ¶
func NewRouteLookupServiceClient(cc grpc.ClientConnInterface) RouteLookupServiceClient
type RouteLookupServiceServer ¶
type RouteLookupServiceServer interface { // Lookup returns a target for a single key. RouteLookup(context.Context, *RouteLookupRequest) (*RouteLookupResponse, error) }
RouteLookupServiceServer is the server API for RouteLookupService service. All implementations should embed UnimplementedRouteLookupServiceServer for forward compatibility
type UnimplementedRouteLookupServiceServer ¶
type UnimplementedRouteLookupServiceServer struct { }
UnimplementedRouteLookupServiceServer should be embedded to have forward compatible implementations.
func (*UnimplementedRouteLookupServiceServer) RouteLookup ¶
func (*UnimplementedRouteLookupServiceServer) RouteLookup(context.Context, *RouteLookupRequest) (*RouteLookupResponse, error)