Package com.github.xds.type.matcher.v3

Class 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.GeneratedMessageV3
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:
    Serialized Form

    • Nested Class Summary

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

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int MATCHER_LIST_FIELD_NUMBER  
      static int MATCHER_TREE_FIELD_NUMBER  
      static int ON_NO_MATCH_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

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

        memoizedSize

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

        memoizedHashCode

    • Field Detail

      • MATCHER_LIST_FIELD_NUMBER

        public static final int MATCHER_LIST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MATCHER_TREE_FIELD_NUMBER

        public static final int MATCHER_TREE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ON_NO_MATCH_FIELD_NUMBER

        public static final int ON_NO_MATCH_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

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

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

      • 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.GeneratedMessageV3

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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