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

State

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

Cluster defaultStorageType.

location

Cluster location.

name

Cluster name.

serveNodes

Cluster serveNodes.

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

Returns:
Type Description
google.bigtable.admin.v2.Cluster

Cluster instance

(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

Returns:
Type Description
google.bigtable.admin.v2.Cluster

Cluster

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

Returns:
Type Description
google.bigtable.admin.v2.Cluster

Cluster

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

Returns:
Type Description
$protobuf.Writer

Writer

(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

Returns:
Type Description
$protobuf.Writer

Writer

(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

Returns:
Type Description
google.bigtable.admin.v2.Cluster

Cluster

(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

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a Cluster 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 Cluster to JSON.

Returns:
Type Description
Object.<string, *>

JSON object