Table

google.bigtable.admin.v2. Table

Represents a Table.

Constructor

new Table(propertiesopt)

Constructs a new Table.

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

Properties to set

Implements:
  • ITable

Classes

AutomatedBackupPolicy
ClusterState

Members

automatedBackupConfig

Table automatedBackupConfig.

automatedBackupPolicy

Table automatedBackupPolicy.

changeStreamConfig

Table changeStreamConfig.

clusterStates

Table clusterStates.

columnFamilies

Table columnFamilies.

deletionProtection

Table deletionProtection.

granularity

Table granularity.

name

Table name.

restoreInfo

Table restoreInfo.

TimestampGranularity

TimestampGranularity enum.

Properties:
Name Type Description
TIMESTAMP_GRANULARITY_UNSPECIFIED number

TIMESTAMP_GRANULARITY_UNSPECIFIED value

MILLIS number

MILLIS value

View

View enum.

Properties:
Name Type Description
VIEW_UNSPECIFIED number

VIEW_UNSPECIFIED value

NAME_ONLY number

NAME_ONLY value

SCHEMA_VIEW number

SCHEMA_VIEW value

REPLICATION_VIEW number

REPLICATION_VIEW value

ENCRYPTION_VIEW number

ENCRYPTION_VIEW value

FULL number

FULL value

Methods

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

Converts this Table to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Table instance using the specified properties.

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

Properties to set

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

Table instance

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

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

Table

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

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

Table

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

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

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

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

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

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

Table

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Table

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

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

Table

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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