Package io.envoyproxy.envoy.config.filter.network.thrift_proxy.v2alpha1

Class RouteAction

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.filter.network.thrift_proxy.v2alpha1.RouteAction
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteActionOrBuilder, Serializable
public final class RouteAction extends com.google.protobuf.GeneratedMessageV3 implements RouteActionOrBuilder
 [#next-free-field: 7]
Protobuf type envoy.config.filter.network.thrift_proxy.v2alpha1.RouteAction
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RouteAction.Builder
    [#next-free-field: 7]
    static enum 
    RouteAction.ClusterSpecifierCase
     

    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_FIELD_NUMBER
     
    static final int
    CLUSTER_HEADER_FIELD_NUMBER
     
    static final int
    METADATA_MATCH_FIELD_NUMBER
     
    static final int
    RATE_LIMITS_FIELD_NUMBER
     
    static final int
    STRIP_SERVICE_NAME_FIELD_NUMBER
     
    static final int
    WEIGHTED_CLUSTERS_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)
     
    String
    getCluster()
    Indicates a single upstream cluster to which the request should be routed to.
    com.google.protobuf.ByteString
    getClusterBytes()
    Indicates a single upstream cluster to which the request should be routed to.
    String
    getClusterHeader()
    Envoy will determine the cluster to route to by reading the value of the Thrift header named by cluster_header from the request headers.
    com.google.protobuf.ByteString
    getClusterHeaderBytes()
    Envoy will determine the cluster to route to by reading the value of the Thrift header named by cluster_header from the request headers.
    RouteAction.ClusterSpecifierCase
    getClusterSpecifierCase()
     
    static RouteAction
    getDefaultInstance()
     
    RouteAction
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Metadata
    getMetadataMatch()
    Optional endpoint metadata match criteria used by the subset load balancer.
    MetadataOrBuilder
    getMetadataMatchOrBuilder()
    Optional endpoint metadata match criteria used by the subset load balancer.
    com.google.protobuf.Parser<RouteAction>
    getParserForType()
     
    RateLimit
    getRateLimits(int index)
    Specifies a set of rate limit configurations that could be applied to the route.
    int
    getRateLimitsCount()
    Specifies a set of rate limit configurations that could be applied to the route.
    List<RateLimit>
    getRateLimitsList()
    Specifies a set of rate limit configurations that could be applied to the route.
    RateLimitOrBuilder
    getRateLimitsOrBuilder(int index)
    Specifies a set of rate limit configurations that could be applied to the route.
    List<? extends RateLimitOrBuilder>
    getRateLimitsOrBuilderList()
    Specifies a set of rate limit configurations that could be applied to the route.
    int
    getSerializedSize()
     
    boolean
    getStripServiceName()
    Strip the service prefix from the method name, if there's a prefix.
    WeightedCluster
    getWeightedClusters()
    Multiple upstream clusters can be specified for a given route.
    WeightedClusterOrBuilder
    getWeightedClustersOrBuilder()
    Multiple upstream clusters can be specified for a given route.
    boolean
    hasCluster()
    Indicates a single upstream cluster to which the request should be routed to.
    boolean
    hasClusterHeader()
    Envoy will determine the cluster to route to by reading the value of the Thrift header named by cluster_header from the request headers.
    int
    hashCode()
     
    boolean
    hasMetadataMatch()
    Optional endpoint metadata match criteria used by the subset load balancer.
    boolean
    hasWeightedClusters()
    Multiple upstream clusters can be specified for a given route.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RouteAction.Builder
    newBuilder()
     
    static RouteAction.Builder
    newBuilder(RouteAction prototype)
     
    RouteAction.Builder
    newBuilderForType()
     
    protected RouteAction.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static RouteAction
    parseDelimitedFrom(InputStream input)
     
    static RouteAction
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteAction
    parseFrom(byte[] data)
     
    static RouteAction
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteAction
    parseFrom(com.google.protobuf.ByteString data)
     
    static RouteAction
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteAction
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RouteAction
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteAction
    parseFrom(InputStream input)
     
    static RouteAction
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteAction
    parseFrom(ByteBuffer data)
     
    static RouteAction
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RouteAction>
    parser()
     
    RouteAction.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_FIELD_NUMBER

      public static final int CLUSTER_FIELD_NUMBER
      See Also:

    • WEIGHTED_CLUSTERS_FIELD_NUMBER

      public static final int WEIGHTED_CLUSTERS_FIELD_NUMBER
      See Also:

    • CLUSTER_HEADER_FIELD_NUMBER

      public static final int CLUSTER_HEADER_FIELD_NUMBER
      See Also:

    • METADATA_MATCH_FIELD_NUMBER

      public static final int METADATA_MATCH_FIELD_NUMBER
      See Also:

    • RATE_LIMITS_FIELD_NUMBER

      public static final int RATE_LIMITS_FIELD_NUMBER
      See Also:

    • STRIP_SERVICE_NAME_FIELD_NUMBER

      public static final int STRIP_SERVICE_NAME_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

    • getClusterSpecifierCase

      public RouteAction.ClusterSpecifierCase getClusterSpecifierCase()
      Specified by:
      getClusterSpecifierCase in interface RouteActionOrBuilder

    • hasCluster

      public boolean hasCluster()
       Indicates a single upstream cluster to which the request should be routed
 to.
      string cluster = 1 [(.validate.rules) = { ... }
      Specified by:
      hasCluster in interface RouteActionOrBuilder
      Returns:
      Whether the cluster field is set.

    • getCluster

      public String getCluster()
       Indicates a single upstream cluster to which the request should be routed
 to.
      string cluster = 1 [(.validate.rules) = { ... }
      Specified by:
      getCluster in interface RouteActionOrBuilder
      Returns:
      The cluster.

    • getClusterBytes

      public com.google.protobuf.ByteString getClusterBytes()
       Indicates a single upstream cluster to which the request should be routed
 to.
      string cluster = 1 [(.validate.rules) = { ... }
      Specified by:
      getClusterBytes in interface RouteActionOrBuilder
      Returns:
      The bytes for cluster.

    • hasWeightedClusters

      public boolean hasWeightedClusters()
       Multiple upstream clusters can be specified for a given route. The
 request is routed to one of the upstream clusters based on weights
 assigned to each cluster.
      .envoy.config.filter.network.thrift_proxy.v2alpha1.WeightedCluster weighted_clusters = 2;
      Specified by:
      hasWeightedClusters in interface RouteActionOrBuilder
      Returns:
      Whether the weightedClusters field is set.

    • getWeightedClusters

      public WeightedCluster getWeightedClusters()
       Multiple upstream clusters can be specified for a given route. The
 request is routed to one of the upstream clusters based on weights
 assigned to each cluster.
      .envoy.config.filter.network.thrift_proxy.v2alpha1.WeightedCluster weighted_clusters = 2;
      Specified by:
      getWeightedClusters in interface RouteActionOrBuilder
      Returns:
      The weightedClusters.

    • getWeightedClustersOrBuilder

      public WeightedClusterOrBuilder getWeightedClustersOrBuilder()
       Multiple upstream clusters can be specified for a given route. The
 request is routed to one of the upstream clusters based on weights
 assigned to each cluster.
      .envoy.config.filter.network.thrift_proxy.v2alpha1.WeightedCluster weighted_clusters = 2;
      Specified by:
      getWeightedClustersOrBuilder in interface RouteActionOrBuilder

    • hasClusterHeader

      public boolean hasClusterHeader()
       Envoy will determine the cluster to route to by reading the value of the
 Thrift header named by cluster_header from the request headers. If the
 header is not found or the referenced cluster does not exist Envoy will
 respond with an unknown method exception or an internal error exception,
 respectively.
      string cluster_header = 6 [(.validate.rules) = { ... }
      Specified by:
      hasClusterHeader in interface RouteActionOrBuilder
      Returns:
      Whether the clusterHeader field is set.

    • getClusterHeader

      public String getClusterHeader()
       Envoy will determine the cluster to route to by reading the value of the
 Thrift header named by cluster_header from the request headers. If the
 header is not found or the referenced cluster does not exist Envoy will
 respond with an unknown method exception or an internal error exception,
 respectively.
      string cluster_header = 6 [(.validate.rules) = { ... }
      Specified by:
      getClusterHeader in interface RouteActionOrBuilder
      Returns:
      The clusterHeader.

    • getClusterHeaderBytes

      public com.google.protobuf.ByteString getClusterHeaderBytes()
       Envoy will determine the cluster to route to by reading the value of the
 Thrift header named by cluster_header from the request headers. If the
 header is not found or the referenced cluster does not exist Envoy will
 respond with an unknown method exception or an internal error exception,
 respectively.
      string cluster_header = 6 [(.validate.rules) = { ... }
      Specified by:
      getClusterHeaderBytes in interface RouteActionOrBuilder
      Returns:
      The bytes for clusterHeader.

    • hasMetadataMatch

      public boolean hasMetadataMatch()
       Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in
 the upstream cluster with metadata matching what is set in this field will be considered.
 Note that this will be merged with what's provided in :ref:`WeightedCluster.metadata_match
 <envoy_api_field_config.filter.network.thrift_proxy.v2alpha1.WeightedCluster.ClusterWeight.metadata_match>`,
 with values there taking precedence. Keys and values should be provided under the "envoy.lb"
 metadata key.
      .envoy.api.v2.core.Metadata metadata_match = 3;
      Specified by:
      hasMetadataMatch in interface RouteActionOrBuilder
      Returns:
      Whether the metadataMatch field is set.

    • getMetadataMatch

      public Metadata getMetadataMatch()
       Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in
 the upstream cluster with metadata matching what is set in this field will be considered.
 Note that this will be merged with what's provided in :ref:`WeightedCluster.metadata_match
 <envoy_api_field_config.filter.network.thrift_proxy.v2alpha1.WeightedCluster.ClusterWeight.metadata_match>`,
 with values there taking precedence. Keys and values should be provided under the "envoy.lb"
 metadata key.
      .envoy.api.v2.core.Metadata metadata_match = 3;
      Specified by:
      getMetadataMatch in interface RouteActionOrBuilder
      Returns:
      The metadataMatch.

    • getMetadataMatchOrBuilder

      public MetadataOrBuilder getMetadataMatchOrBuilder()
       Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in
 the upstream cluster with metadata matching what is set in this field will be considered.
 Note that this will be merged with what's provided in :ref:`WeightedCluster.metadata_match
 <envoy_api_field_config.filter.network.thrift_proxy.v2alpha1.WeightedCluster.ClusterWeight.metadata_match>`,
 with values there taking precedence. Keys and values should be provided under the "envoy.lb"
 metadata key.
      .envoy.api.v2.core.Metadata metadata_match = 3;
      Specified by:
      getMetadataMatchOrBuilder in interface RouteActionOrBuilder

    • getRateLimitsList

      public List<RateLimit> getRateLimitsList()
       Specifies a set of rate limit configurations that could be applied to the route.
 N.B. Thrift service or method name matching can be achieved by specifying a RequestHeaders
 action with the header name ":method-name".
      repeated .envoy.api.v2.route.RateLimit rate_limits = 4;
      Specified by:
      getRateLimitsList in interface RouteActionOrBuilder

    • getRateLimitsOrBuilderList

      public List<? extends RateLimitOrBuilder> getRateLimitsOrBuilderList()
       Specifies a set of rate limit configurations that could be applied to the route.
 N.B. Thrift service or method name matching can be achieved by specifying a RequestHeaders
 action with the header name ":method-name".
      repeated .envoy.api.v2.route.RateLimit rate_limits = 4;
      Specified by:
      getRateLimitsOrBuilderList in interface RouteActionOrBuilder

    • getRateLimitsCount

      public int getRateLimitsCount()
       Specifies a set of rate limit configurations that could be applied to the route.
 N.B. Thrift service or method name matching can be achieved by specifying a RequestHeaders
 action with the header name ":method-name".
      repeated .envoy.api.v2.route.RateLimit rate_limits = 4;
      Specified by:
      getRateLimitsCount in interface RouteActionOrBuilder

    • getRateLimits

      public RateLimit getRateLimits(int index)
       Specifies a set of rate limit configurations that could be applied to the route.
 N.B. Thrift service or method name matching can be achieved by specifying a RequestHeaders
 action with the header name ":method-name".
      repeated .envoy.api.v2.route.RateLimit rate_limits = 4;
      Specified by:
      getRateLimits in interface RouteActionOrBuilder

    • getRateLimitsOrBuilder

      public RateLimitOrBuilder getRateLimitsOrBuilder(int index)
       Specifies a set of rate limit configurations that could be applied to the route.
 N.B. Thrift service or method name matching can be achieved by specifying a RequestHeaders
 action with the header name ":method-name".
      repeated .envoy.api.v2.route.RateLimit rate_limits = 4;
      Specified by:
      getRateLimitsOrBuilder in interface RouteActionOrBuilder

    • getStripServiceName

      public boolean getStripServiceName()
       Strip the service prefix from the method name, if there's a prefix. For
 example, the method call Service:method would end up being just method.
      bool strip_service_name = 5;
      Specified by:
      getStripServiceName in interface RouteActionOrBuilder
      Returns:
      The stripServiceName.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RouteAction.Builder newBuilder()

    • newBuilder

      public static RouteAction.Builder newBuilder(RouteAction prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RouteAction getDefaultInstance()

    • parser

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

    • getParserForType

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