Package io.envoyproxy.envoy.extensions.filters.network.generic_proxy.action.v3

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 Details

    • getName

      String getName()
       The name of the route action. This should be unique across all route actions.
      string name = 5;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the route action. This should be unique across all route actions.
      string name = 5;
      Returns:
      The bytes for name.

    • hasCluster

      boolean hasCluster()
       Indicates the upstream cluster to which the request should be routed.
      string cluster = 1;
      Returns:
      Whether the cluster field is set.

    • getCluster

      String getCluster()
       Indicates the upstream cluster to which the request should be routed.
      string cluster = 1;
      Returns:
      The cluster.

    • getClusterBytes

      com.google.protobuf.ByteString getClusterBytes()
       Indicates the upstream cluster to which the request should be routed.
      string cluster = 1;
      Returns:
      The bytes for cluster.

    • hasWeightedClusters

      boolean hasWeightedClusters()
       [#not-implemented-hide:]
 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.
 Currently ClusterWeight only supports the name and weight fields.
      .envoy.config.route.v3.WeightedCluster weighted_clusters = 2;
      Returns:
      Whether the weightedClusters field is set.

    • getWeightedClusters

      WeightedCluster getWeightedClusters()
       [#not-implemented-hide:]
 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.
 Currently ClusterWeight only supports the name and weight fields.
      .envoy.config.route.v3.WeightedCluster weighted_clusters = 2;
      Returns:
      The weightedClusters.

    • getWeightedClustersOrBuilder

      WeightedClusterOrBuilder getWeightedClustersOrBuilder()
       [#not-implemented-hide:]
 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.
 Currently ClusterWeight only supports the name and weight fields.
      .envoy.config.route.v3.WeightedCluster weighted_clusters = 2;

    • hasMetadata

      boolean hasMetadata()
       Route metadata.
      .envoy.config.core.v3.Metadata metadata = 3;
      Returns:
      Whether the metadata field is set.

    • getMetadata

      Metadata getMetadata()
       Route metadata.
      .envoy.config.core.v3.Metadata metadata = 3;
      Returns:
      The metadata.

    • getMetadataOrBuilder

      MetadataOrBuilder getMetadataOrBuilder()
       Route metadata.
      .envoy.config.core.v3.Metadata metadata = 3;

    • getPerFilterConfigCount

      int getPerFilterConfigCount()
       Route level config for L7 generic filters. The key should be the related :ref:`extension name
 <envoy_v3_api_field_config.core.v3.TypedExtensionConfig.name>` in the :ref:`generic filters
 <envoy_v3_api_field_extensions.filters.network.generic_proxy.v3.GenericProxy.filters>`.
      map<string, .google.protobuf.Any> per_filter_config = 4;

    • containsPerFilterConfig

      boolean containsPerFilterConfig(String key)
       Route level config for L7 generic filters. The key should be the related :ref:`extension name
 <envoy_v3_api_field_config.core.v3.TypedExtensionConfig.name>` in the :ref:`generic filters
 <envoy_v3_api_field_extensions.filters.network.generic_proxy.v3.GenericProxy.filters>`.
      map<string, .google.protobuf.Any> per_filter_config = 4;

    • getPerFilterConfig

      @Deprecated Map<String,com.google.protobuf.Any> getPerFilterConfig()
      Deprecated.
      Use getPerFilterConfigMap() instead.

    • getPerFilterConfigMap

      Map<String,com.google.protobuf.Any> getPerFilterConfigMap()
       Route level config for L7 generic filters. The key should be the related :ref:`extension name
 <envoy_v3_api_field_config.core.v3.TypedExtensionConfig.name>` in the :ref:`generic filters
 <envoy_v3_api_field_extensions.filters.network.generic_proxy.v3.GenericProxy.filters>`.
      map<string, .google.protobuf.Any> per_filter_config = 4;

    • getPerFilterConfigOrDefault

      com.google.protobuf.Any getPerFilterConfigOrDefault(String key, com.google.protobuf.Any defaultValue)
       Route level config for L7 generic filters. The key should be the related :ref:`extension name
 <envoy_v3_api_field_config.core.v3.TypedExtensionConfig.name>` in the :ref:`generic filters
 <envoy_v3_api_field_extensions.filters.network.generic_proxy.v3.GenericProxy.filters>`.
      map<string, .google.protobuf.Any> per_filter_config = 4;

    • getPerFilterConfigOrThrow

      com.google.protobuf.Any getPerFilterConfigOrThrow(String key)
       Route level config for L7 generic filters. The key should be the related :ref:`extension name
 <envoy_v3_api_field_config.core.v3.TypedExtensionConfig.name>` in the :ref:`generic filters
 <envoy_v3_api_field_extensions.filters.network.generic_proxy.v3.GenericProxy.filters>`.
      map<string, .google.protobuf.Any> per_filter_config = 4;

    • hasTimeout

      boolean hasTimeout()
       Specifies the upstream timeout for the route. If not specified, the default is 15s. This
 spans between the point at which the entire downstream request (i.e. end-of-stream) has been
 processed and when the upstream response has been completely processed. A value of 0 will
 disable the route's timeout.
      .google.protobuf.Duration timeout = 6;
      Returns:
      Whether the timeout field is set.

    • getTimeout

      com.google.protobuf.Duration getTimeout()
       Specifies the upstream timeout for the route. If not specified, the default is 15s. This
 spans between the point at which the entire downstream request (i.e. end-of-stream) has been
 processed and when the upstream response has been completely processed. A value of 0 will
 disable the route's timeout.
      .google.protobuf.Duration timeout = 6;
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
       Specifies the upstream timeout for the route. If not specified, the default is 15s. This
 spans between the point at which the entire downstream request (i.e. end-of-stream) has been
 processed and when the upstream response has been completely processed. A value of 0 will
 disable the route's timeout.
      .google.protobuf.Duration timeout = 6;

    • hasRetryPolicy

      boolean hasRetryPolicy()
       Specifies the retry policy for the route. If not specified, then no retries will be performed.

 .. note::
   Only simplest retry policy is supported and only ``num_retries`` field is used for generic
   proxy. The default value for ``num_retries`` is 1 means that the request will be tried once
   and no additional retries will be performed.
      .envoy.config.core.v3.RetryPolicy retry_policy = 7;
      Returns:
      Whether the retryPolicy field is set.

    • getRetryPolicy

      RetryPolicy getRetryPolicy()
       Specifies the retry policy for the route. If not specified, then no retries will be performed.

 .. note::
   Only simplest retry policy is supported and only ``num_retries`` field is used for generic
   proxy. The default value for ``num_retries`` is 1 means that the request will be tried once
   and no additional retries will be performed.
      .envoy.config.core.v3.RetryPolicy retry_policy = 7;
      Returns:
      The retryPolicy.

    • getRetryPolicyOrBuilder

      RetryPolicyOrBuilder getRetryPolicyOrBuilder()
       Specifies the retry policy for the route. If not specified, then no retries will be performed.

 .. note::
   Only simplest retry policy is supported and only ``num_retries`` field is used for generic
   proxy. The default value for ``num_retries`` is 1 means that the request will be tried once
   and no additional retries will be performed.
      .envoy.config.core.v3.RetryPolicy retry_policy = 7;

    • getClusterSpecifierCase

      RouteAction.ClusterSpecifierCase getClusterSpecifierCase()