Package io.grpc.lookup.v1
Interface RouteLookupConfigOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
RouteLookupConfig
,RouteLookupConfig.Builder
public interface RouteLookupConfigOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
getCacheSizeBytes()
Rough indicator of amount of memory to use for the client cache.java.lang.String
getDefaultTarget()
This value provides a default target to use if needed.com.google.protobuf.ByteString
getDefaultTargetBytes()
This value provides a default target to use if needed.GrpcKeyBuilder
getGrpcKeybuilders(int index)
Unordered specifications for constructing keys for gRPC requests.int
getGrpcKeybuildersCount()
Unordered specifications for constructing keys for gRPC requests.java.util.List<GrpcKeyBuilder>
getGrpcKeybuildersList()
Unordered specifications for constructing keys for gRPC requests.GrpcKeyBuilderOrBuilder
getGrpcKeybuildersOrBuilder(int index)
Unordered specifications for constructing keys for gRPC requests.java.util.List<? extends GrpcKeyBuilderOrBuilder>
getGrpcKeybuildersOrBuilderList()
Unordered specifications for constructing keys for gRPC requests.HttpKeyBuilder
getHttpKeybuilders(int index)
Ordered specifications for constructing keys for HTTP requests.int
getHttpKeybuildersCount()
Ordered specifications for constructing keys for HTTP requests.java.util.List<HttpKeyBuilder>
getHttpKeybuildersList()
Ordered specifications for constructing keys for HTTP requests.HttpKeyBuilderOrBuilder
getHttpKeybuildersOrBuilder(int index)
Ordered specifications for constructing keys for HTTP requests.java.util.List<? extends HttpKeyBuilderOrBuilder>
getHttpKeybuildersOrBuilderList()
Ordered specifications for constructing keys for HTTP requests.java.lang.String
getLookupService()
The name of the lookup service as a gRPC URI.com.google.protobuf.ByteString
getLookupServiceBytes()
The name of the lookup service as a gRPC URI.com.google.protobuf.Duration
getLookupServiceTimeout()
Configure a timeout value for lookup service requests.com.google.protobuf.DurationOrBuilder
getLookupServiceTimeoutOrBuilder()
Configure a timeout value for lookup service requests.com.google.protobuf.Duration
getMaxAge()
How long are responses valid for (like HTTP Cache-Control).com.google.protobuf.DurationOrBuilder
getMaxAgeOrBuilder()
How long are responses valid for (like HTTP Cache-Control).com.google.protobuf.Duration
getStaleAge()
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.com.google.protobuf.DurationOrBuilder
getStaleAgeOrBuilder()
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.java.lang.String
getValidTargets(int index)
This is a list of all the possible targets that can be returned by the lookup service.com.google.protobuf.ByteString
getValidTargetsBytes(int index)
This is a list of all the possible targets that can be returned by the lookup service.int
getValidTargetsCount()
This is a list of all the possible targets that can be returned by the lookup service.java.util.List<java.lang.String>
getValidTargetsList()
This is a list of all the possible targets that can be returned by the lookup service.boolean
hasLookupServiceTimeout()
Configure a timeout value for lookup service requests.boolean
hasMaxAge()
How long are responses valid for (like HTTP Cache-Control).boolean
hasStaleAge()
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.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getHttpKeybuildersList
java.util.List<HttpKeyBuilder> getHttpKeybuildersList()
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.
repeated .grpc.lookup.v1.HttpKeyBuilder http_keybuilders = 1;
-
getHttpKeybuilders
HttpKeyBuilder getHttpKeybuilders(int index)
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.
repeated .grpc.lookup.v1.HttpKeyBuilder http_keybuilders = 1;
-
getHttpKeybuildersCount
int getHttpKeybuildersCount()
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.
repeated .grpc.lookup.v1.HttpKeyBuilder http_keybuilders = 1;
-
getHttpKeybuildersOrBuilderList
java.util.List<? extends HttpKeyBuilderOrBuilder> getHttpKeybuildersOrBuilderList()
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.
repeated .grpc.lookup.v1.HttpKeyBuilder http_keybuilders = 1;
-
getHttpKeybuildersOrBuilder
HttpKeyBuilderOrBuilder getHttpKeybuildersOrBuilder(int index)
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.
repeated .grpc.lookup.v1.HttpKeyBuilder http_keybuilders = 1;
-
getGrpcKeybuildersList
java.util.List<GrpcKeyBuilder> getGrpcKeybuildersList()
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.
repeated .grpc.lookup.v1.GrpcKeyBuilder grpc_keybuilders = 2;
-
getGrpcKeybuilders
GrpcKeyBuilder getGrpcKeybuilders(int index)
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.
repeated .grpc.lookup.v1.GrpcKeyBuilder grpc_keybuilders = 2;
-
getGrpcKeybuildersCount
int getGrpcKeybuildersCount()
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.
repeated .grpc.lookup.v1.GrpcKeyBuilder grpc_keybuilders = 2;
-
getGrpcKeybuildersOrBuilderList
java.util.List<? extends GrpcKeyBuilderOrBuilder> getGrpcKeybuildersOrBuilderList()
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.
repeated .grpc.lookup.v1.GrpcKeyBuilder grpc_keybuilders = 2;
-
getGrpcKeybuildersOrBuilder
GrpcKeyBuilderOrBuilder getGrpcKeybuildersOrBuilder(int index)
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.
repeated .grpc.lookup.v1.GrpcKeyBuilder grpc_keybuilders = 2;
-
getLookupService
java.lang.String getLookupService()
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".
string lookup_service = 3;
- Returns:
- The lookupService.
-
getLookupServiceBytes
com.google.protobuf.ByteString getLookupServiceBytes()
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".
string lookup_service = 3;
- Returns:
- The bytes for lookupService.
-
hasLookupServiceTimeout
boolean hasLookupServiceTimeout()
Configure a timeout value for lookup service requests. Defaults to 10 seconds if not specified.
.google.protobuf.Duration lookup_service_timeout = 4;
- Returns:
- Whether the lookupServiceTimeout field is set.
-
getLookupServiceTimeout
com.google.protobuf.Duration getLookupServiceTimeout()
Configure a timeout value for lookup service requests. Defaults to 10 seconds if not specified.
.google.protobuf.Duration lookup_service_timeout = 4;
- Returns:
- The lookupServiceTimeout.
-
getLookupServiceTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getLookupServiceTimeoutOrBuilder()
Configure a timeout value for lookup service requests. Defaults to 10 seconds if not specified.
.google.protobuf.Duration lookup_service_timeout = 4;
-
hasMaxAge
boolean hasMaxAge()
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.
.google.protobuf.Duration max_age = 5;
- Returns:
- Whether the maxAge field is set.
-
getMaxAge
com.google.protobuf.Duration getMaxAge()
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.
.google.protobuf.Duration max_age = 5;
- Returns:
- The maxAge.
-
getMaxAgeOrBuilder
com.google.protobuf.DurationOrBuilder getMaxAgeOrBuilder()
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.
.google.protobuf.Duration max_age = 5;
-
hasStaleAge
boolean hasStaleAge()
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.
.google.protobuf.Duration stale_age = 6;
- Returns:
- Whether the staleAge field is set.
-
getStaleAge
com.google.protobuf.Duration getStaleAge()
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.
.google.protobuf.Duration stale_age = 6;
- Returns:
- The staleAge.
-
getStaleAgeOrBuilder
com.google.protobuf.DurationOrBuilder getStaleAgeOrBuilder()
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.
.google.protobuf.Duration stale_age = 6;
-
getCacheSizeBytes
long getCacheSizeBytes()
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.
int64 cache_size_bytes = 7;
- Returns:
- The cacheSizeBytes.
-
getValidTargetsList
java.util.List<java.lang.String> getValidTargetsList()
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 unhealthy target.
repeated string valid_targets = 8;
- Returns:
- A list containing the validTargets.
-
getValidTargetsCount
int getValidTargetsCount()
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 unhealthy target.
repeated string valid_targets = 8;
- Returns:
- The count of validTargets.
-
getValidTargets
java.lang.String getValidTargets(int index)
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 unhealthy target.
repeated string valid_targets = 8;
- Parameters:
index
- The index of the element to return.- Returns:
- The validTargets at the given index.
-
getValidTargetsBytes
com.google.protobuf.ByteString getValidTargetsBytes(int index)
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 unhealthy target.
repeated string valid_targets = 8;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the validTargets at the given index.
-
getDefaultTarget
java.lang.String getDefaultTarget()
This value provides a default target to use if needed. If set, it will be used if RLS returns an error, times out, or returns an invalid response. Note that requests can be routed only to a subdomain of the original target, e.g. "us_east_1.cloudbigtable.googleapis.com".
string default_target = 9;
- Returns:
- The defaultTarget.
-
getDefaultTargetBytes
com.google.protobuf.ByteString getDefaultTargetBytes()
This value provides a default target to use if needed. If set, it will be used if RLS returns an error, times out, or returns an invalid response. Note that requests can be routed only to a subdomain of the original target, e.g. "us_east_1.cloudbigtable.googleapis.com".
string default_target = 9;
- Returns:
- The bytes for defaultTarget.
-
-