Package com.google.cloud.compute.v1

Class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
All Implemented Interfaces:
SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig extends com.google.protobuf.GeneratedMessage implements SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigOrBuilder
Protobuf type google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
See Also:

  • Field Details

    • ENFORCE_ON_KEY_NAME_FIELD_NUMBER

      public static final int ENFORCE_ON_KEY_NAME_FIELD_NUMBER
      See Also:

    • ENFORCE_ON_KEY_TYPE_FIELD_NUMBER

      public static final int ENFORCE_ON_KEY_TYPE_FIELD_NUMBER
      See Also:

  • 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

    • 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.

    • 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.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilder()

    • newBuilder

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilder(SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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