Region

google.cloud.compute.v1. Region

Represents a Region.

Constructor

new Region(propertiesopt)

Constructs a new Region.

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

Properties to set

Implements:
  • IRegion

Members

_creationTimestamp

Region _creationTimestamp.

_deprecated

Region _deprecated.

_description

Region _description.

_id

Region _id.

_kind

Region _kind.

_name

Region _name.

Region _selfLink.

_status

Region _status.

_supportsPzs

Region _supportsPzs.

creationTimestamp

Region creationTimestamp.

deprecated

Region deprecated.

description

Region description.

id

Region id.

kind

Region kind.

name

Region name.

quotas

Region quotas.

Region selfLink.

status

Region status.

supportsPzs

Region supportsPzs.

zones

Region zones.

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

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Region instance using the specified properties.

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

Properties to set

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

Region instance

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

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

Region

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

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

Region

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 Region message. Does not implicitly verify messages.

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

Region 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 Region message, length delimited. Does not implicitly verify messages.

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

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

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

Region

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Region

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 Region message. Also converts values to other types if specified.

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

Region

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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