Package io.grpc.lookup.v1

Class NameMatcher

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NameMatcherOrBuilder, java.io.Serializable
    public final class NameMatcher
extends com.google.protobuf.GeneratedMessage
implements NameMatcherOrBuilder
     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.
    Protobuf type grpc.lookup.v1.NameMatcher
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  NameMatcher.Builder
      Extract a key based on a given name (e.g.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private NameMatcher()  
      private NameMatcher​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static NameMatcher getDefaultInstance()  
      NameMatcher getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getKey()
      The name that will be used in the RLS key_map to refer to this value.
      com.google.protobuf.ByteString getKeyBytes()
      The name that will be used in the RLS key_map to refer to this value.
      java.lang.String getNames​(int index)
      Ordered list of names (headers or query parameter names) that can supply this value; the first one with a non-empty value is used.
      com.google.protobuf.ByteString getNamesBytes​(int index)
      Ordered list of names (headers or query parameter names) that can supply this value; the first one with a non-empty value is used.
      int getNamesCount()
      Ordered list of names (headers or query parameter names) that can supply this value; the first one with a non-empty value is used.
      com.google.protobuf.ProtocolStringList getNamesList()
      Ordered list of names (headers or query parameter names) that can supply this value; the first one with a non-empty value is used.
      com.google.protobuf.Parser<NameMatcher> getParserForType()  
      boolean getRequiredMatch()
      If true, make this extraction required; the key builder will not match if no value is found.
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static NameMatcher.Builder newBuilder()  
      static NameMatcher.Builder newBuilder​(NameMatcher prototype)  
      NameMatcher.Builder newBuilderForType()  
      protected NameMatcher.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static NameMatcher parseDelimitedFrom​(java.io.InputStream input)  
      static NameMatcher parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static NameMatcher parseFrom​(byte[] data)  
      static NameMatcher parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static NameMatcher parseFrom​(com.google.protobuf.ByteString data)  
      static NameMatcher parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static NameMatcher parseFrom​(com.google.protobuf.CodedInputStream input)  
      static NameMatcher parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static NameMatcher parseFrom​(java.io.InputStream input)  
      static NameMatcher parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static NameMatcher parseFrom​(java.nio.ByteBuffer data)  
      static NameMatcher parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<NameMatcher> parser()  
      NameMatcher.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Field Detail

      • key_

        private volatile java.lang.Object key_

      • names_

        private com.google.protobuf.LazyStringArrayList names_

      • REQUIRED_MATCH_FIELD_NUMBER

        public static final int REQUIRED_MATCH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • requiredMatch_

        private boolean requiredMatch_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

      • DEFAULT_INSTANCE

        private static final NameMatcher DEFAULT_INSTANCE

      • PARSER

        private static final com.google.protobuf.Parser<NameMatcher> PARSER

    • Constructor Detail

      • NameMatcher

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

      • NameMatcher

        private NameMatcher()

    • 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

      • getKey

        public java.lang.String getKey()
         The name that will be used in the RLS key_map to refer to this value.
 If required_match is true, you may omit this field or set it to an empty
 string, in which case the matcher will require a match, but won't update
 the key_map.
        string key = 1;
        Specified by:
        getKey in interface NameMatcherOrBuilder
        Returns:
        The key.

      • getKeyBytes

        public com.google.protobuf.ByteString getKeyBytes()
         The name that will be used in the RLS key_map to refer to this value.
 If required_match is true, you may omit this field or set it to an empty
 string, in which case the matcher will require a match, but won't update
 the key_map.
        string key = 1;
        Specified by:
        getKeyBytes in interface NameMatcherOrBuilder
        Returns:
        The bytes for key.

      • getNamesList

        public com.google.protobuf.ProtocolStringList getNamesList()
         Ordered list of names (headers or query parameter names) that can supply
 this value; the first one with a non-empty value is used.
        repeated string names = 2;
        Specified by:
        getNamesList in interface NameMatcherOrBuilder
        Returns:
        A list containing the names.

      • getNamesCount

        public int getNamesCount()
         Ordered list of names (headers or query parameter names) that can supply
 this value; the first one with a non-empty value is used.
        repeated string names = 2;
        Specified by:
        getNamesCount in interface NameMatcherOrBuilder
        Returns:
        The count of names.

      • getNames

        public java.lang.String getNames​(int index)
         Ordered list of names (headers or query parameter names) that can supply
 this value; the first one with a non-empty value is used.
        repeated string names = 2;
        Specified by:
        getNames in interface NameMatcherOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The names at the given index.

      • getNamesBytes

        public com.google.protobuf.ByteString getNamesBytes​(int index)
         Ordered list of names (headers or query parameter names) that can supply
 this value; the first one with a non-empty value is used.
        repeated string names = 2;
        Specified by:
        getNamesBytes in interface NameMatcherOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the names at the given index.

      • getRequiredMatch

        public boolean getRequiredMatch()
         If true, make this extraction required; the key builder will not match
 if no value is found.
        bool required_match = 3;
        Specified by:
        getRequiredMatch in interface NameMatcherOrBuilder
        Returns:
        The requiredMatch.

      • 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 NameMatcher parseFrom​(java.nio.ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static NameMatcher getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<NameMatcher> parser()

      • getParserForType

        public com.google.protobuf.Parser<NameMatcher> 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 NameMatcher getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder