ClusterStatus

google.cloud.dataproc.v1beta2. ClusterStatus

Represents a ClusterStatus.

Constructor

new ClusterStatus(propertiesopt)

Constructs a new ClusterStatus.

Parameters:
Name Type Attributes Description
properties google.cloud.dataproc.v1beta2.IClusterStatus <optional>

Properties to set

Implements:
  • IClusterStatus

Members

State

State enum.

Properties:
Name Type Description
UNKNOWN number

UNKNOWN value

CREATING number

CREATING value

RUNNING number

RUNNING value

ERROR number

ERROR value

DELETING number

DELETING value

UPDATING number

UPDATING value

STOPPING number

STOPPING value

STOPPED number

STOPPED value

STARTING number

STARTING value

Substate

Substate enum.

Properties:
Name Type Description
UNSPECIFIED number

UNSPECIFIED value

UNHEALTHY number

UNHEALTHY value

STALE_STATUS number

STALE_STATUS value

detail

ClusterStatus detail.

state

ClusterStatus state.

stateStartTime

ClusterStatus stateStartTime.

substate

ClusterStatus substate.

Methods

(static) create(propertiesopt) → {google.cloud.dataproc.v1beta2.ClusterStatus}

Creates a new ClusterStatus instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.dataproc.v1beta2.IClusterStatus <optional>

Properties to set

Returns:
Type Description
google.cloud.dataproc.v1beta2.ClusterStatus

ClusterStatus instance

(static) decode(reader, lengthopt) → {google.cloud.dataproc.v1beta2.ClusterStatus}

Decodes a ClusterStatus 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.dataproc.v1beta2.ClusterStatus

ClusterStatus

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.dataproc.v1beta2.ClusterStatus}

Decodes a ClusterStatus 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.dataproc.v1beta2.ClusterStatus

ClusterStatus

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

Parameters:
Name Type Attributes Description
message google.cloud.dataproc.v1beta2.IClusterStatus

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

Parameters:
Name Type Attributes Description
message google.cloud.dataproc.v1beta2.IClusterStatus

ClusterStatus 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.dataproc.v1beta2.ClusterStatus}

Creates a ClusterStatus 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.dataproc.v1beta2.ClusterStatus

ClusterStatus

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

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

Parameters:
Name Type Attributes Description
message google.cloud.dataproc.v1beta2.ClusterStatus

ClusterStatus

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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

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

Converts this ClusterStatus to JSON.

Returns:
Type Description
Object.<string, *>

JSON object