Class protos.google.cloud.compute.v1.Firewall (4.5.0)

Represents a Firewall.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new Firewall.

Parameter
Name Description
properties IFirewall

Properties to set

Properties

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

Firewall _creationTimestamp.

_description

public _description?: "description";

Firewall _description.

_direction

public _direction?: "direction";

Firewall _direction.

_disabled

public _disabled?: "disabled";

Firewall _disabled.

_id

public _id?: "id";

Firewall _id.

_kind

public _kind?: "kind";

Firewall _kind.

_logConfig

public _logConfig?: "logConfig";

Firewall _logConfig.

_name

public _name?: "name";

Firewall _name.

_network

public _network?: "network";

Firewall _network.

_priority

public _priority?: "priority";

Firewall _priority.

public _selfLink?: "selfLink";

Firewall _selfLink.

allowed

public allowed: google.cloud.compute.v1.IAllowed[];

Firewall allowed.

creationTimestamp

public creationTimestamp?: (string|null);

Firewall creationTimestamp.

denied

public denied: google.cloud.compute.v1.IDenied[];

Firewall denied.

description

public description?: (string|null);

Firewall description.

destinationRanges

public destinationRanges: string[];

Firewall destinationRanges.

direction

public direction?: (string|null);

Firewall direction.

disabled

public disabled?: (boolean|null);

Firewall disabled.

id

public id?: (number|Long|string|null);

Firewall id.

kind

public kind?: (string|null);

Firewall kind.

logConfig

public logConfig?: (google.cloud.compute.v1.IFirewallLogConfig|null);

Firewall logConfig.

name

public name?: (string|null);

Firewall name.

network

public network?: (string|null);

Firewall network.

priority

public priority?: (number|null);

Firewall priority.

public selfLink?: (string|null);

Firewall selfLink.

sourceRanges

public sourceRanges: string[];

Firewall sourceRanges.

sourceServiceAccounts

public sourceServiceAccounts: string[];

Firewall sourceServiceAccounts.

sourceTags

public sourceTags: string[];

Firewall sourceTags.

targetServiceAccounts

public targetServiceAccounts: string[];

Firewall targetServiceAccounts.

targetTags

public targetTags: string[];

Firewall targetTags.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IFirewall): google.cloud.compute.v1.Firewall;

Creates a new Firewall instance using the specified properties.

Parameter
Name Description
properties IFirewall

Properties to set

Returns
Type Description
Firewall

Firewall instance

decode(reader, length)

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

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

Firewall

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Firewall

Firewall

encode(message, writer)

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

Encodes the specified Firewall message. Does not implicitly messages.

Parameters
Name Description
message IFirewall

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

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

Parameters
Name Description
message IFirewall

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

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

Firewall

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Firewall

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Firewall

Firewall

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