Cluster

google.bigtable.admin.v2. Cluster

Represents a Cluster.

Constructor

new Cluster(propertiesopt)

Constructs a new Cluster.

Parameters:
Name Type Attributes Description
properties google.bigtable.admin.v2.ICluster <optional>

Properties to set

Implements:
  • ICluster

Members

(static) State :number

State enum.

Properties:
Name Type Description
STATE_NOT_KNOWN number

STATE_NOT_KNOWN value

READY number

READY value

CREATING number

CREATING value

RESIZING number

RESIZING value

DISABLED number

DISABLED value

defaultStorageType :google.bigtable.admin.v2.StorageType

Cluster defaultStorageType.

location :string

Cluster location.

name :string

Cluster name.

serveNodes :number

Cluster serveNodes.

state :google.bigtable.admin.v2.Cluster.State

Cluster state.

Methods

(static) create(propertiesopt) → {google.bigtable.admin.v2.Cluster}

Creates a new Cluster instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.bigtable.admin.v2.ICluster <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.bigtable.admin.v2.Cluster}

Decodes a Cluster 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

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.bigtable.admin.v2.Cluster}

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

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

Reader or buffer to decode from

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

Parameters:
Name Type Attributes Description
message google.bigtable.admin.v2.ICluster

Cluster message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

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

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

Parameters:
Name Type Attributes Description
message google.bigtable.admin.v2.ICluster

Cluster message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.bigtable.admin.v2.Cluster}

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

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

Plain object

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

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

Parameters:
Name Type Attributes Description
message google.bigtable.admin.v2.Cluster

Cluster

options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies a Cluster message.

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

Plain object to verify

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

Converts this Cluster to JSON.