Package com.google.cloud.compute.v1

Interface SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig, SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder
@Generated public interface SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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.
    String
    getEnforceOnKeyType()
    Determines the key to enforce the rate_limit_threshold on.
    com.google.protobuf.ByteString
    getEnforceOnKeyTypeBytes()
    Determines the key to enforce the rate_limit_threshold on.
    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.
    boolean
    hasEnforceOnKeyType()
    Determines the key to enforce the rate_limit_threshold on.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasEnforceOnKeyName

      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:
      Whether the enforceOnKeyName field is set.

    • getEnforceOnKeyName

      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:
      The enforceOnKeyName.

    • getEnforceOnKeyNameBytes

      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;
      Returns:
      The bytes for enforceOnKeyName.

    • hasEnforceOnKeyType

      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;
      Returns:
      Whether the enforceOnKeyType field is set.

    • getEnforceOnKeyType

      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;
      Returns:
      The enforceOnKeyType.

    • getEnforceOnKeyTypeBytes

      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;
      Returns:
      The bytes for enforceOnKeyType.