Class RateLimit.Action

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.RateLimit.Action
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.ActionOrBuilder, Serializable
Enclosing class:
RateLimit
public static final class RateLimit.Action extends com.google.protobuf.GeneratedMessage implements RateLimit.ActionOrBuilder
[#next-free-field: 12]
Protobuf type envoy.config.route.v3.RateLimit.Action
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • actionSpecifierCase_

      private int actionSpecifierCase_

    • actionSpecifier_

      private Object actionSpecifier_

    • SOURCE_CLUSTER_FIELD_NUMBER

      public static final int SOURCE_CLUSTER_FIELD_NUMBER
      See Also:

    • DESTINATION_CLUSTER_FIELD_NUMBER

      public static final int DESTINATION_CLUSTER_FIELD_NUMBER
      See Also:

    • REQUEST_HEADERS_FIELD_NUMBER

      public static final int REQUEST_HEADERS_FIELD_NUMBER
      See Also:

    • REMOTE_ADDRESS_FIELD_NUMBER

      public static final int REMOTE_ADDRESS_FIELD_NUMBER
      See Also:

    • GENERIC_KEY_FIELD_NUMBER

      public static final int GENERIC_KEY_FIELD_NUMBER
      See Also:

    • HEADER_VALUE_MATCH_FIELD_NUMBER

      public static final int HEADER_VALUE_MATCH_FIELD_NUMBER
      See Also:

    • DYNAMIC_METADATA_FIELD_NUMBER

      public static final int DYNAMIC_METADATA_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • EXTENSION_FIELD_NUMBER

      public static final int EXTENSION_FIELD_NUMBER
      See Also:

    • MASKED_REMOTE_ADDRESS_FIELD_NUMBER

      public static final int MASKED_REMOTE_ADDRESS_FIELD_NUMBER
      See Also:

    • QUERY_PARAMETER_VALUE_MATCH_FIELD_NUMBER

      public static final int QUERY_PARAMETER_VALUE_MATCH_FIELD_NUMBER
      See Also:

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final RateLimit.Action DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<RateLimit.Action> PARSER

  • Constructor Details

    • Action

      private Action(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • Action

      private Action()

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getActionSpecifierCase

      public RateLimit.Action.ActionSpecifierCase getActionSpecifierCase()
      Specified by:
      getActionSpecifierCase in interface RateLimit.ActionOrBuilder

    • hasSourceCluster

      public boolean hasSourceCluster()
      Rate limit on source cluster.
      .envoy.config.route.v3.RateLimit.Action.SourceCluster source_cluster = 1;
      Specified by:
      hasSourceCluster in interface RateLimit.ActionOrBuilder
      Returns:
      Whether the sourceCluster field is set.

    • getSourceCluster

      public RateLimit.Action.SourceCluster getSourceCluster()
      Rate limit on source cluster.
      .envoy.config.route.v3.RateLimit.Action.SourceCluster source_cluster = 1;
      Specified by:
      getSourceCluster in interface RateLimit.ActionOrBuilder
      Returns:
      The sourceCluster.

    • getSourceClusterOrBuilder

      public RateLimit.Action.SourceClusterOrBuilder getSourceClusterOrBuilder()
      Rate limit on source cluster.
      .envoy.config.route.v3.RateLimit.Action.SourceCluster source_cluster = 1;
      Specified by:
      getSourceClusterOrBuilder in interface RateLimit.ActionOrBuilder

    • hasDestinationCluster

      public boolean hasDestinationCluster()
      Rate limit on destination cluster.
      .envoy.config.route.v3.RateLimit.Action.DestinationCluster destination_cluster = 2;
      Specified by:
      hasDestinationCluster in interface RateLimit.ActionOrBuilder
      Returns:
      Whether the destinationCluster field is set.

    • getDestinationCluster

      public RateLimit.Action.DestinationCluster getDestinationCluster()
      Rate limit on destination cluster.
      .envoy.config.route.v3.RateLimit.Action.DestinationCluster destination_cluster = 2;
      Specified by:
      getDestinationCluster in interface RateLimit.ActionOrBuilder
      Returns:
      The destinationCluster.

    • getDestinationClusterOrBuilder

      public RateLimit.Action.DestinationClusterOrBuilder getDestinationClusterOrBuilder()
      Rate limit on destination cluster.
      .envoy.config.route.v3.RateLimit.Action.DestinationCluster destination_cluster = 2;
      Specified by:
      getDestinationClusterOrBuilder in interface RateLimit.ActionOrBuilder

    • hasRequestHeaders

      public boolean hasRequestHeaders()
      Rate limit on request headers.
      .envoy.config.route.v3.RateLimit.Action.RequestHeaders request_headers = 3;
      Specified by:
      hasRequestHeaders in interface RateLimit.ActionOrBuilder
      Returns:
      Whether the requestHeaders field is set.

    • getRequestHeaders

      public RateLimit.Action.RequestHeaders getRequestHeaders()
      Rate limit on request headers.
      .envoy.config.route.v3.RateLimit.Action.RequestHeaders request_headers = 3;
      Specified by:
      getRequestHeaders in interface RateLimit.ActionOrBuilder
      Returns:
      The requestHeaders.

    • getRequestHeadersOrBuilder

      public RateLimit.Action.RequestHeadersOrBuilder getRequestHeadersOrBuilder()
      Rate limit on request headers.
      .envoy.config.route.v3.RateLimit.Action.RequestHeaders request_headers = 3;
      Specified by:
      getRequestHeadersOrBuilder in interface RateLimit.ActionOrBuilder

    • hasRemoteAddress

      public boolean hasRemoteAddress()
      Rate limit on remote address.
      .envoy.config.route.v3.RateLimit.Action.RemoteAddress remote_address = 4;
      Specified by:
      hasRemoteAddress in interface RateLimit.ActionOrBuilder
      Returns:
      Whether the remoteAddress field is set.

    • getRemoteAddress

      public RateLimit.Action.RemoteAddress getRemoteAddress()
      Rate limit on remote address.
      .envoy.config.route.v3.RateLimit.Action.RemoteAddress remote_address = 4;
      Specified by:
      getRemoteAddress in interface RateLimit.ActionOrBuilder
      Returns:
      The remoteAddress.

    • getRemoteAddressOrBuilder

      public RateLimit.Action.RemoteAddressOrBuilder getRemoteAddressOrBuilder()
      Rate limit on remote address.
      .envoy.config.route.v3.RateLimit.Action.RemoteAddress remote_address = 4;
      Specified by:
      getRemoteAddressOrBuilder in interface RateLimit.ActionOrBuilder

    • hasGenericKey

      public boolean hasGenericKey()
      Rate limit on a generic key.
      .envoy.config.route.v3.RateLimit.Action.GenericKey generic_key = 5;
      Specified by:
      hasGenericKey in interface RateLimit.ActionOrBuilder
      Returns:
      Whether the genericKey field is set.

    • getGenericKey

      public RateLimit.Action.GenericKey getGenericKey()
      Rate limit on a generic key.
      .envoy.config.route.v3.RateLimit.Action.GenericKey generic_key = 5;
      Specified by:
      getGenericKey in interface RateLimit.ActionOrBuilder
      Returns:
      The genericKey.

    • getGenericKeyOrBuilder

      public RateLimit.Action.GenericKeyOrBuilder getGenericKeyOrBuilder()
      Rate limit on a generic key.
      .envoy.config.route.v3.RateLimit.Action.GenericKey generic_key = 5;
      Specified by:
      getGenericKeyOrBuilder in interface RateLimit.ActionOrBuilder

    • hasHeaderValueMatch

      public boolean hasHeaderValueMatch()
      Rate limit on the existence of request headers.
      .envoy.config.route.v3.RateLimit.Action.HeaderValueMatch header_value_match = 6;
      Specified by:
      hasHeaderValueMatch in interface RateLimit.ActionOrBuilder
      Returns:
      Whether the headerValueMatch field is set.

    • getHeaderValueMatch

      public RateLimit.Action.HeaderValueMatch getHeaderValueMatch()
      Rate limit on the existence of request headers.
      .envoy.config.route.v3.RateLimit.Action.HeaderValueMatch header_value_match = 6;
      Specified by:
      getHeaderValueMatch in interface RateLimit.ActionOrBuilder
      Returns:
      The headerValueMatch.

    • getHeaderValueMatchOrBuilder

      public RateLimit.Action.HeaderValueMatchOrBuilder getHeaderValueMatchOrBuilder()
      Rate limit on the existence of request headers.
      .envoy.config.route.v3.RateLimit.Action.HeaderValueMatch header_value_match = 6;
      Specified by:
      getHeaderValueMatchOrBuilder in interface RateLimit.ActionOrBuilder

    • hasDynamicMetadata

      @Deprecated public boolean hasDynamicMetadata()
      Deprecated.
      envoy.config.route.v3.RateLimit.Action.dynamic_metadata is deprecated. See envoy/config/route/v3/route_components.proto;l=2127
      Rate limit on dynamic metadata.

.. attention::
This field has been deprecated in favor of the :ref:`metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.metadata>` field
      .envoy.config.route.v3.RateLimit.Action.DynamicMetaData dynamic_metadata = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0", (.envoy.annotations.disallowed_by_default) = true];
      Specified by:
      hasDynamicMetadata in interface RateLimit.ActionOrBuilder
      Returns:
      Whether the dynamicMetadata field is set.

    • getDynamicMetadata

      @Deprecated public RateLimit.Action.DynamicMetaData getDynamicMetadata()
      Deprecated.
      envoy.config.route.v3.RateLimit.Action.dynamic_metadata is deprecated. See envoy/config/route/v3/route_components.proto;l=2127
      Rate limit on dynamic metadata.

.. attention::
This field has been deprecated in favor of the :ref:`metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.metadata>` field
      .envoy.config.route.v3.RateLimit.Action.DynamicMetaData dynamic_metadata = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0", (.envoy.annotations.disallowed_by_default) = true];
      Specified by:
      getDynamicMetadata in interface RateLimit.ActionOrBuilder
      Returns:
      The dynamicMetadata.

    • getDynamicMetadataOrBuilder

      @Deprecated public RateLimit.Action.DynamicMetaDataOrBuilder getDynamicMetadataOrBuilder()
      Deprecated.
      Rate limit on dynamic metadata.

.. attention::
This field has been deprecated in favor of the :ref:`metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.metadata>` field
      .envoy.config.route.v3.RateLimit.Action.DynamicMetaData dynamic_metadata = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0", (.envoy.annotations.disallowed_by_default) = true];
      Specified by:
      getDynamicMetadataOrBuilder in interface RateLimit.ActionOrBuilder

    • hasMetadata

      public boolean hasMetadata()
      Rate limit on metadata.
      .envoy.config.route.v3.RateLimit.Action.MetaData metadata = 8;
      Specified by:
      hasMetadata in interface RateLimit.ActionOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      public RateLimit.Action.MetaData getMetadata()
      Rate limit on metadata.
      .envoy.config.route.v3.RateLimit.Action.MetaData metadata = 8;
      Specified by:
      getMetadata in interface RateLimit.ActionOrBuilder
      Returns:
      The metadata.

    • getMetadataOrBuilder

      public RateLimit.Action.MetaDataOrBuilder getMetadataOrBuilder()
      Rate limit on metadata.
      .envoy.config.route.v3.RateLimit.Action.MetaData metadata = 8;
      Specified by:
      getMetadataOrBuilder in interface RateLimit.ActionOrBuilder

    • hasExtension

      public boolean hasExtension()
      Rate limit descriptor extension. See the rate limit descriptor extensions documentation.

:ref:`HTTP matching input functions <arch_overview_matching_api>` are
permitted as descriptor extensions. The input functions are only
looked up if there is no rate limit descriptor extension matching
the type URL.

[#extension-category: envoy.rate_limit_descriptors]
      .envoy.config.core.v3.TypedExtensionConfig extension = 9;
      Specified by:
      hasExtension in interface RateLimit.ActionOrBuilder
      Returns:
      Whether the extension field is set.

    • getExtension

      public TypedExtensionConfig getExtension()
      Rate limit descriptor extension. See the rate limit descriptor extensions documentation.

:ref:`HTTP matching input functions <arch_overview_matching_api>` are
permitted as descriptor extensions. The input functions are only
looked up if there is no rate limit descriptor extension matching
the type URL.

[#extension-category: envoy.rate_limit_descriptors]
      .envoy.config.core.v3.TypedExtensionConfig extension = 9;
      Specified by:
      getExtension in interface RateLimit.ActionOrBuilder
      Returns:
      The extension.

    • getExtensionOrBuilder

      public TypedExtensionConfigOrBuilder getExtensionOrBuilder()
      Rate limit descriptor extension. See the rate limit descriptor extensions documentation.

:ref:`HTTP matching input functions <arch_overview_matching_api>` are
permitted as descriptor extensions. The input functions are only
looked up if there is no rate limit descriptor extension matching
the type URL.

[#extension-category: envoy.rate_limit_descriptors]
      .envoy.config.core.v3.TypedExtensionConfig extension = 9;
      Specified by:
      getExtensionOrBuilder in interface RateLimit.ActionOrBuilder

    • hasMaskedRemoteAddress

      public boolean hasMaskedRemoteAddress()
      Rate limit on masked remote address.
      .envoy.config.route.v3.RateLimit.Action.MaskedRemoteAddress masked_remote_address = 10;
      Specified by:
      hasMaskedRemoteAddress in interface RateLimit.ActionOrBuilder
      Returns:
      Whether the maskedRemoteAddress field is set.

    • getMaskedRemoteAddress

      public RateLimit.Action.MaskedRemoteAddress getMaskedRemoteAddress()
      Rate limit on masked remote address.
      .envoy.config.route.v3.RateLimit.Action.MaskedRemoteAddress masked_remote_address = 10;
      Specified by:
      getMaskedRemoteAddress in interface RateLimit.ActionOrBuilder
      Returns:
      The maskedRemoteAddress.

    • getMaskedRemoteAddressOrBuilder

      public RateLimit.Action.MaskedRemoteAddressOrBuilder getMaskedRemoteAddressOrBuilder()
      Rate limit on masked remote address.
      .envoy.config.route.v3.RateLimit.Action.MaskedRemoteAddress masked_remote_address = 10;
      Specified by:
      getMaskedRemoteAddressOrBuilder in interface RateLimit.ActionOrBuilder

    • hasQueryParameterValueMatch

      public boolean hasQueryParameterValueMatch()
      Rate limit on the existence of query parameters.
      .envoy.config.route.v3.RateLimit.Action.QueryParameterValueMatch query_parameter_value_match = 11;
      Specified by:
      hasQueryParameterValueMatch in interface RateLimit.ActionOrBuilder
      Returns:
      Whether the queryParameterValueMatch field is set.

    • getQueryParameterValueMatch

      public RateLimit.Action.QueryParameterValueMatch getQueryParameterValueMatch()
      Rate limit on the existence of query parameters.
      .envoy.config.route.v3.RateLimit.Action.QueryParameterValueMatch query_parameter_value_match = 11;
      Specified by:
      getQueryParameterValueMatch in interface RateLimit.ActionOrBuilder
      Returns:
      The queryParameterValueMatch.

    • getQueryParameterValueMatchOrBuilder

      public RateLimit.Action.QueryParameterValueMatchOrBuilder getQueryParameterValueMatchOrBuilder()
      Rate limit on the existence of query parameters.
      .envoy.config.route.v3.RateLimit.Action.QueryParameterValueMatch query_parameter_value_match = 11;
      Specified by:
      getQueryParameterValueMatchOrBuilder in interface RateLimit.ActionOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RateLimit.Action parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static RateLimit.Action parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RateLimit.Action.Builder newBuilder()

    • newBuilder

      public static RateLimit.Action.Builder newBuilder(RateLimit.Action prototype)

    • toBuilder

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

    • newBuilderForType

      protected RateLimit.Action.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RateLimit.Action getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RateLimit.Action> 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.GeneratedMessage

    • getDefaultInstanceForType

      public RateLimit.Action getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder