Package io.envoyproxy.envoy.config.route.v3

Class RateLimit.Action.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.ActionOrBuilder, Cloneable
    Enclosing class:
    RateLimit.Action
    public static final class RateLimit.Action.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>
implements RateLimit.ActionOrBuilder
     [#next-free-field: 11]
    Protobuf type envoy.config.route.v3.RateLimit.Action

    • Method Detail

      • 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.Builder<RateLimit.Action.Builder>

      • clear

        public RateLimit.Action.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public RateLimit.Action.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>

      • setField

        public RateLimit.Action.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>

      • clearField

        public RateLimit.Action.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>

      • clearOneof

        public RateLimit.Action.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>

      • setRepeatedField

        public RateLimit.Action.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>

      • addRepeatedField

        public RateLimit.Action.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>

      • mergeFrom

        public RateLimit.Action.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimit.Action.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>

      • mergeFrom

        public RateLimit.Action.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimit.Action.Builder>
        Throws:
        IOException

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

      • clearSourceCluster

        public RateLimit.Action.Builder clearSourceCluster()
         Rate limit on source cluster.
        .envoy.config.route.v3.RateLimit.Action.SourceCluster source_cluster = 1;

      • getSourceClusterBuilder

        public RateLimit.Action.SourceCluster.Builder getSourceClusterBuilder()
         Rate limit on source cluster.
        .envoy.config.route.v3.RateLimit.Action.SourceCluster source_cluster = 1;

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

      • clearDestinationCluster

        public RateLimit.Action.Builder clearDestinationCluster()
         Rate limit on destination cluster.
        .envoy.config.route.v3.RateLimit.Action.DestinationCluster destination_cluster = 2;

      • getDestinationClusterBuilder

        public RateLimit.Action.DestinationCluster.Builder getDestinationClusterBuilder()
         Rate limit on destination cluster.
        .envoy.config.route.v3.RateLimit.Action.DestinationCluster destination_cluster = 2;

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

      • clearRequestHeaders

        public RateLimit.Action.Builder clearRequestHeaders()
         Rate limit on request headers.
        .envoy.config.route.v3.RateLimit.Action.RequestHeaders request_headers = 3;

      • getRequestHeadersBuilder

        public RateLimit.Action.RequestHeaders.Builder getRequestHeadersBuilder()
         Rate limit on request headers.
        .envoy.config.route.v3.RateLimit.Action.RequestHeaders request_headers = 3;

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

      • clearRemoteAddress

        public RateLimit.Action.Builder clearRemoteAddress()
         Rate limit on remote address.
        .envoy.config.route.v3.RateLimit.Action.RemoteAddress remote_address = 4;

      • getRemoteAddressBuilder

        public RateLimit.Action.RemoteAddress.Builder getRemoteAddressBuilder()
         Rate limit on remote address.
        .envoy.config.route.v3.RateLimit.Action.RemoteAddress remote_address = 4;

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

      • clearGenericKey

        public RateLimit.Action.Builder clearGenericKey()
         Rate limit on a generic key.
        .envoy.config.route.v3.RateLimit.Action.GenericKey generic_key = 5;

      • getGenericKeyBuilder

        public RateLimit.Action.GenericKey.Builder getGenericKeyBuilder()
         Rate limit on a generic key.
        .envoy.config.route.v3.RateLimit.Action.GenericKey generic_key = 5;

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

      • clearHeaderValueMatch

        public RateLimit.Action.Builder clearHeaderValueMatch()
         Rate limit on the existence of request headers.
        .envoy.config.route.v3.RateLimit.Action.HeaderValueMatch header_value_match = 6;

      • getHeaderValueMatchBuilder

        public RateLimit.Action.HeaderValueMatch.Builder getHeaderValueMatchBuilder()
         Rate limit on the existence of request headers.
        .envoy.config.route.v3.RateLimit.Action.HeaderValueMatch header_value_match = 6;

      • 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=2078
         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=2078
         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.

      • setDynamicMetadata

        @Deprecated
public RateLimit.Action.Builder setDynamicMetadata​(RateLimit.Action.DynamicMetaData value)
        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];

      • setDynamicMetadata

        @Deprecated
public RateLimit.Action.Builder setDynamicMetadata​(RateLimit.Action.DynamicMetaData.Builder builderForValue)
        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];

      • mergeDynamicMetadata

        @Deprecated
public RateLimit.Action.Builder mergeDynamicMetadata​(RateLimit.Action.DynamicMetaData value)
        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];

      • clearDynamicMetadata

        @Deprecated
public RateLimit.Action.Builder clearDynamicMetadata()
        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];

      • getDynamicMetadataBuilder

        @Deprecated
public RateLimit.Action.DynamicMetaData.Builder getDynamicMetadataBuilder()
        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];

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

      • clearMetadata

        public RateLimit.Action.Builder clearMetadata()
         Rate limit on metadata.
        .envoy.config.route.v3.RateLimit.Action.MetaData metadata = 8;

      • getMetadataBuilder

        public RateLimit.Action.MetaData.Builder getMetadataBuilder()
         Rate limit on metadata.
        .envoy.config.route.v3.RateLimit.Action.MetaData metadata = 8;

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

      • setExtension

        public RateLimit.Action.Builder setExtension​(TypedExtensionConfig value)
         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;

      • setExtension

        public RateLimit.Action.Builder setExtension​(TypedExtensionConfig.Builder builderForValue)
         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;

      • mergeExtension

        public RateLimit.Action.Builder mergeExtension​(TypedExtensionConfig value)
         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;

      • clearExtension

        public RateLimit.Action.Builder clearExtension()
         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;

      • getExtensionBuilder

        public TypedExtensionConfig.Builder getExtensionBuilder()
         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;

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

      • clearMaskedRemoteAddress

        public RateLimit.Action.Builder clearMaskedRemoteAddress()
         Rate limit on masked remote address.
        .envoy.config.route.v3.RateLimit.Action.MaskedRemoteAddress masked_remote_address = 10;

      • getMaskedRemoteAddressBuilder

        public RateLimit.Action.MaskedRemoteAddress.Builder getMaskedRemoteAddressBuilder()
         Rate limit on masked remote address.
        .envoy.config.route.v3.RateLimit.Action.MaskedRemoteAddress masked_remote_address = 10;

      • setUnknownFields

        public final RateLimit.Action.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>

      • mergeUnknownFields

        public final RateLimit.Action.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.Builder>