- 1.86.0 (latest)
- 1.85.0
- 1.84.0
- 1.83.0
- 1.82.0
- 1.80.0
- 1.78.0
- 1.77.0
- 1.74.0
- 1.73.0
- 1.72.0
- 1.70.0
- 1.69.0
- 1.68.0
- 1.67.0
- 1.66.0
- 1.65.0
- 1.64.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class SecurityPolicyRuleRateLimitOptions.Builder extends GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptions.Builder> implements SecurityPolicyRuleRateLimitOptionsOrBuilder Protobuf type google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SecurityPolicyRuleRateLimitOptions.BuilderImplements
SecurityPolicyRuleRateLimitOptionsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SecurityPolicyRuleRateLimitOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
build()
public SecurityPolicyRuleRateLimitOptions build()| Type | Description |
| SecurityPolicyRuleRateLimitOptions |
buildPartial()
public SecurityPolicyRuleRateLimitOptions buildPartial()| Type | Description |
| SecurityPolicyRuleRateLimitOptions |
clear()
public SecurityPolicyRuleRateLimitOptions.Builder clear()| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
clearBanDurationSec()
public SecurityPolicyRuleRateLimitOptions.Builder clearBanDurationSec()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 |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
clearBanThreshold()
public SecurityPolicyRuleRateLimitOptions.Builder clearBanThreshold()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 |
| SecurityPolicyRuleRateLimitOptions.Builder |
clearConformAction()
public SecurityPolicyRuleRateLimitOptions.Builder clearConformAction()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 |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
clearEnforceOnKey()
public SecurityPolicyRuleRateLimitOptions.Builder clearEnforceOnKey()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 this field 'enforce_on_key' 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 "enforce_on_key_name". 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 "enforce_on_key_name". 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 |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
clearEnforceOnKeyName()
public SecurityPolicyRuleRateLimitOptions.Builder clearEnforceOnKeyName()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 |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
clearExceedAction()
public SecurityPolicyRuleRateLimitOptions.Builder clearExceedAction()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 |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
clearExceedRedirectOptions()
public SecurityPolicyRuleRateLimitOptions.Builder clearExceedRedirectOptions()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 |
| SecurityPolicyRuleRateLimitOptions.Builder |
clearField(Descriptors.FieldDescriptor field)
public SecurityPolicyRuleRateLimitOptions.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public SecurityPolicyRuleRateLimitOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
clearRateLimitThreshold()
public SecurityPolicyRuleRateLimitOptions.Builder clearRateLimitThreshold()Threshold at which to begin ratelimiting.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
clone()
public SecurityPolicyRuleRateLimitOptions.Builder clone()| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
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;
| Type | Description |
| SecurityPolicyRuleRateLimitOptionsThreshold | The banThreshold. |
getBanThresholdBuilder()
public SecurityPolicyRuleRateLimitOptionsThreshold.Builder getBanThresholdBuilder()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 |
| SecurityPolicyRuleRateLimitOptionsThreshold.Builder |
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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| ByteString | The bytes for conformAction. |
getDefaultInstanceForType()
public SecurityPolicyRuleRateLimitOptions getDefaultInstanceForType()| Type | Description |
| SecurityPolicyRuleRateLimitOptions |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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 this field 'enforce_on_key' 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 "enforce_on_key_name". 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 "enforce_on_key_name". 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 this field 'enforce_on_key' 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 "enforce_on_key_name". 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 "enforce_on_key_name". 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;
| Type | Description |
| SecurityPolicyRuleRedirectOptions | The exceedRedirectOptions. |
getExceedRedirectOptionsBuilder()
public SecurityPolicyRuleRedirectOptions.Builder getExceedRedirectOptionsBuilder()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 |
| SecurityPolicyRuleRedirectOptions.Builder |
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;
| Type | Description |
| SecurityPolicyRuleRedirectOptionsOrBuilder |
getRateLimitThreshold()
public SecurityPolicyRuleRateLimitOptionsThreshold getRateLimitThreshold()Threshold at which to begin ratelimiting.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;
| Type | Description |
| SecurityPolicyRuleRateLimitOptionsThreshold | The rateLimitThreshold. |
getRateLimitThresholdBuilder()
public SecurityPolicyRuleRateLimitOptionsThreshold.Builder getRateLimitThresholdBuilder()Threshold at which to begin ratelimiting.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;
| Type | Description |
| SecurityPolicyRuleRateLimitOptionsThreshold.Builder |
getRateLimitThresholdOrBuilder()
public SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder getRateLimitThresholdOrBuilder()Threshold at which to begin ratelimiting.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;
| Type | Description |
| SecurityPolicyRuleRateLimitOptionsThresholdOrBuilder |
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. |
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;
| 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 this field 'enforce_on_key' 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 "enforce_on_key_name". 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 "enforce_on_key_name". 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)
public SecurityPolicyRuleRateLimitOptions.Builder mergeBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)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;
| Name | Description |
| value | SecurityPolicyRuleRateLimitOptionsThreshold |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
mergeExceedRedirectOptions(SecurityPolicyRuleRedirectOptions value)
public SecurityPolicyRuleRateLimitOptions.Builder mergeExceedRedirectOptions(SecurityPolicyRuleRedirectOptions value)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;
| Name | Description |
| value | SecurityPolicyRuleRedirectOptions |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
mergeFrom(SecurityPolicyRuleRateLimitOptions other)
public SecurityPolicyRuleRateLimitOptions.Builder mergeFrom(SecurityPolicyRuleRateLimitOptions other)| Name | Description |
| other | SecurityPolicyRuleRateLimitOptions |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SecurityPolicyRuleRateLimitOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public SecurityPolicyRuleRateLimitOptions.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
mergeRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)
public SecurityPolicyRuleRateLimitOptions.Builder mergeRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)Threshold at which to begin ratelimiting.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;
| Name | Description |
| value | SecurityPolicyRuleRateLimitOptionsThreshold |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SecurityPolicyRuleRateLimitOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
setBanDurationSec(int value)
public SecurityPolicyRuleRateLimitOptions.Builder setBanDurationSec(int value)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;
| Name | Description |
| value | intThe banDurationSec to set. |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)
public SecurityPolicyRuleRateLimitOptions.Builder setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)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;
| Name | Description |
| value | SecurityPolicyRuleRateLimitOptionsThreshold |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold.Builder builderForValue)
public SecurityPolicyRuleRateLimitOptions.Builder setBanThreshold(SecurityPolicyRuleRateLimitOptionsThreshold.Builder builderForValue)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;
| Name | Description |
| builderForValue | SecurityPolicyRuleRateLimitOptionsThreshold.Builder |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
setConformAction(String value)
public SecurityPolicyRuleRateLimitOptions.Builder setConformAction(String value)Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
optional string conform_action = 517612367;
| Name | Description |
| value | StringThe conformAction to set. |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
setConformActionBytes(ByteString value)
public SecurityPolicyRuleRateLimitOptions.Builder setConformActionBytes(ByteString value)Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
optional string conform_action = 517612367;
| Name | Description |
| value | ByteStringThe bytes for conformAction to set. |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
setEnforceOnKey(String value)
public SecurityPolicyRuleRateLimitOptions.Builder setEnforceOnKey(String value)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 this field 'enforce_on_key' 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 "enforce_on_key_name". 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 "enforce_on_key_name". 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;
| Name | Description |
| value | StringThe enforceOnKey to set. |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
setEnforceOnKeyBytes(ByteString value)
public SecurityPolicyRuleRateLimitOptions.Builder setEnforceOnKeyBytes(ByteString value)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 this field 'enforce_on_key' 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 "enforce_on_key_name". 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 "enforce_on_key_name". 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;
| Name | Description |
| value | ByteStringThe bytes for enforceOnKey to set. |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
setEnforceOnKeyName(String value)
public SecurityPolicyRuleRateLimitOptions.Builder setEnforceOnKeyName(String value)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;
| Name | Description |
| value | StringThe enforceOnKeyName to set. |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
setEnforceOnKeyNameBytes(ByteString value)
public SecurityPolicyRuleRateLimitOptions.Builder setEnforceOnKeyNameBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for enforceOnKeyName to set. |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
setExceedAction(String value)
public SecurityPolicyRuleRateLimitOptions.Builder setExceedAction(String value)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;
| Name | Description |
| value | StringThe exceedAction to set. |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
setExceedActionBytes(ByteString value)
public SecurityPolicyRuleRateLimitOptions.Builder setExceedActionBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for exceedAction to set. |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder | This builder for chaining. |
setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions value)
public SecurityPolicyRuleRateLimitOptions.Builder setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions value)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;
| Name | Description |
| value | SecurityPolicyRuleRedirectOptions |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions.Builder builderForValue)
public SecurityPolicyRuleRateLimitOptions.Builder setExceedRedirectOptions(SecurityPolicyRuleRedirectOptions.Builder builderForValue)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;
| Name | Description |
| builderForValue | SecurityPolicyRuleRedirectOptions.Builder |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public SecurityPolicyRuleRateLimitOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)
public SecurityPolicyRuleRateLimitOptions.Builder setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold value)Threshold at which to begin ratelimiting.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;
| Name | Description |
| value | SecurityPolicyRuleRateLimitOptionsThreshold |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold.Builder builderForValue)
public SecurityPolicyRuleRateLimitOptions.Builder setRateLimitThreshold(SecurityPolicyRuleRateLimitOptionsThreshold.Builder builderForValue)Threshold at which to begin ratelimiting.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsThreshold rate_limit_threshold = 315875208;
| Name | Description |
| builderForValue | SecurityPolicyRuleRateLimitOptionsThreshold.Builder |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SecurityPolicyRuleRateLimitOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final SecurityPolicyRuleRateLimitOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SecurityPolicyRuleRateLimitOptions.Builder |