Class protos.google.bigtable.v2.Bigtable (6.0.0)

Version latest

• 6.0.0 (latest)
• 5.1.2
• 5.0.0
• 4.6.1
• 4.1.0
• 4.0.5
• 3.10.0
• 3.9.4
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.4

Represents a Bigtable

Inheritance

$protobuf.rpc.Service > protos.google.bigtable.v2.Bigtable

Package

@google-cloud/bigtable

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Bigtable service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

checkAndMutateRow(request, callback)

public checkAndMutateRow(request: google.bigtable.v2.ICheckAndMutateRowRequest, callback: google.bigtable.v2.Bigtable.CheckAndMutateRowCallback): void;

Calls CheckAndMutateRow.

Parameters
Name	Description
request	ICheckAndMutateRowRequest CheckAndMutateRowRequest message or plain object
callback	CheckAndMutateRowCallback Node-style callback called with the error, if any, and CheckAndMutateRowResponse

Returns
Type	Description
void

checkAndMutateRow(request)

public checkAndMutateRow(request: google.bigtable.v2.ICheckAndMutateRowRequest): Promise<google.bigtable.v2.CheckAndMutateRowResponse>;

Calls CheckAndMutateRow.

Parameter
Name	Description
request	ICheckAndMutateRowRequest CheckAndMutateRowRequest message or plain object

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

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Bigtable;

Creates new Bigtable service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
Bigtable	RPC service. Useful where requests and/or responses are streamed.

executeQuery(request, callback)

public executeQuery(request: google.bigtable.v2.IExecuteQueryRequest, callback: google.bigtable.v2.Bigtable.ExecuteQueryCallback): void;

Calls ExecuteQuery.

Parameters
Name	Description
request	IExecuteQueryRequest ExecuteQueryRequest message or plain object
callback	ExecuteQueryCallback Node-style callback called with the error, if any, and ExecuteQueryResponse

Returns
Type	Description
void

executeQuery(request)

public executeQuery(request: google.bigtable.v2.IExecuteQueryRequest): Promise<google.bigtable.v2.ExecuteQueryResponse>;

Calls ExecuteQuery.

Parameter
Name	Description
request	IExecuteQueryRequest ExecuteQueryRequest message or plain object

Returns
Type	Description
Promise<google.bigtable.v2.ExecuteQueryResponse>	Promise

generateInitialChangeStreamPartitions(request, callback)

public generateInitialChangeStreamPartitions(request: google.bigtable.v2.IGenerateInitialChangeStreamPartitionsRequest, callback: google.bigtable.v2.Bigtable.GenerateInitialChangeStreamPartitionsCallback): void;

Calls GenerateInitialChangeStreamPartitions.

Parameters
Name	Description
request	IGenerateInitialChangeStreamPartitionsRequest GenerateInitialChangeStreamPartitionsRequest message or plain object
callback	GenerateInitialChangeStreamPartitionsCallback Node-style callback called with the error, if any, and GenerateInitialChangeStreamPartitionsResponse

Returns
Type	Description
void

generateInitialChangeStreamPartitions(request)

public generateInitialChangeStreamPartitions(request: google.bigtable.v2.IGenerateInitialChangeStreamPartitionsRequest): Promise<google.bigtable.v2.GenerateInitialChangeStreamPartitionsResponse>;

Calls GenerateInitialChangeStreamPartitions.

Parameter
Name	Description
request	IGenerateInitialChangeStreamPartitionsRequest GenerateInitialChangeStreamPartitionsRequest message or plain object

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

mutateRow(request, callback)

public mutateRow(request: google.bigtable.v2.IMutateRowRequest, callback: google.bigtable.v2.Bigtable.MutateRowCallback): void;

Calls MutateRow.

Parameters
Name	Description
request	IMutateRowRequest MutateRowRequest message or plain object
callback	MutateRowCallback Node-style callback called with the error, if any, and MutateRowResponse

Returns
Type	Description
void

mutateRow(request)

public mutateRow(request: google.bigtable.v2.IMutateRowRequest): Promise<google.bigtable.v2.MutateRowResponse>;

Calls MutateRow.

Parameter
Name	Description
request	IMutateRowRequest MutateRowRequest message or plain object

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

mutateRows(request, callback)

public mutateRows(request: google.bigtable.v2.IMutateRowsRequest, callback: google.bigtable.v2.Bigtable.MutateRowsCallback): void;

Calls MutateRows.

Parameters
Name	Description
request	IMutateRowsRequest MutateRowsRequest message or plain object
callback	MutateRowsCallback Node-style callback called with the error, if any, and MutateRowsResponse

Returns
Type	Description
void

mutateRows(request)

public mutateRows(request: google.bigtable.v2.IMutateRowsRequest): Promise<google.bigtable.v2.MutateRowsResponse>;

Calls MutateRows.

Parameter
Name	Description
request	IMutateRowsRequest MutateRowsRequest message or plain object

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

pingAndWarm(request, callback)

public pingAndWarm(request: google.bigtable.v2.IPingAndWarmRequest, callback: google.bigtable.v2.Bigtable.PingAndWarmCallback): void;

Calls PingAndWarm.

Parameters
Name	Description
request	IPingAndWarmRequest PingAndWarmRequest message or plain object
callback	PingAndWarmCallback Node-style callback called with the error, if any, and PingAndWarmResponse

Returns
Type	Description
void

pingAndWarm(request)

public pingAndWarm(request: google.bigtable.v2.IPingAndWarmRequest): Promise<google.bigtable.v2.PingAndWarmResponse>;

Calls PingAndWarm.

Parameter
Name	Description
request	IPingAndWarmRequest PingAndWarmRequest message or plain object

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

prepareQuery(request, callback)

public prepareQuery(request: google.bigtable.v2.IPrepareQueryRequest, callback: google.bigtable.v2.Bigtable.PrepareQueryCallback): void;

Calls PrepareQuery.

Parameters
Name	Description
request	IPrepareQueryRequest PrepareQueryRequest message or plain object
callback	PrepareQueryCallback Node-style callback called with the error, if any, and PrepareQueryResponse

Returns
Type	Description
void

prepareQuery(request)

public prepareQuery(request: google.bigtable.v2.IPrepareQueryRequest): Promise<google.bigtable.v2.PrepareQueryResponse>;

Calls PrepareQuery.

Parameter
Name	Description
request	IPrepareQueryRequest PrepareQueryRequest message or plain object

Returns
Type	Description
Promise<google.bigtable.v2.PrepareQueryResponse>	Promise

readChangeStream(request, callback)

public readChangeStream(request: google.bigtable.v2.IReadChangeStreamRequest, callback: google.bigtable.v2.Bigtable.ReadChangeStreamCallback): void;

Calls ReadChangeStream.

Parameters
Name	Description
request	IReadChangeStreamRequest ReadChangeStreamRequest message or plain object
callback	ReadChangeStreamCallback Node-style callback called with the error, if any, and ReadChangeStreamResponse

Returns
Type	Description
void

readChangeStream(request)

public readChangeStream(request: google.bigtable.v2.IReadChangeStreamRequest): Promise<google.bigtable.v2.ReadChangeStreamResponse>;

Calls ReadChangeStream.

Parameter
Name	Description
request	IReadChangeStreamRequest ReadChangeStreamRequest message or plain object

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

readModifyWriteRow(request, callback)

public readModifyWriteRow(request: google.bigtable.v2.IReadModifyWriteRowRequest, callback: google.bigtable.v2.Bigtable.ReadModifyWriteRowCallback): void;

Calls ReadModifyWriteRow.

Parameters
Name	Description
request	IReadModifyWriteRowRequest ReadModifyWriteRowRequest message or plain object
callback	ReadModifyWriteRowCallback Node-style callback called with the error, if any, and ReadModifyWriteRowResponse

Returns
Type	Description
void

readModifyWriteRow(request)

public readModifyWriteRow(request: google.bigtable.v2.IReadModifyWriteRowRequest): Promise<google.bigtable.v2.ReadModifyWriteRowResponse>;

Calls ReadModifyWriteRow.

Parameter
Name	Description
request	IReadModifyWriteRowRequest ReadModifyWriteRowRequest message or plain object

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

readRows(request, callback)

public readRows(request: google.bigtable.v2.IReadRowsRequest, callback: google.bigtable.v2.Bigtable.ReadRowsCallback): void;

Calls ReadRows.

Parameters
Name	Description
request	IReadRowsRequest ReadRowsRequest message or plain object
callback	ReadRowsCallback Node-style callback called with the error, if any, and ReadRowsResponse

Returns
Type	Description
void

readRows(request)

public readRows(request: google.bigtable.v2.IReadRowsRequest): Promise<google.bigtable.v2.ReadRowsResponse>;

Calls ReadRows.

Parameter
Name	Description
request	IReadRowsRequest ReadRowsRequest message or plain object

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

sampleRowKeys(request, callback)

public sampleRowKeys(request: google.bigtable.v2.ISampleRowKeysRequest, callback: google.bigtable.v2.Bigtable.SampleRowKeysCallback): void;

Calls SampleRowKeys.

Parameters
Name	Description
request	ISampleRowKeysRequest SampleRowKeysRequest message or plain object
callback	SampleRowKeysCallback Node-style callback called with the error, if any, and SampleRowKeysResponse

Returns
Type	Description
void

sampleRowKeys(request)

public sampleRowKeys(request: google.bigtable.v2.ISampleRowKeysRequest): Promise<google.bigtable.v2.SampleRowKeysResponse>;

Calls SampleRowKeys.

Parameter
Name	Description
request	ISampleRowKeysRequest SampleRowKeysRequest message or plain object

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