Class protos.google.cloud.recaptchaenterprise.v1.FirewallPolicy (6.2.0)

Represents a FirewallPolicy.

Package

@google-cloud/recaptcha-enterprise

Constructors

(constructor)(properties)

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

Constructs a new FirewallPolicy.

Parameter
Name Description
properties IFirewallPolicy

Properties to set

Properties

actions

public actions: google.cloud.recaptchaenterprise.v1.IFirewallAction[];

FirewallPolicy actions.

condition

public condition: string;

FirewallPolicy condition.

description

public description: string;

FirewallPolicy description.

name

public name: string;

FirewallPolicy name.

path

public path: string;

FirewallPolicy path.

Methods

create(properties)

public static create(properties?: google.cloud.recaptchaenterprise.v1.IFirewallPolicy): google.cloud.recaptchaenterprise.v1.FirewallPolicy;

Creates a new FirewallPolicy instance using the specified properties.

Parameter
Name Description
properties IFirewallPolicy

Properties to set
Returns
Type Description
FirewallPolicy

FirewallPolicy instance

decode(reader, length)

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

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

FirewallPolicy

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
FirewallPolicy

FirewallPolicy

encode(message, writer)

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

Encodes the specified FirewallPolicy message. Does not implicitly messages.

Parameters
Name Description
message IFirewallPolicy

FirewallPolicy 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.IFirewallPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IFirewallPolicy

FirewallPolicy 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.FirewallPolicy;

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

FirewallPolicy

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FirewallPolicy

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message FirewallPolicy

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