Package io.envoyproxy.envoy.config.common.matcher.v3

Class Matcher.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>
io.envoyproxy.envoy.config.common.matcher.v3.Matcher.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MatcherOrBuilder, Cloneable
Enclosing class:
Matcher
public static final class Matcher.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder> 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.

 .. note::
   Please use the syntactically equivalent :ref:`matching API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>`
Protobuf type envoy.config.common.matcher.v3.Matcher

  • Method Details

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

    • clear

      public Matcher.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public Matcher.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>

    • setField

      public Matcher.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>

    • clearField

      public Matcher.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>

    • clearOneof

      public Matcher.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>

    • setRepeatedField

      public Matcher.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>

    • addRepeatedField

      public Matcher.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>

    • mergeFrom

      public Matcher.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Matcher.Builder>

    • mergeFrom

      public Matcher.Builder mergeFrom(Matcher other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>

    • mergeFrom

      public Matcher.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Matcher.Builder>
      Throws:
      IOException

    • getMatcherTypeCase

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

    • clearMatcherType

      public Matcher.Builder clearMatcherType()

    • hasMatcherList

      public boolean hasMatcherList()
       A linear list of matchers to evaluate.
      .envoy.config.common.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.
      .envoy.config.common.matcher.v3.Matcher.MatcherList matcher_list = 1;
      Specified by:
      getMatcherList in interface MatcherOrBuilder
      Returns:
      The matcherList.

    • setMatcherList

      public Matcher.Builder setMatcherList(Matcher.MatcherList value)
       A linear list of matchers to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherList matcher_list = 1;

    • setMatcherList

      public Matcher.Builder setMatcherList(Matcher.MatcherList.Builder builderForValue)
       A linear list of matchers to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherList matcher_list = 1;

    • mergeMatcherList

      public Matcher.Builder mergeMatcherList(Matcher.MatcherList value)
       A linear list of matchers to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherList matcher_list = 1;

    • clearMatcherList

      public Matcher.Builder clearMatcherList()
       A linear list of matchers to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherList matcher_list = 1;

    • getMatcherListBuilder

      public Matcher.MatcherList.Builder getMatcherListBuilder()
       A linear list of matchers to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherList matcher_list = 1;

    • getMatcherListOrBuilder

      public Matcher.MatcherListOrBuilder getMatcherListOrBuilder()
       A linear list of matchers to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherList matcher_list = 1;
      Specified by:
      getMatcherListOrBuilder in interface MatcherOrBuilder

    • hasMatcherTree

      public boolean hasMatcherTree()
       A match tree to evaluate.
      .envoy.config.common.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.
      .envoy.config.common.matcher.v3.Matcher.MatcherTree matcher_tree = 2;
      Specified by:
      getMatcherTree in interface MatcherOrBuilder
      Returns:
      The matcherTree.

    • setMatcherTree

      public Matcher.Builder setMatcherTree(Matcher.MatcherTree value)
       A match tree to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherTree matcher_tree = 2;

    • setMatcherTree

      public Matcher.Builder setMatcherTree(Matcher.MatcherTree.Builder builderForValue)
       A match tree to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherTree matcher_tree = 2;

    • mergeMatcherTree

      public Matcher.Builder mergeMatcherTree(Matcher.MatcherTree value)
       A match tree to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherTree matcher_tree = 2;

    • clearMatcherTree

      public Matcher.Builder clearMatcherTree()
       A match tree to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherTree matcher_tree = 2;

    • getMatcherTreeBuilder

      public Matcher.MatcherTree.Builder getMatcherTreeBuilder()
       A match tree to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherTree matcher_tree = 2;

    • getMatcherTreeOrBuilder

      public Matcher.MatcherTreeOrBuilder getMatcherTreeOrBuilder()
       A match tree to evaluate.
      .envoy.config.common.matcher.v3.Matcher.MatcherTree matcher_tree = 2;
      Specified by:
      getMatcherTreeOrBuilder in interface MatcherOrBuilder

    • hasOnNoMatch

      public boolean hasOnNoMatch()
       Optional ``OnMatch`` to use if the matcher failed.
 If specified, the ``OnMatch`` is used, and the matcher is considered
 to have matched.
 If not specified, the matcher is considered not to have matched.
      .envoy.config.common.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 the matcher failed.
 If specified, the ``OnMatch`` is used, and the matcher is considered
 to have matched.
 If not specified, the matcher is considered not to have matched.
      .envoy.config.common.matcher.v3.Matcher.OnMatch on_no_match = 3;
      Specified by:
      getOnNoMatch in interface MatcherOrBuilder
      Returns:
      The onNoMatch.

    • setOnNoMatch

      public Matcher.Builder setOnNoMatch(Matcher.OnMatch value)
       Optional ``OnMatch`` to use if the matcher failed.
 If specified, the ``OnMatch`` is used, and the matcher is considered
 to have matched.
 If not specified, the matcher is considered not to have matched.
      .envoy.config.common.matcher.v3.Matcher.OnMatch on_no_match = 3;

    • setOnNoMatch

      public Matcher.Builder setOnNoMatch(Matcher.OnMatch.Builder builderForValue)
       Optional ``OnMatch`` to use if the matcher failed.
 If specified, the ``OnMatch`` is used, and the matcher is considered
 to have matched.
 If not specified, the matcher is considered not to have matched.
      .envoy.config.common.matcher.v3.Matcher.OnMatch on_no_match = 3;

    • mergeOnNoMatch

      public Matcher.Builder mergeOnNoMatch(Matcher.OnMatch value)
       Optional ``OnMatch`` to use if the matcher failed.
 If specified, the ``OnMatch`` is used, and the matcher is considered
 to have matched.
 If not specified, the matcher is considered not to have matched.
      .envoy.config.common.matcher.v3.Matcher.OnMatch on_no_match = 3;

    • clearOnNoMatch

      public Matcher.Builder clearOnNoMatch()
       Optional ``OnMatch`` to use if the matcher failed.
 If specified, the ``OnMatch`` is used, and the matcher is considered
 to have matched.
 If not specified, the matcher is considered not to have matched.
      .envoy.config.common.matcher.v3.Matcher.OnMatch on_no_match = 3;

    • getOnNoMatchBuilder

      public Matcher.OnMatch.Builder getOnNoMatchBuilder()
       Optional ``OnMatch`` to use if the matcher failed.
 If specified, the ``OnMatch`` is used, and the matcher is considered
 to have matched.
 If not specified, the matcher is considered not to have matched.
      .envoy.config.common.matcher.v3.Matcher.OnMatch on_no_match = 3;

    • getOnNoMatchOrBuilder

      public Matcher.OnMatchOrBuilder getOnNoMatchOrBuilder()
       Optional ``OnMatch`` to use if the matcher failed.
 If specified, the ``OnMatch`` is used, and the matcher is considered
 to have matched.
 If not specified, the matcher is considered not to have matched.
      .envoy.config.common.matcher.v3.Matcher.OnMatch on_no_match = 3;
      Specified by:
      getOnNoMatchOrBuilder in interface MatcherOrBuilder

    • setUnknownFields

      public final Matcher.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>

    • mergeUnknownFields

      public final Matcher.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Matcher.Builder>