Class protos.google.cloud.recaptchaenterprise.v1.FirewallAction (5.5.0)

Represents a FirewallAction.

Package

@google-cloud/recaptcha-enterprise

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.recaptchaenterprise.v1.IFirewallAction);

Constructs a new FirewallAction.

Parameter
Name Description
properties IFirewallAction

Properties to set

Properties

allow

public allow?: (google.cloud.recaptchaenterprise.v1.FirewallAction.IAllowAction|null);

FirewallAction allow.

block

public block?: (google.cloud.recaptchaenterprise.v1.FirewallAction.IBlockAction|null);

FirewallAction block.

firewallActionOneof

public firewallActionOneof?: ("allow"|"block"|"includeRecaptchaScript"|"redirect"|"substitute"|"setHeader");

FirewallAction firewallActionOneof.

includeRecaptchaScript

public includeRecaptchaScript?: (google.cloud.recaptchaenterprise.v1.FirewallAction.IIncludeRecaptchaScriptAction|null);

FirewallAction includeRecaptchaScript.

redirect

public redirect?: (google.cloud.recaptchaenterprise.v1.FirewallAction.IRedirectAction|null);

FirewallAction redirect.

setHeader

public setHeader?: (google.cloud.recaptchaenterprise.v1.FirewallAction.ISetHeaderAction|null);

FirewallAction setHeader.

substitute

public substitute?: (google.cloud.recaptchaenterprise.v1.FirewallAction.ISubstituteAction|null);

FirewallAction substitute.

Methods

create(properties)

public static create(properties?: google.cloud.recaptchaenterprise.v1.IFirewallAction): google.cloud.recaptchaenterprise.v1.FirewallAction;

Creates a new FirewallAction instance using the specified properties.

Parameter
Name Description
properties IFirewallAction

Properties to set

Returns
Type Description
FirewallAction

FirewallAction instance

decode(reader, length)

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

Decodes a FirewallAction 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
FirewallAction

FirewallAction

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
FirewallAction

FirewallAction

encode(message, writer)

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

Encodes the specified FirewallAction message. Does not implicitly messages.

Parameters
Name Description
message IFirewallAction

FirewallAction 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.recaptchaenterprise.v1.IFirewallAction, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IFirewallAction

FirewallAction 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.recaptchaenterprise.v1.FirewallAction;

Creates a FirewallAction 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
FirewallAction

FirewallAction

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FirewallAction

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 FirewallAction to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message FirewallAction

FirewallAction

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 FirewallAction 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