Class Matcher

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.github.xds.type.matcher.v3.Matcher
All Implemented Interfaces:
MatcherOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Matcher extends com.google.protobuf.GeneratedMessage implements MatcherOrBuilder
 A matcher, which may traverse a matching tree in order to result in a match action.
 During matching, the tree will be traversed until a match is found, or if no match
 is found the action specified by the most specific on_no_match will be evaluated.
 As an on_no_match might result in another matching tree being evaluated, this process
 might repeat several times until the final OnMatch (or no match) is decided.
 
Protobuf type xds.type.matcher.v3.Matcher
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    A matcher, which may traverse a matching tree in order to result in a match action.
    static final class 
    A linear list of field matchers.
    static interface 
     
    static final class 
    Protobuf type xds.type.matcher.v3.Matcher.MatcherTree
    static interface 
     
    static enum 
     
    static final class 
    What to do if a match is successful.
    static interface 
     

    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>, 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 int
     
    private static final Matcher
     
    static final int
     
    static final int
     
    private Object
     
    private int
     
    private byte
     
    static final int
     
     
    private static final com.google.protobuf.Parser<Matcher>
     
    private static final long
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, 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
     
    private
    Matcher(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    static Matcher
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    A linear list of matchers to evaluate.
    A linear list of matchers to evaluate.
    A match tree to evaluate.
    A match tree to evaluate.
     
    Optional OnMatch to use if no matcher above matched (e.g., if there are no matchers specified above, or if none of the matches specified above succeeded).
    Optional OnMatch to use if no matcher above matched (e.g., if there are no matchers specified above, or if none of the matches specified above succeeded).
    com.google.protobuf.Parser<Matcher>
     
    int
     
    int
     
    boolean
    A linear list of matchers to evaluate.
    boolean
    A match tree to evaluate.
    boolean
    Optional OnMatch to use if no matcher above matched (e.g., if there are no matchers specified above, or if none of the matches specified above succeeded).
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
    newBuilder(Matcher prototype)
     
     
    protected Matcher.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Matcher
     
    static Matcher
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Matcher
    parseFrom(byte[] data)
     
    static Matcher
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Matcher
    parseFrom(com.google.protobuf.ByteString data)
     
    static Matcher
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Matcher
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Matcher
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Matcher
     
    static Matcher
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Matcher
     
    static Matcher
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Matcher>
     
     
    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 Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • bitField0_

      private int bitField0_
    • matcherTypeCase_

      private int matcherTypeCase_
    • matcherType_

      private Object matcherType_
    • MATCHER_LIST_FIELD_NUMBER

      public static final int MATCHER_LIST_FIELD_NUMBER
      See Also:
    • MATCHER_TREE_FIELD_NUMBER

      public static final int MATCHER_TREE_FIELD_NUMBER
      See Also:
    • ON_NO_MATCH_FIELD_NUMBER

      public static final int ON_NO_MATCH_FIELD_NUMBER
      See Also:
    • onNoMatch_

      private Matcher.OnMatch onNoMatch_
    • memoizedIsInitialized

      private byte memoizedIsInitialized
    • DEFAULT_INSTANCE

      private static final Matcher DEFAULT_INSTANCE
    • PARSER

      private static final com.google.protobuf.Parser<Matcher> PARSER
  • Constructor Details

    • Matcher

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

      private Matcher()
  • Method Details

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

      public Matcher.MatcherTypeCase getMatcherTypeCase()
      Specified by:
      getMatcherTypeCase in interface MatcherOrBuilder
    • hasMatcherList

      public boolean hasMatcherList()
       A linear list of matchers to evaluate.
       
      .xds.type.matcher.v3.Matcher.MatcherList matcher_list = 1;
      Specified by:
      hasMatcherList in interface MatcherOrBuilder
      Returns:
      Whether the matcherList field is set.
    • getMatcherList

      public Matcher.MatcherList getMatcherList()
       A linear list of matchers to evaluate.
       
      .xds.type.matcher.v3.Matcher.MatcherList matcher_list = 1;
      Specified by:
      getMatcherList in interface MatcherOrBuilder
      Returns:
      The matcherList.
    • getMatcherListOrBuilder

      public Matcher.MatcherListOrBuilder getMatcherListOrBuilder()
       A linear list of matchers to evaluate.
       
      .xds.type.matcher.v3.Matcher.MatcherList matcher_list = 1;
      Specified by:
      getMatcherListOrBuilder in interface MatcherOrBuilder
    • hasMatcherTree

      public boolean hasMatcherTree()
       A match tree to evaluate.
       
      .xds.type.matcher.v3.Matcher.MatcherTree matcher_tree = 2;
      Specified by:
      hasMatcherTree in interface MatcherOrBuilder
      Returns:
      Whether the matcherTree field is set.
    • getMatcherTree

      public Matcher.MatcherTree getMatcherTree()
       A match tree to evaluate.
       
      .xds.type.matcher.v3.Matcher.MatcherTree matcher_tree = 2;
      Specified by:
      getMatcherTree in interface MatcherOrBuilder
      Returns:
      The matcherTree.
    • getMatcherTreeOrBuilder

      public Matcher.MatcherTreeOrBuilder getMatcherTreeOrBuilder()
       A match tree to evaluate.
       
      .xds.type.matcher.v3.Matcher.MatcherTree matcher_tree = 2;
      Specified by:
      getMatcherTreeOrBuilder in interface MatcherOrBuilder
    • hasOnNoMatch

      public boolean hasOnNoMatch()
       Optional OnMatch to use if no matcher above matched (e.g., if there are no matchers specified
       above, or if none of the matches specified above succeeded).
       If no matcher above matched and this field is not populated, the match will be considered unsuccessful.
       
      .xds.type.matcher.v3.Matcher.OnMatch on_no_match = 3;
      Specified by:
      hasOnNoMatch in interface MatcherOrBuilder
      Returns:
      Whether the onNoMatch field is set.
    • getOnNoMatch

      public Matcher.OnMatch getOnNoMatch()
       Optional OnMatch to use if no matcher above matched (e.g., if there are no matchers specified
       above, or if none of the matches specified above succeeded).
       If no matcher above matched and this field is not populated, the match will be considered unsuccessful.
       
      .xds.type.matcher.v3.Matcher.OnMatch on_no_match = 3;
      Specified by:
      getOnNoMatch in interface MatcherOrBuilder
      Returns:
      The onNoMatch.
    • getOnNoMatchOrBuilder

      public Matcher.OnMatchOrBuilder getOnNoMatchOrBuilder()
       Optional OnMatch to use if no matcher above matched (e.g., if there are no matchers specified
       above, or if none of the matches specified above succeeded).
       If no matcher above matched and this field is not populated, the match will be considered unsuccessful.
       
      .xds.type.matcher.v3.Matcher.OnMatch on_no_match = 3;
      Specified by:
      getOnNoMatchOrBuilder in interface MatcherOrBuilder
    • 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 Matcher parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Matcher parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Matcher parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

      public static Matcher parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static Matcher parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static Matcher.Builder newBuilder()
    • newBuilder

      public static Matcher.Builder newBuilder(Matcher prototype)
    • toBuilder

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

      protected Matcher.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static Matcher getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<Matcher> parser()
    • getParserForType

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