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

Class RouteAction

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.network.generic_proxy.action.v3.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
 Configuration for the route match action.
 [#next-free-field: 8]
Protobuf type envoy.extensions.filters.network.generic_proxy.action.v3.RouteAction
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • 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:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • PER_FILTER_CONFIG_FIELD_NUMBER

      public static final int PER_FILTER_CONFIG_FIELD_NUMBER
      See Also:

    • TIMEOUT_FIELD_NUMBER

      public static final int TIMEOUT_FIELD_NUMBER
      See Also:

    • RETRY_POLICY_FIELD_NUMBER

      public static final int RETRY_POLICY_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()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • 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

    • getName

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

    • getNameBytes

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

    • hasCluster

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

    • getCluster

      public String getCluster()
       Indicates the upstream cluster to which the request should be routed.
      string cluster = 1;
      Specified by:
      getCluster in interface RouteActionOrBuilder
      Returns:
      The cluster.

    • getClusterBytes

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

    • hasWeightedClusters

      public 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;
      Specified by:
      hasWeightedClusters in interface RouteActionOrBuilder
      Returns:
      Whether the weightedClusters field is set.

    • getWeightedClusters

      public 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;
      Specified by:
      getWeightedClusters in interface RouteActionOrBuilder
      Returns:
      The weightedClusters.

    • getWeightedClustersOrBuilder

      public 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;
      Specified by:
      getWeightedClustersOrBuilder in interface RouteActionOrBuilder

    • hasMetadata

      public boolean hasMetadata()
       Route metadata.
      .envoy.config.core.v3.Metadata metadata = 3;
      Specified by:
      hasMetadata in interface RouteActionOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      public Metadata getMetadata()
       Route metadata.
      .envoy.config.core.v3.Metadata metadata = 3;
      Specified by:
      getMetadata in interface RouteActionOrBuilder
      Returns:
      The metadata.

    • getMetadataOrBuilder

      public MetadataOrBuilder getMetadataOrBuilder()
       Route metadata.
      .envoy.config.core.v3.Metadata metadata = 3;
      Specified by:
      getMetadataOrBuilder in interface RouteActionOrBuilder

    • getPerFilterConfigCount

      public int getPerFilterConfigCount()
      Description copied from interface: RouteActionOrBuilder
       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;
      Specified by:
      getPerFilterConfigCount in interface RouteActionOrBuilder

    • containsPerFilterConfig

      public 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;
      Specified by:
      containsPerFilterConfig in interface RouteActionOrBuilder

    • getPerFilterConfig

      @Deprecated public Map<String,com.google.protobuf.Any> getPerFilterConfig()
      Deprecated.
      Use getPerFilterConfigMap() instead.
      Specified by:
      getPerFilterConfig in interface RouteActionOrBuilder

    • getPerFilterConfigMap

      public 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;
      Specified by:
      getPerFilterConfigMap in interface RouteActionOrBuilder

    • getPerFilterConfigOrDefault

      public 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;
      Specified by:
      getPerFilterConfigOrDefault in interface RouteActionOrBuilder

    • getPerFilterConfigOrThrow

      public 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;
      Specified by:
      getPerFilterConfigOrThrow in interface RouteActionOrBuilder

    • hasTimeout

      public 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;
      Specified by:
      hasTimeout in interface RouteActionOrBuilder
      Returns:
      Whether the timeout field is set.

    • getTimeout

      public 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;
      Specified by:
      getTimeout in interface RouteActionOrBuilder
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      public 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;
      Specified by:
      getTimeoutOrBuilder in interface RouteActionOrBuilder

    • hasRetryPolicy

      public 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;
      Specified by:
      hasRetryPolicy in interface RouteActionOrBuilder
      Returns:
      Whether the retryPolicy field is set.

    • getRetryPolicy

      public 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;
      Specified by:
      getRetryPolicy in interface RouteActionOrBuilder
      Returns:
      The retryPolicy.

    • getRetryPolicyOrBuilder

      public 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;
      Specified by:
      getRetryPolicyOrBuilder 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(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