public final class SecurityPolicyRuleRateLimitOptions extends GeneratedMessageV3 implements SecurityPolicyRuleRateLimitOptionsOrBuilder
Protobuf type google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions
Static Fields
BAN_DURATION_SEC_FIELD_NUMBER
public static final int BAN_DURATION_SEC_FIELD_NUMBER
Field Value
BAN_THRESHOLD_FIELD_NUMBER
public static final int BAN_THRESHOLD_FIELD_NUMBER
Field Value
public static final int CONFORM_ACTION_FIELD_NUMBER
Field Value
ENFORCE_ON_KEY_FIELD_NUMBER
public static final int ENFORCE_ON_KEY_FIELD_NUMBER
Field Value
ENFORCE_ON_KEY_NAME_FIELD_NUMBER
public static final int ENFORCE_ON_KEY_NAME_FIELD_NUMBER
Field Value
EXCEED_ACTION_FIELD_NUMBER
public static final int EXCEED_ACTION_FIELD_NUMBER
Field Value
EXCEED_REDIRECT_OPTIONS_FIELD_NUMBER
public static final int EXCEED_REDIRECT_OPTIONS_FIELD_NUMBER
Field Value
RATE_LIMIT_THRESHOLD_FIELD_NUMBER
public static final int RATE_LIMIT_THRESHOLD_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SecurityPolicyRuleRateLimitOptions getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SecurityPolicyRuleRateLimitOptions.Builder newBuilder()
Returns
newBuilder(SecurityPolicyRuleRateLimitOptions prototype)
public static SecurityPolicyRuleRateLimitOptions.Builder newBuilder(SecurityPolicyRuleRateLimitOptions prototype)
Parameter
Returns
public static SecurityPolicyRuleRateLimitOptions parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SecurityPolicyRuleRateLimitOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SecurityPolicyRuleRateLimitOptions parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicyRuleRateLimitOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SecurityPolicyRuleRateLimitOptions parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicyRuleRateLimitOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SecurityPolicyRuleRateLimitOptions parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SecurityPolicyRuleRateLimitOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SecurityPolicyRuleRateLimitOptions parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SecurityPolicyRuleRateLimitOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SecurityPolicyRuleRateLimitOptions parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicyRuleRateLimitOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SecurityPolicyRuleRateLimitOptions> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
| Type | Description |
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;
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;
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;
| Type | Description |
String | The conformAction.
|
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;
| Type | Description |
ByteString | The bytes for conformAction.
|
getDefaultInstanceForType()
public SecurityPolicyRuleRateLimitOptions getDefaultInstanceForType()
Returns
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;
| Type | Description |
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;
| Type | Description |
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;
| Type | Description |
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;
| Type | Description |
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;
| Type | Description |
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;
| Type | Description |
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;
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;
getParserForType()
public Parser<SecurityPolicyRuleRateLimitOptions> getParserForType()
Returns
Overrides
getRateLimitThreshold()
public SecurityPolicyRuleRateLimitOptionsThreshold getRateLimitThreshold()
Threshold at which to begin ratelimiting.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;
getRateLimitThresholdOrBuilder()
public SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder getRateLimitThresholdOrBuilder()
Threshold at which to begin ratelimiting.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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;
| Type | Description |
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;
| Type | Description |
boolean | Whether the banThreshold field is set.
|
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;
| Type | Description |
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;
| Type | Description |
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;
| Type | Description |
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;
| Type | Description |
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;
| Type | Description |
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;
| Type | Description |
boolean | Whether the rateLimitThreshold field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SecurityPolicyRuleRateLimitOptions.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SecurityPolicyRuleRateLimitOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SecurityPolicyRuleRateLimitOptions.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
