Class protos.google.cloud.compute.v1.FirewallPolicyRule (4.8.0)

Represents a FirewallPolicyRule.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new FirewallPolicyRule.

Parameter
Name Description
properties IFirewallPolicyRule

Properties to set

Properties

_action

public _action?: "action";

FirewallPolicyRule _action.

_description

public _description?: "description";

FirewallPolicyRule _description.

_direction

public _direction?: "direction";

FirewallPolicyRule _direction.

_disabled

public _disabled?: "disabled";

FirewallPolicyRule _disabled.

_enableLogging

public _enableLogging?: "enableLogging";

FirewallPolicyRule _enableLogging.

_kind

public _kind?: "kind";

FirewallPolicyRule _kind.

_match

public _match?: "match";

FirewallPolicyRule _match.

_priority

public _priority?: "priority";

FirewallPolicyRule _priority.

_ruleName

public _ruleName?: "ruleName";

FirewallPolicyRule _ruleName.

_ruleTupleCount

public _ruleTupleCount?: "ruleTupleCount";

FirewallPolicyRule _ruleTupleCount.

_securityProfileGroup

public _securityProfileGroup?: "securityProfileGroup";

FirewallPolicyRule _securityProfileGroup.

_tlsInspect

public _tlsInspect?: "tlsInspect";

FirewallPolicyRule _tlsInspect.

action

public action?: (string|null);

FirewallPolicyRule action.

description

public description?: (string|null);

FirewallPolicyRule description.

direction

public direction?: (string|null);

FirewallPolicyRule direction.

disabled

public disabled?: (boolean|null);

FirewallPolicyRule disabled.

enableLogging

public enableLogging?: (boolean|null);

FirewallPolicyRule enableLogging.

kind

public kind?: (string|null);

FirewallPolicyRule kind.

match

public match?: (google.cloud.compute.v1.IFirewallPolicyRuleMatcher|null);

FirewallPolicyRule match.

priority

public priority?: (number|null);

FirewallPolicyRule priority.

ruleName

public ruleName?: (string|null);

FirewallPolicyRule ruleName.

ruleTupleCount

public ruleTupleCount?: (number|null);

FirewallPolicyRule ruleTupleCount.

securityProfileGroup

public securityProfileGroup?: (string|null);

FirewallPolicyRule securityProfileGroup.

targetResources

public targetResources: string[];

FirewallPolicyRule targetResources.

targetSecureTags

public targetSecureTags: google.cloud.compute.v1.IFirewallPolicyRuleSecureTag[];

FirewallPolicyRule targetSecureTags.

targetServiceAccounts

public targetServiceAccounts: string[];

FirewallPolicyRule targetServiceAccounts.

tlsInspect

public tlsInspect?: (boolean|null);

FirewallPolicyRule tlsInspect.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IFirewallPolicyRule): google.cloud.compute.v1.FirewallPolicyRule;

Creates a new FirewallPolicyRule instance using the specified properties.

Parameter
Name Description
properties IFirewallPolicyRule

Properties to set

Returns
Type Description
FirewallPolicyRule

FirewallPolicyRule instance

decode(reader, length)

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

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

FirewallPolicyRule

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
FirewallPolicyRule

FirewallPolicyRule

encode(message, writer)

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

Encodes the specified FirewallPolicyRule message. Does not implicitly messages.

Parameters
Name Description
message IFirewallPolicyRule

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

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

Parameters
Name Description
message IFirewallPolicyRule

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

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

FirewallPolicyRule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FirewallPolicyRule

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message FirewallPolicyRule

FirewallPolicyRule

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