Bigtable

google.bigtable.v2. Bigtable

Represents a Bigtable

Constructor

new Bigtable(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Bigtable service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

checkAndMutateRow(request, callback) → {undefined}

Calls CheckAndMutateRow.

Parameters:
Name Type Description
request google.bigtable.v2.ICheckAndMutateRowRequest

CheckAndMutateRowRequest message or plain object

callback google.bigtable.v2.Bigtable.CheckAndMutateRowCallback

Node-style callback called with the error, if any, and CheckAndMutateRowResponse

Returns:
Type Description
undefined

checkAndMutateRow(request) → {Promise.<google.bigtable.v2.CheckAndMutateRowResponse>}

Calls CheckAndMutateRow.

Parameters:
Name Type Description
request google.bigtable.v2.ICheckAndMutateRowRequest

CheckAndMutateRowRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.v2.CheckAndMutateRowResponse>

Promise

generateInitialChangeStreamPartitions(request, callback) → {undefined}

Calls GenerateInitialChangeStreamPartitions.

Parameters:
Name Type Description
request google.bigtable.v2.IGenerateInitialChangeStreamPartitionsRequest

GenerateInitialChangeStreamPartitionsRequest message or plain object

callback google.bigtable.v2.Bigtable.GenerateInitialChangeStreamPartitionsCallback

Node-style callback called with the error, if any, and GenerateInitialChangeStreamPartitionsResponse

Returns:
Type Description
undefined

generateInitialChangeStreamPartitions(request) → {Promise.<google.bigtable.v2.GenerateInitialChangeStreamPartitionsResponse>}

Calls GenerateInitialChangeStreamPartitions.

Parameters:
Name Type Description
request google.bigtable.v2.IGenerateInitialChangeStreamPartitionsRequest

GenerateInitialChangeStreamPartitionsRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.v2.GenerateInitialChangeStreamPartitionsResponse>

Promise

mutateRow(request, callback) → {undefined}

Calls MutateRow.

Parameters:
Name Type Description
request google.bigtable.v2.IMutateRowRequest

MutateRowRequest message or plain object

callback google.bigtable.v2.Bigtable.MutateRowCallback

Node-style callback called with the error, if any, and MutateRowResponse

Returns:
Type Description
undefined

mutateRow(request) → {Promise.<google.bigtable.v2.MutateRowResponse>}

Calls MutateRow.

Parameters:
Name Type Description
request google.bigtable.v2.IMutateRowRequest

MutateRowRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.v2.MutateRowResponse>

Promise

mutateRows(request, callback) → {undefined}

Calls MutateRows.

Parameters:
Name Type Description
request google.bigtable.v2.IMutateRowsRequest

MutateRowsRequest message or plain object

callback google.bigtable.v2.Bigtable.MutateRowsCallback

Node-style callback called with the error, if any, and MutateRowsResponse

Returns:
Type Description
undefined

mutateRows(request) → {Promise.<google.bigtable.v2.MutateRowsResponse>}

Calls MutateRows.

Parameters:
Name Type Description
request google.bigtable.v2.IMutateRowsRequest

MutateRowsRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.v2.MutateRowsResponse>

Promise

pingAndWarm(request, callback) → {undefined}

Calls PingAndWarm.

Parameters:
Name Type Description
request google.bigtable.v2.IPingAndWarmRequest

PingAndWarmRequest message or plain object

callback google.bigtable.v2.Bigtable.PingAndWarmCallback

Node-style callback called with the error, if any, and PingAndWarmResponse

Returns:
Type Description
undefined

pingAndWarm(request) → {Promise.<google.bigtable.v2.PingAndWarmResponse>}

Calls PingAndWarm.

Parameters:
Name Type Description
request google.bigtable.v2.IPingAndWarmRequest

PingAndWarmRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.v2.PingAndWarmResponse>

Promise

readChangeStream(request, callback) → {undefined}

Calls ReadChangeStream.

Parameters:
Name Type Description
request google.bigtable.v2.IReadChangeStreamRequest

ReadChangeStreamRequest message or plain object

callback google.bigtable.v2.Bigtable.ReadChangeStreamCallback

Node-style callback called with the error, if any, and ReadChangeStreamResponse

Returns:
Type Description
undefined

readChangeStream(request) → {Promise.<google.bigtable.v2.ReadChangeStreamResponse>}

Calls ReadChangeStream.

Parameters:
Name Type Description
request google.bigtable.v2.IReadChangeStreamRequest

ReadChangeStreamRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.v2.ReadChangeStreamResponse>

Promise

readModifyWriteRow(request, callback) → {undefined}

Calls ReadModifyWriteRow.

Parameters:
Name Type Description
request google.bigtable.v2.IReadModifyWriteRowRequest

ReadModifyWriteRowRequest message or plain object

callback google.bigtable.v2.Bigtable.ReadModifyWriteRowCallback

Node-style callback called with the error, if any, and ReadModifyWriteRowResponse

Returns:
Type Description
undefined

readModifyWriteRow(request) → {Promise.<google.bigtable.v2.ReadModifyWriteRowResponse>}

Calls ReadModifyWriteRow.

Parameters:
Name Type Description
request google.bigtable.v2.IReadModifyWriteRowRequest

ReadModifyWriteRowRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.v2.ReadModifyWriteRowResponse>

Promise

readRows(request, callback) → {undefined}

Calls ReadRows.

Parameters:
Name Type Description
request google.bigtable.v2.IReadRowsRequest

ReadRowsRequest message or plain object

callback google.bigtable.v2.Bigtable.ReadRowsCallback

Node-style callback called with the error, if any, and ReadRowsResponse

Returns:
Type Description
undefined

readRows(request) → {Promise.<google.bigtable.v2.ReadRowsResponse>}

Calls ReadRows.

Parameters:
Name Type Description
request google.bigtable.v2.IReadRowsRequest

ReadRowsRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.v2.ReadRowsResponse>

Promise

sampleRowKeys(request, callback) → {undefined}

Calls SampleRowKeys.

Parameters:
Name Type Description
request google.bigtable.v2.ISampleRowKeysRequest

SampleRowKeysRequest message or plain object

callback google.bigtable.v2.Bigtable.SampleRowKeysCallback

Node-style callback called with the error, if any, and SampleRowKeysResponse

Returns:
Type Description
undefined

sampleRowKeys(request) → {Promise.<google.bigtable.v2.SampleRowKeysResponse>}

Calls SampleRowKeys.

Parameters:
Name Type Description
request google.bigtable.v2.ISampleRowKeysRequest

SampleRowKeysRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.v2.SampleRowKeysResponse>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Bigtable}

Creates new Bigtable service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
Bigtable

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CheckAndMutateRowCallback(error, responseopt)

Callback as used by checkAndMutateRow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.v2.CheckAndMutateRowResponse <optional>

CheckAndMutateRowResponse

GenerateInitialChangeStreamPartitionsCallback(error, responseopt)

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.v2.GenerateInitialChangeStreamPartitionsResponse <optional>

GenerateInitialChangeStreamPartitionsResponse

MutateRowCallback(error, responseopt)

Callback as used by mutateRow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.v2.MutateRowResponse <optional>

MutateRowResponse

MutateRowsCallback(error, responseopt)

Callback as used by mutateRows.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.v2.MutateRowsResponse <optional>

MutateRowsResponse

PingAndWarmCallback(error, responseopt)

Callback as used by pingAndWarm.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.v2.PingAndWarmResponse <optional>

PingAndWarmResponse

ReadChangeStreamCallback(error, responseopt)

Callback as used by readChangeStream.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.v2.ReadChangeStreamResponse <optional>

ReadChangeStreamResponse

ReadModifyWriteRowCallback(error, responseopt)

Callback as used by readModifyWriteRow.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.v2.ReadModifyWriteRowResponse <optional>

ReadModifyWriteRowResponse

ReadRowsCallback(error, responseopt)

Callback as used by readRows.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.v2.ReadRowsResponse <optional>

ReadRowsResponse

SampleRowKeysCallback(error, responseopt)

Callback as used by sampleRowKeys.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.v2.SampleRowKeysResponse <optional>

SampleRowKeysResponse