Backup

google.bigtable.admin.v2. Backup

Represents a Backup.

Constructor

new Backup(propertiesopt)

Constructs a new Backup.

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

Properties to set

Implements:
  • IBackup

Members

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

CREATING number

CREATING value

READY number

READY value

encryptionInfo

Backup encryptionInfo.

endTime

Backup endTime.

expireTime

Backup expireTime.

name

Backup name.

sizeBytes

Backup sizeBytes.

sourceTable

Backup sourceTable.

startTime

Backup startTime.

state

Backup state.

Methods

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

Creates a new Backup instance using the specified properties.

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

Properties to set

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

Backup instance

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

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

Backup

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

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

Backup

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

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

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

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

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

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

Backup

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

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

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

Backup

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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

Returns:
Type Description
Object.<string, *>

JSON object