Package com.google.cloud.compute.v1

Class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder>
com.google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder
All Implemented Interfaces:
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
public static final class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder> implements SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder
Protobuf type google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder>

    • clear

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

    • getDescriptorForType

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder mergeFrom(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig other)

    • isInitialized

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

    • mergeFrom

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

    • 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;
      Specified by:
      hasEnforceOnKeyName in interface SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder
      Returns:
      Whether the enforceOnKeyName field is set.

    • 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;
      Specified by:
      getEnforceOnKeyName in interface SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder
      Returns:
      The enforceOnKeyName.

    • getEnforceOnKeyNameBytes

      public com.google.protobuf.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;
      Specified by:
      getEnforceOnKeyNameBytes in interface SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder
      Returns:
      The bytes for enforceOnKeyName.

    • setEnforceOnKeyName

      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;
      Parameters:
      value - The enforceOnKeyName to set.
      Returns:
      This builder for chaining.

    • 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;
      Returns:
      This builder for chaining.

    • setEnforceOnKeyNameBytes

      public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder setEnforceOnKeyNameBytes(com.google.protobuf.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;
      Parameters:
      value - The bytes for enforceOnKeyName to set.
      Returns:
      This builder for chaining.

    • 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 toALL.
 - 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 toALL.
 - 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.
 - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 - USER_IP: The IP address of the originating client,
 which is resolved based on "userIpRequestHeaders" configured with the
 security policy. If there is no "userIpRequestHeaders" configuration
 or an IP address cannot be resolved from it, the key type defaults toIP.

 - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 Check the EnforceOnKeyType enum for the list of possible values.
      optional string enforce_on_key_type = 132757149;
      Specified by:
      hasEnforceOnKeyType in interface SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder
      Returns:
      Whether the enforceOnKeyType field is set.

    • 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 toALL.
 - 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 toALL.
 - 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.
 - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 - USER_IP: The IP address of the originating client,
 which is resolved based on "userIpRequestHeaders" configured with the
 security policy. If there is no "userIpRequestHeaders" configuration
 or an IP address cannot be resolved from it, the key type defaults toIP.

 - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 Check the EnforceOnKeyType enum for the list of possible values.
      optional string enforce_on_key_type = 132757149;
      Specified by:
      getEnforceOnKeyType in interface SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder
      Returns:
      The enforceOnKeyType.

    • getEnforceOnKeyTypeBytes

      public com.google.protobuf.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 toALL.
 - 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 toALL.
 - 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.
 - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 - USER_IP: The IP address of the originating client,
 which is resolved based on "userIpRequestHeaders" configured with the
 security policy. If there is no "userIpRequestHeaders" configuration
 or an IP address cannot be resolved from it, the key type defaults toIP.

 - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 Check the EnforceOnKeyType enum for the list of possible values.
      optional string enforce_on_key_type = 132757149;
      Specified by:
      getEnforceOnKeyTypeBytes in interface SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder
      Returns:
      The bytes for enforceOnKeyType.

    • setEnforceOnKeyType

      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 toALL.
 - 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 toALL.
 - 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.
 - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 - USER_IP: The IP address of the originating client,
 which is resolved based on "userIpRequestHeaders" configured with the
 security policy. If there is no "userIpRequestHeaders" configuration
 or an IP address cannot be resolved from it, the key type defaults toIP.

 - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 Check the EnforceOnKeyType enum for the list of possible values.
      optional string enforce_on_key_type = 132757149;
      Parameters:
      value - The enforceOnKeyType to set.
      Returns:
      This builder for chaining.

    • 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 toALL.
 - 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 toALL.
 - 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.
 - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 - USER_IP: The IP address of the originating client,
 which is resolved based on "userIpRequestHeaders" configured with the
 security policy. If there is no "userIpRequestHeaders" configuration
 or an IP address cannot be resolved from it, the key type defaults toIP.

 - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 Check the EnforceOnKeyType enum for the list of possible values.
      optional string enforce_on_key_type = 132757149;
      Returns:
      This builder for chaining.

    • setEnforceOnKeyTypeBytes

      public SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder setEnforceOnKeyTypeBytes(com.google.protobuf.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 toALL.
 - 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 toALL.
 - 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.
 - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 - USER_IP: The IP address of the originating client,
 which is resolved based on "userIpRequestHeaders" configured with the
 security policy. If there is no "userIpRequestHeaders" configuration
 or an IP address cannot be resolved from it, the key type defaults toIP.

 - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the
 client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the
 key type defaults to ALL.
 Check the EnforceOnKeyType enum for the list of possible values.
      optional string enforce_on_key_type = 132757149;
      Parameters:
      value - The bytes for enforceOnKeyType to set.
      Returns:
      This builder for chaining.