ResourcePolicy

google.cloud.compute.v1. ResourcePolicy

Represents a ResourcePolicy.

Constructor

new ResourcePolicy(propertiesopt)

Constructs a new ResourcePolicy.

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

Properties to set

Implements:
  • IResourcePolicy

Members

_creationTimestamp

ResourcePolicy _creationTimestamp.

_description

ResourcePolicy _description.

_groupPlacementPolicy

ResourcePolicy _groupPlacementPolicy.

_id

ResourcePolicy _id.

_instanceSchedulePolicy

ResourcePolicy _instanceSchedulePolicy.

_kind

ResourcePolicy _kind.

_name

ResourcePolicy _name.

_region

ResourcePolicy _region.

_resourceStatus

ResourcePolicy _resourceStatus.

ResourcePolicy _selfLink.

_snapshotSchedulePolicy

ResourcePolicy _snapshotSchedulePolicy.

_status

ResourcePolicy _status.

creationTimestamp

ResourcePolicy creationTimestamp.

description

ResourcePolicy description.

groupPlacementPolicy

ResourcePolicy groupPlacementPolicy.

id

ResourcePolicy id.

instanceSchedulePolicy

ResourcePolicy instanceSchedulePolicy.

kind

ResourcePolicy kind.

name

ResourcePolicy name.

region

ResourcePolicy region.

resourceStatus

ResourcePolicy resourceStatus.

ResourcePolicy selfLink.

snapshotSchedulePolicy

ResourcePolicy snapshotSchedulePolicy.

status

ResourcePolicy status.

Status

Status enum.

Properties:
Name Type Description
UNDEFINED_STATUS number

UNDEFINED_STATUS value

CREATING number

CREATING value

DELETING number

DELETING value

EXPIRED number

EXPIRED value

INVALID number

INVALID value

READY number

READY value

Methods

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

Converts this ResourcePolicy to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new ResourcePolicy instance using the specified properties.

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

Properties to set

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

ResourcePolicy instance

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

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

ResourcePolicy

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

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

ResourcePolicy

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

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

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

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

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

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

ResourcePolicy

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ResourcePolicy

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

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

ResourcePolicy

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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