Package io.envoyproxy.envoy.extensions.router.cluster_specifiers.matcher.v3

Class MatcherClusterSpecifier

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.router.cluster_specifiers.matcher.v3.MatcherClusterSpecifier
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MatcherClusterSpecifierOrBuilder, Serializable
public final class MatcherClusterSpecifier extends com.google.protobuf.GeneratedMessageV3 implements MatcherClusterSpecifierOrBuilder
Protobuf type envoy.extensions.router.cluster_specifiers.matcher.v3.MatcherClusterSpecifier
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MatcherClusterSpecifier.Builder
    Protobuf type envoy.extensions.router.cluster_specifiers.matcher.v3.MatcherClusterSpecifier

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 final int
    CLUSTER_MATCHER_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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    Matcher
    getClusterMatcher()
    The matcher for cluster selection after the route has been selected.
    MatcherOrBuilder
    getClusterMatcherOrBuilder()
    The matcher for cluster selection after the route has been selected.
    static MatcherClusterSpecifier
    getDefaultInstance()
     
    MatcherClusterSpecifier
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<MatcherClusterSpecifier>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasClusterMatcher()
    The matcher for cluster selection after the route has been selected.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static MatcherClusterSpecifier.Builder
    newBuilder()
     
    static MatcherClusterSpecifier.Builder
    newBuilder(MatcherClusterSpecifier prototype)
     
    MatcherClusterSpecifier.Builder
    newBuilderForType()
     
    protected MatcherClusterSpecifier.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static MatcherClusterSpecifier
    parseDelimitedFrom(InputStream input)
     
    static MatcherClusterSpecifier
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MatcherClusterSpecifier
    parseFrom(byte[] data)
     
    static MatcherClusterSpecifier
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MatcherClusterSpecifier
    parseFrom(com.google.protobuf.ByteString data)
     
    static MatcherClusterSpecifier
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MatcherClusterSpecifier
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static MatcherClusterSpecifier
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MatcherClusterSpecifier
    parseFrom(InputStream input)
     
    static MatcherClusterSpecifier
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MatcherClusterSpecifier
    parseFrom(ByteBuffer data)
     
    static MatcherClusterSpecifier
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MatcherClusterSpecifier>
    parser()
     
    MatcherClusterSpecifier.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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

    • CLUSTER_MATCHER_FIELD_NUMBER

      public static final int CLUSTER_MATCHER_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • hasClusterMatcher

      public boolean hasClusterMatcher()
       The matcher for cluster selection after the route has been selected. This is used when the
 route has multiple clusters (like multiple clusters for different users) and the matcher
 is used to select the cluster to use for the request.

 The match tree to use for grouping incoming requests into buckets.

 Example:

 .. validated-code-block:: yaml
   :type-name: xds.type.matcher.v3.Matcher

   matcher_list:
     matchers:
     - predicate:
         single_predicate:
           input:
             typed_config:
               '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput
               header_name: env
           value_match:
             exact: staging
       on_match:
         action:
           typed_config:
             '@type': type.googleapis.com/envoy.extensions.router.cluster_specifiers.matcher.v3.ClusterAction
             cluster: "staging-cluster"

     - predicate:
         single_predicate:
           input:
             typed_config:
               '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput
               header_name: env
           value_match:
             exact: prod
       on_match:
         action:
           typed_config:
             '@type': type.googleapis.com/envoy.extensions.router.cluster_specifiers.matcher.v3.ClusterAction
             cluster: "prod-cluster"

   # Catch-all with a default cluster.
   on_no_match:
     action:
       typed_config:
         '@type': type.googleapis.com/envoy.extensions.router.cluster_specifiers.matcher.v3.ClusterAction
         cluster: "default-cluster"
      .xds.type.matcher.v3.Matcher cluster_matcher = 1 [(.validate.rules) = { ... }
      Specified by:
      hasClusterMatcher in interface MatcherClusterSpecifierOrBuilder
      Returns:
      Whether the clusterMatcher field is set.

    • getClusterMatcher

      public Matcher getClusterMatcher()
       The matcher for cluster selection after the route has been selected. This is used when the
 route has multiple clusters (like multiple clusters for different users) and the matcher
 is used to select the cluster to use for the request.

 The match tree to use for grouping incoming requests into buckets.

 Example:

 .. validated-code-block:: yaml
   :type-name: xds.type.matcher.v3.Matcher

   matcher_list:
     matchers:
     - predicate:
         single_predicate:
           input:
             typed_config:
               '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput
               header_name: env
           value_match:
             exact: staging
       on_match:
         action:
           typed_config:
             '@type': type.googleapis.com/envoy.extensions.router.cluster_specifiers.matcher.v3.ClusterAction
             cluster: "staging-cluster"

     - predicate:
         single_predicate:
           input:
             typed_config:
               '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput
               header_name: env
           value_match:
             exact: prod
       on_match:
         action:
           typed_config:
             '@type': type.googleapis.com/envoy.extensions.router.cluster_specifiers.matcher.v3.ClusterAction
             cluster: "prod-cluster"

   # Catch-all with a default cluster.
   on_no_match:
     action:
       typed_config:
         '@type': type.googleapis.com/envoy.extensions.router.cluster_specifiers.matcher.v3.ClusterAction
         cluster: "default-cluster"
      .xds.type.matcher.v3.Matcher cluster_matcher = 1 [(.validate.rules) = { ... }
      Specified by:
      getClusterMatcher in interface MatcherClusterSpecifierOrBuilder
      Returns:
      The clusterMatcher.

    • getClusterMatcherOrBuilder

      public MatcherOrBuilder getClusterMatcherOrBuilder()
       The matcher for cluster selection after the route has been selected. This is used when the
 route has multiple clusters (like multiple clusters for different users) and the matcher
 is used to select the cluster to use for the request.

 The match tree to use for grouping incoming requests into buckets.

 Example:

 .. validated-code-block:: yaml
   :type-name: xds.type.matcher.v3.Matcher

   matcher_list:
     matchers:
     - predicate:
         single_predicate:
           input:
             typed_config:
               '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput
               header_name: env
           value_match:
             exact: staging
       on_match:
         action:
           typed_config:
             '@type': type.googleapis.com/envoy.extensions.router.cluster_specifiers.matcher.v3.ClusterAction
             cluster: "staging-cluster"

     - predicate:
         single_predicate:
           input:
             typed_config:
               '@type': type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput
               header_name: env
           value_match:
             exact: prod
       on_match:
         action:
           typed_config:
             '@type': type.googleapis.com/envoy.extensions.router.cluster_specifiers.matcher.v3.ClusterAction
             cluster: "prod-cluster"

   # Catch-all with a default cluster.
   on_no_match:
     action:
       typed_config:
         '@type': type.googleapis.com/envoy.extensions.router.cluster_specifiers.matcher.v3.ClusterAction
         cluster: "default-cluster"
      .xds.type.matcher.v3.Matcher cluster_matcher = 1 [(.validate.rules) = { ... }
      Specified by:
      getClusterMatcherOrBuilder in interface MatcherClusterSpecifierOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static MatcherClusterSpecifier parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static MatcherClusterSpecifier.Builder newBuilder()

    • newBuilder

      public static MatcherClusterSpecifier.Builder newBuilder(MatcherClusterSpecifier prototype)

    • toBuilder

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

    • newBuilderForType

      protected MatcherClusterSpecifier.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static MatcherClusterSpecifier getDefaultInstance()

    • parser

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

    • getParserForType

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