SecurityPolicyRuleRateLimitOptions

google.cloud.compute.v1. SecurityPolicyRuleRateLimitOptions

Represents a SecurityPolicyRuleRateLimitOptions.

Constructor

new SecurityPolicyRuleRateLimitOptions(propertiesopt)

Constructs a new SecurityPolicyRuleRateLimitOptions.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.ISecurityPolicyRuleRateLimitOptions <optional>

Properties to set

Implements:
  • ISecurityPolicyRuleRateLimitOptions

Members

_banDurationSec

SecurityPolicyRuleRateLimitOptions _banDurationSec.

_banThreshold

SecurityPolicyRuleRateLimitOptions _banThreshold.

_conformAction

SecurityPolicyRuleRateLimitOptions _conformAction.

_enforceOnKey

SecurityPolicyRuleRateLimitOptions _enforceOnKey.

_enforceOnKeyName

SecurityPolicyRuleRateLimitOptions _enforceOnKeyName.

_exceedAction

SecurityPolicyRuleRateLimitOptions _exceedAction.

_exceedRedirectOptions

SecurityPolicyRuleRateLimitOptions _exceedRedirectOptions.

_rateLimitThreshold

SecurityPolicyRuleRateLimitOptions _rateLimitThreshold.

banDurationSec

SecurityPolicyRuleRateLimitOptions banDurationSec.

banThreshold

SecurityPolicyRuleRateLimitOptions banThreshold.

conformAction

SecurityPolicyRuleRateLimitOptions conformAction.

enforceOnKey

SecurityPolicyRuleRateLimitOptions enforceOnKey.

enforceOnKeyName

SecurityPolicyRuleRateLimitOptions enforceOnKeyName.

exceedAction

SecurityPolicyRuleRateLimitOptions exceedAction.

exceedRedirectOptions

SecurityPolicyRuleRateLimitOptions exceedRedirectOptions.

rateLimitThreshold

SecurityPolicyRuleRateLimitOptions rateLimitThreshold.

EnforceOnKey

EnforceOnKey enum.

Properties:
Name Type Description
UNDEFINED_ENFORCE_ON_KEY number

UNDEFINED_ENFORCE_ON_KEY value

ALL number

ALL value

HTTP_COOKIE number

HTTP_COOKIE value

HTTP_HEADER number

HTTP_HEADER value

HTTP_PATH number

HTTP_PATH value

IP number

IP value

REGION_CODE number

REGION_CODE value

SNI number

SNI value

XFF_IP number

XFF_IP value

Methods

toJSON() → {Object.<string, *>}

Converts this SecurityPolicyRuleRateLimitOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions}

Creates a new SecurityPolicyRuleRateLimitOptions instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.ISecurityPolicyRuleRateLimitOptions <optional>

Properties to set

Returns:
Type Description
google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions

SecurityPolicyRuleRateLimitOptions instance

(static) decode(reader, lengthopt) → {google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions}

Decodes a SecurityPolicyRuleRateLimitOptions message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions

SecurityPolicyRuleRateLimitOptions

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions}

Decodes a SecurityPolicyRuleRateLimitOptions message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions

SecurityPolicyRuleRateLimitOptions

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified SecurityPolicyRuleRateLimitOptions message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.ISecurityPolicyRuleRateLimitOptions

SecurityPolicyRuleRateLimitOptions message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified SecurityPolicyRuleRateLimitOptions message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.ISecurityPolicyRuleRateLimitOptions

SecurityPolicyRuleRateLimitOptions message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions}

Creates a SecurityPolicyRuleRateLimitOptions message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions

SecurityPolicyRuleRateLimitOptions

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for SecurityPolicyRuleRateLimitOptions

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a SecurityPolicyRuleRateLimitOptions message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions

SecurityPolicyRuleRateLimitOptions

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a SecurityPolicyRuleRateLimitOptions message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not