Zone

google.cloud.compute.v1. Zone

Represents a Zone.

Constructor

new Zone(propertiesopt)

Constructs a new Zone.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IZone <optional>

Properties to set

Implements:
  • IZone

Members

_creationTimestamp

Zone _creationTimestamp.

_deprecated

Zone _deprecated.

_description

Zone _description.

_id

Zone _id.

_kind

Zone _kind.

_name

Zone _name.

_region

Zone _region.

Zone _selfLink.

_status

Zone _status.

_supportsPzs

Zone _supportsPzs.

availableCpuPlatforms

Zone availableCpuPlatforms.

creationTimestamp

Zone creationTimestamp.

deprecated

Zone deprecated.

description

Zone description.

id

Zone id.

kind

Zone kind.

name

Zone name.

region

Zone region.

Zone selfLink.

status

Zone status.

supportsPzs

Zone supportsPzs.

Status

Status enum.

Properties:
Name Type Description
UNDEFINED_STATUS number

UNDEFINED_STATUS value

DOWN number

DOWN value

UP number

UP value

Methods

toJSON() → {Object.<string, *>}

Converts this Zone to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.compute.v1.Zone}

Creates a new Zone instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IZone <optional>

Properties to set

Returns:
Type Description
google.cloud.compute.v1.Zone

Zone instance

(static) decode(reader, lengthopt) → {google.cloud.compute.v1.Zone}

Decodes a Zone message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.compute.v1.Zone

Zone

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.compute.v1.Zone}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.compute.v1.Zone

Zone

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Zone message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IZone

Zone message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IZone

Zone message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.compute.v1.Zone}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.compute.v1.Zone

Zone

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Zone

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.Zone

Zone

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Zone message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not