Class SecurityPolicyRuleRateLimitOptions (1.29.0)

public final class SecurityPolicyRuleRateLimitOptions extends GeneratedMessageV3 implements SecurityPolicyRuleRateLimitOptionsOrBuilder

Protobuf type google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SecurityPolicyRuleRateLimitOptions

Static Fields

BAN_DURATION_SEC_FIELD_NUMBER

public static final int BAN_DURATION_SEC_FIELD_NUMBER
Field Value
TypeDescription
int

BAN_THRESHOLD_FIELD_NUMBER

public static final int BAN_THRESHOLD_FIELD_NUMBER
Field Value
TypeDescription
int

CONFORM_ACTION_FIELD_NUMBER

public static final int CONFORM_ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

ENFORCE_ON_KEY_FIELD_NUMBER

public static final int ENFORCE_ON_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

ENFORCE_ON_KEY_NAME_FIELD_NUMBER

public static final int ENFORCE_ON_KEY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

EXCEED_ACTION_FIELD_NUMBER

public static final int EXCEED_ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

EXCEED_REDIRECT_OPTIONS_FIELD_NUMBER

public static final int EXCEED_REDIRECT_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

RATE_LIMIT_THRESHOLD_FIELD_NUMBER

public static final int RATE_LIMIT_THRESHOLD_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SecurityPolicyRuleRateLimitOptions getDefaultInstance()
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SecurityPolicyRuleRateLimitOptions.Builder newBuilder()
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions.Builder

newBuilder(SecurityPolicyRuleRateLimitOptions prototype)

public static SecurityPolicyRuleRateLimitOptions.Builder newBuilder(SecurityPolicyRuleRateLimitOptions prototype)
Parameter
NameDescription
prototypeSecurityPolicyRuleRateLimitOptions
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions.Builder

parseDelimitedFrom(InputStream input)

public static SecurityPolicyRuleRateLimitOptions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SecurityPolicyRuleRateLimitOptions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecurityPolicyRuleRateLimitOptions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecurityPolicyRuleRateLimitOptions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SecurityPolicyRuleRateLimitOptions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SecurityPolicyRuleRateLimitOptions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleRateLimitOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SecurityPolicyRuleRateLimitOptions> parser()
Returns
TypeDescription
Parser<SecurityPolicyRuleRateLimitOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBanDurationSec()

public int getBanDurationSec()

Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.

optional int32 ban_duration_sec = 42896726;

Returns
TypeDescription
int

The banDurationSec.

getBanThreshold()

public SecurityPolicyRuleRateLimitOptionsThreshold getBanThreshold()

Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold ban_threshold = 501208123;

Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsThreshold

The banThreshold.

getBanThresholdOrBuilder()

public SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder getBanThresholdOrBuilder()

Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold ban_threshold = 501208123;

Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder

getConformAction()

public String getConformAction()

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

optional string conform_action = 517612367;

Returns
TypeDescription
String

The conformAction.

getConformActionBytes()

public ByteString getConformActionBytes()

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

optional string conform_action = 517612367;

Returns
TypeDescription
ByteString

The bytes for conformAction.

getDefaultInstanceForType()

public SecurityPolicyRuleRateLimitOptions getDefaultInstanceForType()
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions

getEnforceOnKey()

public String getEnforceOnKey()

Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. Check the EnforceOnKey enum for the list of possible values.

optional string enforce_on_key = 416648956;

Returns
TypeDescription
String

The enforceOnKey.

getEnforceOnKeyBytes()

public ByteString getEnforceOnKeyBytes()

Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. Check the EnforceOnKey enum for the list of possible values.

optional string enforce_on_key = 416648956;

Returns
TypeDescription
ByteString

The bytes for enforceOnKey.

getEnforceOnKeyName()

public String getEnforceOnKeyName()

Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.

optional string enforce_on_key_name = 132555246;

Returns
TypeDescription
String

The enforceOnKeyName.

getEnforceOnKeyNameBytes()

public ByteString getEnforceOnKeyNameBytes()

Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.

optional string enforce_on_key_name = 132555246;

Returns
TypeDescription
ByteString

The bytes for enforceOnKeyName.

getExceedAction()

public String getExceedAction()

Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are deny(STATUS), where valid values for STATUS are 403, 404, 429, and 502, and redirect, where the redirect parameters come from exceedRedirectOptions below.

optional string exceed_action = 167159073;

Returns
TypeDescription
String

The exceedAction.

getExceedActionBytes()

public ByteString getExceedActionBytes()

Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are deny(STATUS), where valid values for STATUS are 403, 404, 429, and 502, and redirect, where the redirect parameters come from exceedRedirectOptions below.

optional string exceed_action = 167159073;

Returns
TypeDescription
ByteString

The bytes for exceedAction.

getExceedRedirectOptions()

public SecurityPolicyRuleRedirectOptions getExceedRedirectOptions()

Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect.

optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions exceed_redirect_options = 473646694;

Returns
TypeDescription
SecurityPolicyRuleRedirectOptions

The exceedRedirectOptions.

getExceedRedirectOptionsOrBuilder()

public SecurityPolicyRuleRedirectOptionsOrBuilder getExceedRedirectOptionsOrBuilder()

Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect.

optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions exceed_redirect_options = 473646694;

Returns
TypeDescription
SecurityPolicyRuleRedirectOptionsOrBuilder

getParserForType()

public Parser<SecurityPolicyRuleRateLimitOptions> getParserForType()
Returns
TypeDescription
Parser<SecurityPolicyRuleRateLimitOptions>
Overrides

getRateLimitThreshold()

public SecurityPolicyRuleRateLimitOptionsThreshold getRateLimitThreshold()

Threshold at which to begin ratelimiting.

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;

Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsThreshold

The rateLimitThreshold.

getRateLimitThresholdOrBuilder()

public SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder getRateLimitThresholdOrBuilder()

Threshold at which to begin ratelimiting.

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;

Returns
TypeDescription
SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasBanDurationSec()

public boolean hasBanDurationSec()

Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.

optional int32 ban_duration_sec = 42896726;

Returns
TypeDescription
boolean

Whether the banDurationSec field is set.

hasBanThreshold()

public boolean hasBanThreshold()

Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold ban_threshold = 501208123;

Returns
TypeDescription
boolean

Whether the banThreshold field is set.

hasConformAction()

public boolean hasConformAction()

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

optional string conform_action = 517612367;

Returns
TypeDescription
boolean

Whether the conformAction field is set.

hasEnforceOnKey()

public boolean hasEnforceOnKey()

Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. Check the EnforceOnKey enum for the list of possible values.

optional string enforce_on_key = 416648956;

Returns
TypeDescription
boolean

Whether the enforceOnKey field is set.

hasEnforceOnKeyName()

public boolean hasEnforceOnKeyName()

Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.

optional string enforce_on_key_name = 132555246;

Returns
TypeDescription
boolean

Whether the enforceOnKeyName field is set.

hasExceedAction()

public boolean hasExceedAction()

Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are deny(STATUS), where valid values for STATUS are 403, 404, 429, and 502, and redirect, where the redirect parameters come from exceedRedirectOptions below.

optional string exceed_action = 167159073;

Returns
TypeDescription
boolean

Whether the exceedAction field is set.

hasExceedRedirectOptions()

public boolean hasExceedRedirectOptions()

Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect.

optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions exceed_redirect_options = 473646694;

Returns
TypeDescription
boolean

Whether the exceedRedirectOptions field is set.

hasRateLimitThreshold()

public boolean hasRateLimitThreshold()

Threshold at which to begin ratelimiting.

optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;

Returns
TypeDescription
boolean

Whether the rateLimitThreshold field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SecurityPolicyRuleRateLimitOptions.Builder newBuilderForType()
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecurityPolicyRuleRateLimitOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SecurityPolicyRuleRateLimitOptions.Builder toBuilder()
Returns
TypeDescription
SecurityPolicyRuleRateLimitOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException