Class 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.GeneratedMessageV3
    implements RateLimit.ActionOrBuilder
     [#next-free-field: 12]
     
    Protobuf type envoy.config.route.v3.RateLimit.Action
    See Also:
    Serialized Form
    • Field Detail

      • SOURCE_CLUSTER_FIELD_NUMBER

        public static final int SOURCE_CLUSTER_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DESTINATION_CLUSTER_FIELD_NUMBER

        public static final int DESTINATION_CLUSTER_FIELD_NUMBER
        See Also:
        Constant Field Values
      • REQUEST_HEADERS_FIELD_NUMBER

        public static final int REQUEST_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • REMOTE_ADDRESS_FIELD_NUMBER

        public static final int REMOTE_ADDRESS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • GENERIC_KEY_FIELD_NUMBER

        public static final int GENERIC_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • HEADER_VALUE_MATCH_FIELD_NUMBER

        public static final int HEADER_VALUE_MATCH_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DYNAMIC_METADATA_FIELD_NUMBER

        public static final int DYNAMIC_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values
      • MASKED_REMOTE_ADDRESS_FIELD_NUMBER

        public static final int MASKED_REMOTE_ADDRESS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • QUERY_PARAMETER_VALUE_MATCH_FIELD_NUMBER

        public static final int QUERY_PARAMETER_VALUE_MATCH_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
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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=2120
         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=2120
         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.
      • 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.
      • 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.
      • 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 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​(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
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
      • getDefaultInstanceForType

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