Class NameMatcher

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.grpc.lookup.v1.NameMatcher
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NameMatcherOrBuilder, Serializable
@Generated 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final NameMatcher
    DEFAULT_INSTANCE
     
    private Object
    key_
     
    static final int
    KEY_FIELD_NUMBER
     
    private byte
    memoizedIsInitialized
     
    private com.google.protobuf.LazyStringArrayList
    names_
     
    static final int
    NAMES_FIELD_NUMBER
     
    private static final com.google.protobuf.Parser<NameMatcher>
    PARSER
     
    static final int
    REQUIRED_MATCH_FIELD_NUMBER
     
    private boolean
    requiredMatch_
     
    private static final long
    serialVersionUID
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static NameMatcher
    getDefaultInstance()
     
    NameMatcher
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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.
    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()
     
    final 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(InputStream input)
     
    static NameMatcher
    parseDelimitedFrom(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(InputStream input)
     
    static NameMatcher
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NameMatcher
    parseFrom(ByteBuffer data)
     
    static NameMatcher
    parseFrom(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

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • KEY_FIELD_NUMBER

      public static final int KEY_FIELD_NUMBER
      See Also:

    • key_

      private volatile Object key_

    • NAMES_FIELD_NUMBER

      public static final int NAMES_FIELD_NUMBER
      See Also:

    • names_

      private com.google.protobuf.LazyStringArrayList names_

    • REQUIRED_MATCH_FIELD_NUMBER

      public static final int REQUIRED_MATCH_FIELD_NUMBER
      See Also:

    • 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 Details

    • NameMatcher

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

    • NameMatcher

      private NameMatcher()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getKey

      public 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 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NameMatcher parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static NameMatcher parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static NameMatcher.Builder newBuilder()

    • newBuilder

      public static NameMatcher.Builder newBuilder(NameMatcher prototype)

    • 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