Interface RouteActionOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RouteAction, RouteAction.Builder

    public interface RouteActionOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.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.
      java.lang.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()  
      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.
      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.
      java.util.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.
      java.util.List<? extends RateLimitOrBuilder> getRateLimitsOrBuilderList()
      Specifies a set of rate limit configurations that could be applied to the route.
      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.
      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.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • hasCluster

        boolean hasCluster()
         Indicates a single upstream cluster to which the request should be routed
         to.
         
        string cluster = 1 [(.validate.rules) = { ... }
        Returns:
        Whether the cluster field is set.
      • getCluster

        java.lang.String getCluster()
         Indicates a single upstream cluster to which the request should be routed
         to.
         
        string cluster = 1 [(.validate.rules) = { ... }
        Returns:
        The cluster.
      • getClusterBytes

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

        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;
        Returns:
        Whether the weightedClusters field is set.
      • getWeightedClusters

        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;
        Returns:
        The weightedClusters.
      • getWeightedClustersOrBuilder

        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;
      • hasClusterHeader

        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) = { ... }
        Returns:
        Whether the clusterHeader field is set.
      • getClusterHeader

        java.lang.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) = { ... }
        Returns:
        The clusterHeader.
      • getClusterHeaderBytes

        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) = { ... }
        Returns:
        The bytes for clusterHeader.
      • hasMetadataMatch

        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;
        Returns:
        Whether the metadataMatch field is set.
      • getMetadataMatch

        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;
        Returns:
        The metadataMatch.
      • getMetadataMatchOrBuilder

        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;
      • getRateLimitsList

        java.util.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;
      • getRateLimits

        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;
      • getRateLimitsCount

        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;
      • getRateLimitsOrBuilderList

        java.util.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;
      • getRateLimitsOrBuilder

        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;
      • getStripServiceName

        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;
        Returns:
        The stripServiceName.