Class protos.google.cloud.networkmanagement.v1.FirewallInfo (2.4.2)

Represents a FirewallInfo.

Package

@google-cloud/network-management

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkmanagement.v1.IFirewallInfo);

Constructs a new FirewallInfo.

Parameter
NameDescription
properties IFirewallInfo

Properties to set

Properties

action

public action: string;

FirewallInfo action.

direction

public direction: string;

FirewallInfo direction.

displayName

public displayName: string;

FirewallInfo displayName.

firewallRuleType

public firewallRuleType: (google.cloud.networkmanagement.v1.FirewallInfo.FirewallRuleType|keyof typeof google.cloud.networkmanagement.v1.FirewallInfo.FirewallRuleType);

FirewallInfo firewallRuleType.

networkUri

public networkUri: string;

FirewallInfo networkUri.

policy

public policy: string;

FirewallInfo policy.

priority

public priority: number;

FirewallInfo priority.

targetServiceAccounts

public targetServiceAccounts: string[];

FirewallInfo targetServiceAccounts.

targetTags

public targetTags: string[];

FirewallInfo targetTags.

uri

public uri: string;

FirewallInfo uri.

Methods

create(properties)

public static create(properties?: google.cloud.networkmanagement.v1.IFirewallInfo): google.cloud.networkmanagement.v1.FirewallInfo;

Creates a new FirewallInfo instance using the specified properties.

Parameter
NameDescription
properties IFirewallInfo

Properties to set

Returns
TypeDescription
google.cloud.networkmanagement.v1.FirewallInfo

FirewallInfo instance

decode(reader, length)

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

Decodes a FirewallInfo message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.networkmanagement.v1.FirewallInfo

FirewallInfo

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.networkmanagement.v1.FirewallInfo

FirewallInfo

encode(message, writer)

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

Encodes the specified FirewallInfo message. Does not implicitly messages.

Parameters
NameDescription
message IFirewallInfo

FirewallInfo message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IFirewallInfo

FirewallInfo message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.networkmanagement.v1.FirewallInfo

FirewallInfo

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FirewallInfo

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this FirewallInfo to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.networkmanagement.v1.FirewallInfo

FirewallInfo

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a FirewallInfo message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not