Class protos.google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions (4.3.0)

Represents a SecurityPolicyRuleRateLimitOptions.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.ISecurityPolicyRuleRateLimitOptions);

Constructs a new SecurityPolicyRuleRateLimitOptions.

Parameter
Name	Description
`properties`	`ISecurityPolicyRuleRateLimitOptions` Properties to set

Properties

_banDurationSec

public _banDurationSec?: "banDurationSec";

SecurityPolicyRuleRateLimitOptions _banDurationSec.

_banThreshold

public _banThreshold?: "banThreshold";

SecurityPolicyRuleRateLimitOptions _banThreshold.

_conformAction

public _conformAction?: "conformAction";

SecurityPolicyRuleRateLimitOptions _conformAction.

_enforceOnKey

public _enforceOnKey?: "enforceOnKey";

SecurityPolicyRuleRateLimitOptions _enforceOnKey.

_enforceOnKeyName

public _enforceOnKeyName?: "enforceOnKeyName";

SecurityPolicyRuleRateLimitOptions _enforceOnKeyName.

_exceedAction

public _exceedAction?: "exceedAction";

SecurityPolicyRuleRateLimitOptions _exceedAction.

_exceedRedirectOptions

public _exceedRedirectOptions?: "exceedRedirectOptions";

SecurityPolicyRuleRateLimitOptions _exceedRedirectOptions.

_rateLimitThreshold

public _rateLimitThreshold?: "rateLimitThreshold";

SecurityPolicyRuleRateLimitOptions _rateLimitThreshold.

banDurationSec

public banDurationSec?: (number|null);

SecurityPolicyRuleRateLimitOptions banDurationSec.

banThreshold

public banThreshold?: (google.cloud.compute.v1.ISecurityPolicyRuleRateLimitOptionsThreshold|null);

SecurityPolicyRuleRateLimitOptions banThreshold.

conformAction

public conformAction?: (string|null);

SecurityPolicyRuleRateLimitOptions conformAction.

enforceOnKey

public enforceOnKey?: (string|null);

SecurityPolicyRuleRateLimitOptions enforceOnKey.

enforceOnKeyConfigs

public enforceOnKeyConfigs: google.cloud.compute.v1.ISecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig[];

SecurityPolicyRuleRateLimitOptions enforceOnKeyConfigs.

enforceOnKeyName

public enforceOnKeyName?: (string|null);

SecurityPolicyRuleRateLimitOptions enforceOnKeyName.

exceedAction

public exceedAction?: (string|null);

SecurityPolicyRuleRateLimitOptions exceedAction.

exceedRedirectOptions

public exceedRedirectOptions?: (google.cloud.compute.v1.ISecurityPolicyRuleRedirectOptions|null);

SecurityPolicyRuleRateLimitOptions exceedRedirectOptions.

rateLimitThreshold

public rateLimitThreshold?: (google.cloud.compute.v1.ISecurityPolicyRuleRateLimitOptionsThreshold|null);

SecurityPolicyRuleRateLimitOptions rateLimitThreshold.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.ISecurityPolicyRuleRateLimitOptions): google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions;

Creates a new SecurityPolicyRuleRateLimitOptions instance using the specified properties.

Parameter
Name	Description
`properties`	`ISecurityPolicyRuleRateLimitOptions` Properties to set

Returns
Type	Description
`SecurityPolicyRuleRateLimitOptions`	SecurityPolicyRuleRateLimitOptions instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions;

Decodes a SecurityPolicyRuleRateLimitOptions message from the specified reader or buffer.

Parameters
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`SecurityPolicyRuleRateLimitOptions`	SecurityPolicyRuleRateLimitOptions

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions;

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`SecurityPolicyRuleRateLimitOptions`	SecurityPolicyRuleRateLimitOptions

encode(message, writer)

public static encode(message: google.cloud.compute.v1.ISecurityPolicyRuleRateLimitOptions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SecurityPolicyRuleRateLimitOptions message. Does not implicitly messages.

Parameters
Name	Description
`message`	`ISecurityPolicyRuleRateLimitOptions` SecurityPolicyRuleRateLimitOptions message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.compute.v1.ISecurityPolicyRuleRateLimitOptions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`ISecurityPolicyRuleRateLimitOptions` SecurityPolicyRuleRateLimitOptions message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions;

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

Parameter
Name	Description
`object`	`{ [k: string]: any }` Plain object

Returns
Type	Description
`SecurityPolicyRuleRateLimitOptions`	SecurityPolicyRuleRateLimitOptions

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for SecurityPolicyRuleRateLimitOptions

Parameter
Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type	Description
`string`	The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this SecurityPolicyRuleRateLimitOptions to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name	Description
`message`	`SecurityPolicyRuleRateLimitOptions` SecurityPolicyRuleRateLimitOptions
`options`	`$protobuf.IConversionOptions` Conversion options

Returns
Type	Description
`{ [k: string]: any }`	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a SecurityPolicyRuleRateLimitOptions message.

Parameter
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not