Package io.grpc.lookup.v1

Class RouteLookupConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteLookupConfigOrBuilder, java.io.Serializable
    public final class RouteLookupConfig
extends com.google.protobuf.GeneratedMessage
implements RouteLookupConfigOrBuilder
    Protobuf type grpc.lookup.v1.RouteLookupConfig
    See Also:
    Serialized Form

    • Field Detail

      • bitField0_

        private int bitField0_

      • HTTP_KEYBUILDERS_FIELD_NUMBER

        public static final int HTTP_KEYBUILDERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • httpKeybuilders_

        private java.util.List<HttpKeyBuilder> httpKeybuilders_

      • GRPC_KEYBUILDERS_FIELD_NUMBER

        public static final int GRPC_KEYBUILDERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • grpcKeybuilders_

        private java.util.List<GrpcKeyBuilder> grpcKeybuilders_

      • LOOKUP_SERVICE_FIELD_NUMBER

        public static final int LOOKUP_SERVICE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • lookupService_

        private volatile java.lang.Object lookupService_

      • LOOKUP_SERVICE_TIMEOUT_FIELD_NUMBER

        public static final int LOOKUP_SERVICE_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • lookupServiceTimeout_

        private com.google.protobuf.Duration lookupServiceTimeout_

      • maxAge_

        private com.google.protobuf.Duration maxAge_

      • staleAge_

        private com.google.protobuf.Duration staleAge_

      • CACHE_SIZE_BYTES_FIELD_NUMBER

        public static final int CACHE_SIZE_BYTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • cacheSizeBytes_

        private long cacheSizeBytes_

      • VALID_TARGETS_FIELD_NUMBER

        public static final int VALID_TARGETS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • validTargets_

        private com.google.protobuf.LazyStringArrayList validTargets_

      • DEFAULT_TARGET_FIELD_NUMBER

        public static final int DEFAULT_TARGET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • defaultTarget_

        private volatile java.lang.Object defaultTarget_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

    • Constructor Detail

      • RouteLookupConfig

        private RouteLookupConfig​(com.google.protobuf.GeneratedMessage.Builder<?> builder)

      • RouteLookupConfig

        private RouteLookupConfig()

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • getHttpKeybuildersList

        public 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;
        Specified by:
        getHttpKeybuildersList in interface RouteLookupConfigOrBuilder

      • getHttpKeybuildersOrBuilderList

        public 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;
        Specified by:
        getHttpKeybuildersOrBuilderList in interface RouteLookupConfigOrBuilder

      • getHttpKeybuildersCount

        public 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;
        Specified by:
        getHttpKeybuildersCount in interface RouteLookupConfigOrBuilder

      • getHttpKeybuilders

        public 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;
        Specified by:
        getHttpKeybuilders in interface RouteLookupConfigOrBuilder

      • getHttpKeybuildersOrBuilder

        public 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;
        Specified by:
        getHttpKeybuildersOrBuilder in interface RouteLookupConfigOrBuilder

      • getGrpcKeybuildersList

        public 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;
        Specified by:
        getGrpcKeybuildersList in interface RouteLookupConfigOrBuilder

      • getGrpcKeybuildersOrBuilderList

        public 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;
        Specified by:
        getGrpcKeybuildersOrBuilderList in interface RouteLookupConfigOrBuilder

      • getGrpcKeybuildersCount

        public 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;
        Specified by:
        getGrpcKeybuildersCount in interface RouteLookupConfigOrBuilder

      • getGrpcKeybuilders

        public 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;
        Specified by:
        getGrpcKeybuilders in interface RouteLookupConfigOrBuilder

      • getGrpcKeybuildersOrBuilder

        public 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;
        Specified by:
        getGrpcKeybuildersOrBuilder in interface RouteLookupConfigOrBuilder

      • getLookupService

        public 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;
        Specified by:
        getLookupService in interface RouteLookupConfigOrBuilder
        Returns:
        The lookupService.

      • getLookupServiceBytes

        public 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;
        Specified by:
        getLookupServiceBytes in interface RouteLookupConfigOrBuilder
        Returns:
        The bytes for lookupService.

      • hasLookupServiceTimeout

        public boolean hasLookupServiceTimeout()
         Configure a timeout value for lookup service requests.
 Defaults to 10 seconds if not specified.
        .google.protobuf.Duration lookup_service_timeout = 4;
        Specified by:
        hasLookupServiceTimeout in interface RouteLookupConfigOrBuilder
        Returns:
        Whether the lookupServiceTimeout field is set.

      • getLookupServiceTimeout

        public 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;
        Specified by:
        getLookupServiceTimeout in interface RouteLookupConfigOrBuilder
        Returns:
        The lookupServiceTimeout.

      • getLookupServiceTimeoutOrBuilder

        public 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;
        Specified by:
        getLookupServiceTimeoutOrBuilder in interface RouteLookupConfigOrBuilder

      • hasMaxAge

        public 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;
        Specified by:
        hasMaxAge in interface RouteLookupConfigOrBuilder
        Returns:
        Whether the maxAge field is set.

      • getMaxAge

        public 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;
        Specified by:
        getMaxAge in interface RouteLookupConfigOrBuilder
        Returns:
        The maxAge.

      • getMaxAgeOrBuilder

        public 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;
        Specified by:
        getMaxAgeOrBuilder in interface RouteLookupConfigOrBuilder

      • hasStaleAge

        public 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;
        Specified by:
        hasStaleAge in interface RouteLookupConfigOrBuilder
        Returns:
        Whether the staleAge field is set.

      • getStaleAge

        public 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;
        Specified by:
        getStaleAge in interface RouteLookupConfigOrBuilder
        Returns:
        The staleAge.

      • getStaleAgeOrBuilder

        public 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;
        Specified by:
        getStaleAgeOrBuilder in interface RouteLookupConfigOrBuilder

      • getCacheSizeBytes

        public 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;
        Specified by:
        getCacheSizeBytes in interface RouteLookupConfigOrBuilder
        Returns:
        The cacheSizeBytes.

      • getValidTargetsList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getValidTargetsList in interface RouteLookupConfigOrBuilder
        Returns:
        A list containing the validTargets.

      • getValidTargetsCount

        public 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;
        Specified by:
        getValidTargetsCount in interface RouteLookupConfigOrBuilder
        Returns:
        The count of validTargets.

      • getValidTargets

        public 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;
        Specified by:
        getValidTargets in interface RouteLookupConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The validTargets at the given index.

      • getValidTargetsBytes

        public 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;
        Specified by:
        getValidTargetsBytes in interface RouteLookupConfigOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the validTargets at the given index.

      • getDefaultTarget

        public 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;
        Specified by:
        getDefaultTarget in interface RouteLookupConfigOrBuilder
        Returns:
        The defaultTarget.

      • getDefaultTargetBytes

        public 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;
        Specified by:
        getDefaultTargetBytes in interface RouteLookupConfigOrBuilder
        Returns:
        The bytes for defaultTarget.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static RouteLookupConfig parseFrom​(java.nio.ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RouteLookupConfig parseFrom​(java.nio.ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RouteLookupConfig parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RouteLookupConfig parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RouteLookupConfig parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RouteLookupConfig parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RouteLookupConfig parseFrom​(java.io.InputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RouteLookupConfig parseFrom​(java.io.InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static RouteLookupConfig parseDelimitedFrom​(java.io.InputStream input)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static RouteLookupConfig parseDelimitedFrom​(java.io.InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RouteLookupConfig parseFrom​(com.google.protobuf.CodedInputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RouteLookupConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public RouteLookupConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public RouteLookupConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected RouteLookupConfig.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getParserForType

        public com.google.protobuf.Parser<RouteLookupConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage

      • getDefaultInstanceForType

        public RouteLookupConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder