Package com.google.cloud.compute.v1

Class SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

    • Field Detail

      • ENFORCE_ON_KEY_NAME_FIELD_NUMBER

        public static final int ENFORCE_ON_KEY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENFORCE_ON_KEY_TYPE_FIELD_NUMBER

        public static final int ENFORCE_ON_KEY_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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​(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,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

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

      • getDefaultInstanceForType

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