Package io.envoyproxy.envoy.extensions.filters.network.thrift_proxy.v3

Class 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: 8]
    Protobuf type envoy.extensions.filters.network.thrift_proxy.v3.RouteAction
    See Also:
    Serialized Form

    • Field Detail

      • WEIGHTED_CLUSTERS_FIELD_NUMBER

        public static final int WEIGHTED_CLUSTERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLUSTER_HEADER_FIELD_NUMBER

        public static final int CLUSTER_HEADER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • METADATA_MATCH_FIELD_NUMBER

        public static final int METADATA_MATCH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RATE_LIMITS_FIELD_NUMBER

        public static final int RATE_LIMITS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STRIP_SERVICE_NAME_FIELD_NUMBER

        public static final int STRIP_SERVICE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_MIRROR_POLICIES_FIELD_NUMBER

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

      • 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.extensions.filters.network.thrift_proxy.v3.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.extensions.filters.network.thrift_proxy.v3.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.extensions.filters.network.thrift_proxy.v3.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_v3_api_field_extensions.filters.network.thrift_proxy.v3.WeightedCluster.ClusterWeight.metadata_match>`,
 with values there taking precedence. Keys and values should be provided under the "envoy.lb"
 metadata key.
        .envoy.config.core.v3.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_v3_api_field_extensions.filters.network.thrift_proxy.v3.WeightedCluster.ClusterWeight.metadata_match>`,
 with values there taking precedence. Keys and values should be provided under the "envoy.lb"
 metadata key.
        .envoy.config.core.v3.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_v3_api_field_extensions.filters.network.thrift_proxy.v3.WeightedCluster.ClusterWeight.metadata_match>`,
 with values there taking precedence. Keys and values should be provided under the "envoy.lb"
 metadata key.
        .envoy.config.core.v3.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.config.route.v3.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.config.route.v3.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.config.route.v3.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.config.route.v3.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.config.route.v3.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.

      • getRequestMirrorPoliciesCount

        public int getRequestMirrorPoliciesCount()
         Indicates that the route has request mirroring policies.
        repeated .envoy.extensions.filters.network.thrift_proxy.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 7;
        Specified by:
        getRequestMirrorPoliciesCount in interface RouteActionOrBuilder

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

      • 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