Class protos.google.cloud.compute.v1.Region

Represents a Region.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new Region.

Parameter
NameDescription
properties IRegion

Properties to set

Properties

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

Region _creationTimestamp.

_deprecated

public _deprecated?: "deprecated";

Region _deprecated.

_description

public _description?: "description";

Region _description.

_id

public _id?: "id";

Region _id.

_kind

public _kind?: "kind";

Region _kind.

_name

public _name?: "name";

Region _name.

public _selfLink?: "selfLink";

Region _selfLink.

_status

public _status?: "status";

Region _status.

_supportsPzs

public _supportsPzs?: "supportsPzs";

Region _supportsPzs.

creationTimestamp

public creationTimestamp?: (string|null);

Region creationTimestamp.

deprecated

public deprecated?: (google.cloud.compute.v1.IDeprecationStatus|null);

Region deprecated.

description

public description?: (string|null);

Region description.

id

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

Region id.

kind

public kind?: (string|null);

Region kind.

name

public name?: (string|null);

Region name.

quotas

public quotas: google.cloud.compute.v1.IQuota[];

Region quotas.

public selfLink?: (string|null);

Region selfLink.

status

public status?: (google.cloud.compute.v1.Region.Status|keyof typeof google.cloud.compute.v1.Region.Status|null);

Region status.

supportsPzs

public supportsPzs?: (boolean|null);

Region supportsPzs.

zones

public zones: string[];

Region zones.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IRegion): google.cloud.compute.v1.Region;

Creates a new Region instance using the specified properties.

Parameter
NameDescription
properties IRegion

Properties to set

Returns
TypeDescription
google.cloud.compute.v1.Region

Region instance

decode(reader, length)

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

Decodes a Region 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.compute.v1.Region

Region

decodeDelimited(reader)

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

Decodes a Region 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.compute.v1.Region

Region

encode(message, writer)

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

Encodes the specified Region message. Does not implicitly messages.

Parameters
NameDescription
message IRegion

Region 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.compute.v1.IRegion, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IRegion

Region 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.compute.v1.Region;

Creates a Region 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.compute.v1.Region

Region

toJSON()

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

Converts this Region to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.compute.v1.Region

Region

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