public static final class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder extends GeneratedMessageV3.Builder<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder> implements SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder
Protobuf type
google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig build()
buildPartial()
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig buildPartial()
clear()
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder clear()
Overrides
clearEnforceOnKeyName()
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.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;
clearEnforceOnKeyType()
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder clearEnforceOnKeyType()
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 "enforceOnKeyConfigs" 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 EnforceOnKeyType enum for the list of possible values.
optional string enforce_on_key_type = 132757149;
clearField(Descriptors.FieldDescriptor field)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder clone()
Overrides
getDefaultInstanceForType()
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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 |
|---|
| 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for enforceOnKeyName.
|
getEnforceOnKeyType()
public String getEnforceOnKeyType()
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 "enforceOnKeyConfigs" 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 EnforceOnKeyType enum for the list of possible values.
optional string enforce_on_key_type = 132757149;
| Returns |
|---|
| Type | Description |
String | The enforceOnKeyType.
|
getEnforceOnKeyTypeBytes()
public ByteString getEnforceOnKeyTypeBytes()
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 "enforceOnKeyConfigs" 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 EnforceOnKeyType enum for the list of possible values.
optional string enforce_on_key_type = 132757149;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for enforceOnKeyType.
|
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 |
|---|
| Type | Description |
boolean | Whether the enforceOnKeyName field is set.
|
hasEnforceOnKeyType()
public boolean hasEnforceOnKeyType()
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 "enforceOnKeyConfigs" 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 EnforceOnKeyType enum for the list of possible values.
optional string enforce_on_key_type = 132757149;
| Returns |
|---|
| Type | Description |
boolean | Whether the enforceOnKeyType field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig other)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder mergeFrom(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig other)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setEnforceOnKeyName(String value)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.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;
| Parameter |
|---|
| Name | Description |
value | String
The enforceOnKeyName to set.
|
setEnforceOnKeyNameBytes(ByteString value)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.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;
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for enforceOnKeyName to set.
|
setEnforceOnKeyType(String value)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder setEnforceOnKeyType(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 "enforceOnKeyConfigs" 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 EnforceOnKeyType enum for the list of possible values.
optional string enforce_on_key_type = 132757149;
| Parameter |
|---|
| Name | Description |
value | String
The enforceOnKeyType to set.
|
setEnforceOnKeyTypeBytes(ByteString value)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder setEnforceOnKeyTypeBytes(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 "enforceOnKeyConfigs" 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 EnforceOnKeyType enum for the list of possible values.
optional string enforce_on_key_type = 132757149;
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for enforceOnKeyType to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
