Class v1alpha1.TablesServiceClient (1.2.8)

The Tables Service provides an API for reading and updating tables. It defines the following resource model:

The API has a collection of resources, named tables/*
Each Table has a collection of resources, named tables/* /rows/*
The API has a collection of resources, named workspaces/*. v1alpha1

Package

@google/area120-tables!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of TablesServiceClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value

Type	Description
string

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

Property Value

Type	Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

Property Value

Type	Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value

Type	Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value

Type	Description
string

tablesServiceStub

tablesServiceStub?: Promise<{
        [name: string]: Function;
    }>;

Property Value

Type	Description
Promise<{ [name: string]: Function; }>

warn

warn: (code: string, message: string, warnType?: string) => void;

Property Value

Type	Description
(code: string, message: string, warnType?: string) => void

Methods

batchCreateRows(request, options)

batchCreateRows(request?: protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest, options?: CallOptions): Promise<[protos.google.area120.tables.v1alpha1.IBatchCreateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.area120.tables.v1alpha1.IBatchCreateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest \| undefined, {} \| undefined]>

batchCreateRows(request, options, callback)

batchCreateRows(request: protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest, options: CallOptions, callback: Callback<protos.google.area120.tables.v1alpha1.IBatchCreateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest`
options	`CallOptions`
callback	`Callback<protos.google.area120.tables.v1alpha1.IBatchCreateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

batchCreateRows(request, callback)

batchCreateRows(request: protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest, callback: Callback<protos.google.area120.tables.v1alpha1.IBatchCreateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest`
callback	`Callback<protos.google.area120.tables.v1alpha1.IBatchCreateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchCreateRowsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

batchDeleteRows(request, options)

batchDeleteRows(request?: protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest \| undefined, {} \| undefined]>

batchDeleteRows(request, options, callback)

batchDeleteRows(request: protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

batchDeleteRows(request, callback)

batchDeleteRows(request: protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IBatchDeleteRowsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

batchUpdateRows(request, options)

batchUpdateRows(request?: protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest, options?: CallOptions): Promise<[protos.google.area120.tables.v1alpha1.IBatchUpdateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.area120.tables.v1alpha1.IBatchUpdateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest \| undefined, {} \| undefined]>

batchUpdateRows(request, options, callback)

batchUpdateRows(request: protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest, options: CallOptions, callback: Callback<protos.google.area120.tables.v1alpha1.IBatchUpdateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest`
options	`CallOptions`
callback	`Callback<protos.google.area120.tables.v1alpha1.IBatchUpdateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

batchUpdateRows(request, callback)

batchUpdateRows(request: protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest, callback: Callback<protos.google.area120.tables.v1alpha1.IBatchUpdateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest`
callback	`Callback<protos.google.area120.tables.v1alpha1.IBatchUpdateRowsResponse, protos.google.area120.tables.v1alpha1.IBatchUpdateRowsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

createRow(request, options)

createRow(request?: protos.google.area120.tables.v1alpha1.ICreateRowRequest, options?: CallOptions): Promise<[protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.ICreateRowRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.ICreateRowRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.ICreateRowRequest \| undefined, {} \| undefined]>

createRow(request, options, callback)

createRow(request: protos.google.area120.tables.v1alpha1.ICreateRowRequest, options: CallOptions, callback: Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.ICreateRowRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.ICreateRowRequest`
options	`CallOptions`
callback	`Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.ICreateRowRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createRow(request, callback)

createRow(request: protos.google.area120.tables.v1alpha1.ICreateRowRequest, callback: Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.ICreateRowRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.ICreateRowRequest`
callback	`Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.ICreateRowRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteRow(request, options)

deleteRow(request?: protos.google.area120.tables.v1alpha1.IDeleteRowRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IDeleteRowRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IDeleteRowRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IDeleteRowRequest \| undefined, {} \| undefined]>

deleteRow(request, options, callback)

deleteRow(request: protos.google.area120.tables.v1alpha1.IDeleteRowRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IDeleteRowRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IDeleteRowRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IDeleteRowRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteRow(request, callback)

deleteRow(request: protos.google.area120.tables.v1alpha1.IDeleteRowRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IDeleteRowRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IDeleteRowRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.area120.tables.v1alpha1.IDeleteRowRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

getRow(request, options)

getRow(request?: protos.google.area120.tables.v1alpha1.IGetRowRequest, options?: CallOptions): Promise<[protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IGetRowRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IGetRowRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IGetRowRequest \| undefined, {} \| undefined]>

getRow(request, options, callback)

getRow(request: protos.google.area120.tables.v1alpha1.IGetRowRequest, options: CallOptions, callback: Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IGetRowRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IGetRowRequest`
options	`CallOptions`
callback	`Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IGetRowRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getRow(request, callback)

getRow(request: protos.google.area120.tables.v1alpha1.IGetRowRequest, callback: Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IGetRowRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IGetRowRequest`
callback	`Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IGetRowRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getTable(request, options)

getTable(request?: protos.google.area120.tables.v1alpha1.IGetTableRequest, options?: CallOptions): Promise<[protos.google.area120.tables.v1alpha1.ITable, protos.google.area120.tables.v1alpha1.IGetTableRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IGetTableRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.area120.tables.v1alpha1.ITable, protos.google.area120.tables.v1alpha1.IGetTableRequest \| undefined, {} \| undefined]>

getTable(request, options, callback)

getTable(request: protos.google.area120.tables.v1alpha1.IGetTableRequest, options: CallOptions, callback: Callback<protos.google.area120.tables.v1alpha1.ITable, protos.google.area120.tables.v1alpha1.IGetTableRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IGetTableRequest`
options	`CallOptions`
callback	`Callback<protos.google.area120.tables.v1alpha1.ITable, protos.google.area120.tables.v1alpha1.IGetTableRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getTable(request, callback)

getTable(request: protos.google.area120.tables.v1alpha1.IGetTableRequest, callback: Callback<protos.google.area120.tables.v1alpha1.ITable, protos.google.area120.tables.v1alpha1.IGetTableRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IGetTableRequest`
callback	`Callback<protos.google.area120.tables.v1alpha1.ITable, protos.google.area120.tables.v1alpha1.IGetTableRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getWorkspace(request, options)

getWorkspace(request?: protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest, options?: CallOptions): Promise<[protos.google.area120.tables.v1alpha1.IWorkspace, protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.area120.tables.v1alpha1.IWorkspace, protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest \| undefined, {} \| undefined]>

getWorkspace(request, options, callback)

getWorkspace(request: protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest, options: CallOptions, callback: Callback<protos.google.area120.tables.v1alpha1.IWorkspace, protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest`
options	`CallOptions`
callback	`Callback<protos.google.area120.tables.v1alpha1.IWorkspace, protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getWorkspace(request, callback)

getWorkspace(request: protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest, callback: Callback<protos.google.area120.tables.v1alpha1.IWorkspace, protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest`
callback	`Callback<protos.google.area120.tables.v1alpha1.IWorkspace, protos.google.area120.tables.v1alpha1.IGetWorkspaceRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listRows(request, options)

listRows(request?: protos.google.area120.tables.v1alpha1.IListRowsRequest, options?: CallOptions): Promise<[protos.google.area120.tables.v1alpha1.IRow[], protos.google.area120.tables.v1alpha1.IListRowsRequest | null, protos.google.area120.tables.v1alpha1.IListRowsResponse]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListRowsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.area120.tables.v1alpha1.IRow[], protos.google.area120.tables.v1alpha1.IListRowsRequest \| null, protos.google.area120.tables.v1alpha1.IListRowsResponse]>

listRows(request, options, callback)

listRows(request: protos.google.area120.tables.v1alpha1.IListRowsRequest, options: CallOptions, callback: PaginationCallback<protos.google.area120.tables.v1alpha1.IListRowsRequest, protos.google.area120.tables.v1alpha1.IListRowsResponse | null | undefined, protos.google.area120.tables.v1alpha1.IRow>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListRowsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.area120.tables.v1alpha1.IListRowsRequest, protos.google.area120.tables.v1alpha1.IListRowsResponse \| null \| undefined, protos.google.area120.tables.v1alpha1.IRow>`

Returns

Type	Description
void

listRows(request, callback)

listRows(request: protos.google.area120.tables.v1alpha1.IListRowsRequest, callback: PaginationCallback<protos.google.area120.tables.v1alpha1.IListRowsRequest, protos.google.area120.tables.v1alpha1.IListRowsResponse | null | undefined, protos.google.area120.tables.v1alpha1.IRow>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListRowsRequest`
callback	`PaginationCallback<protos.google.area120.tables.v1alpha1.IListRowsRequest, protos.google.area120.tables.v1alpha1.IListRowsResponse \| null \| undefined, protos.google.area120.tables.v1alpha1.IRow>`

Returns

Type	Description
void

listRowsAsync(request, options)

listRowsAsync(request?: protos.google.area120.tables.v1alpha1.IListRowsRequest, options?: CallOptions): AsyncIterable<protos.google.area120.tables.v1alpha1.IRow>;

Equivalent to listRows, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListRowsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.area120.tables.v1alpha1.IRow>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Row]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listRowsStream(request, options)

listRowsStream(request?: protos.google.area120.tables.v1alpha1.IListRowsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListRowsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Row] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listRowsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTables(request, options)

listTables(request?: protos.google.area120.tables.v1alpha1.IListTablesRequest, options?: CallOptions): Promise<[protos.google.area120.tables.v1alpha1.ITable[], protos.google.area120.tables.v1alpha1.IListTablesRequest | null, protos.google.area120.tables.v1alpha1.IListTablesResponse]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListTablesRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.area120.tables.v1alpha1.ITable[], protos.google.area120.tables.v1alpha1.IListTablesRequest \| null, protos.google.area120.tables.v1alpha1.IListTablesResponse]>

listTables(request, options, callback)

listTables(request: protos.google.area120.tables.v1alpha1.IListTablesRequest, options: CallOptions, callback: PaginationCallback<protos.google.area120.tables.v1alpha1.IListTablesRequest, protos.google.area120.tables.v1alpha1.IListTablesResponse | null | undefined, protos.google.area120.tables.v1alpha1.ITable>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListTablesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.area120.tables.v1alpha1.IListTablesRequest, protos.google.area120.tables.v1alpha1.IListTablesResponse \| null \| undefined, protos.google.area120.tables.v1alpha1.ITable>`

Returns

Type	Description
void

listTables(request, callback)

listTables(request: protos.google.area120.tables.v1alpha1.IListTablesRequest, callback: PaginationCallback<protos.google.area120.tables.v1alpha1.IListTablesRequest, protos.google.area120.tables.v1alpha1.IListTablesResponse | null | undefined, protos.google.area120.tables.v1alpha1.ITable>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListTablesRequest`
callback	`PaginationCallback<protos.google.area120.tables.v1alpha1.IListTablesRequest, protos.google.area120.tables.v1alpha1.IListTablesResponse \| null \| undefined, protos.google.area120.tables.v1alpha1.ITable>`

Returns

Type	Description
void

listTablesAsync(request, options)

listTablesAsync(request?: protos.google.area120.tables.v1alpha1.IListTablesRequest, options?: CallOptions): AsyncIterable<protos.google.area120.tables.v1alpha1.ITable>;

Equivalent to listTables, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListTablesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.area120.tables.v1alpha1.ITable>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Table]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTablesStream(request, options)

listTablesStream(request?: protos.google.area120.tables.v1alpha1.IListTablesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListTablesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Table] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTablesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listWorkspaces(request, options)

listWorkspaces(request?: protos.google.area120.tables.v1alpha1.IListWorkspacesRequest, options?: CallOptions): Promise<[protos.google.area120.tables.v1alpha1.IWorkspace[], protos.google.area120.tables.v1alpha1.IListWorkspacesRequest | null, protos.google.area120.tables.v1alpha1.IListWorkspacesResponse]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListWorkspacesRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.area120.tables.v1alpha1.IWorkspace[], protos.google.area120.tables.v1alpha1.IListWorkspacesRequest \| null, protos.google.area120.tables.v1alpha1.IListWorkspacesResponse]>

listWorkspaces(request, options, callback)

listWorkspaces(request: protos.google.area120.tables.v1alpha1.IListWorkspacesRequest, options: CallOptions, callback: PaginationCallback<protos.google.area120.tables.v1alpha1.IListWorkspacesRequest, protos.google.area120.tables.v1alpha1.IListWorkspacesResponse | null | undefined, protos.google.area120.tables.v1alpha1.IWorkspace>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListWorkspacesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.area120.tables.v1alpha1.IListWorkspacesRequest, protos.google.area120.tables.v1alpha1.IListWorkspacesResponse \| null \| undefined, protos.google.area120.tables.v1alpha1.IWorkspace>`

Returns

Type	Description
void

listWorkspaces(request, callback)

listWorkspaces(request: protos.google.area120.tables.v1alpha1.IListWorkspacesRequest, callback: PaginationCallback<protos.google.area120.tables.v1alpha1.IListWorkspacesRequest, protos.google.area120.tables.v1alpha1.IListWorkspacesResponse | null | undefined, protos.google.area120.tables.v1alpha1.IWorkspace>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListWorkspacesRequest`
callback	`PaginationCallback<protos.google.area120.tables.v1alpha1.IListWorkspacesRequest, protos.google.area120.tables.v1alpha1.IListWorkspacesResponse \| null \| undefined, protos.google.area120.tables.v1alpha1.IWorkspace>`

Returns

Type	Description
void

listWorkspacesAsync(request, options)

listWorkspacesAsync(request?: protos.google.area120.tables.v1alpha1.IListWorkspacesRequest, options?: CallOptions): AsyncIterable<protos.google.area120.tables.v1alpha1.IWorkspace>;

Equivalent to listWorkspaces, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListWorkspacesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.area120.tables.v1alpha1.IWorkspace>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Workspace]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listWorkspacesStream(request, options)

listWorkspacesStream(request?: protos.google.area120.tables.v1alpha1.IListWorkspacesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IListWorkspacesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Workspace] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listWorkspacesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchRowFromRowName(rowName)

matchRowFromRowName(rowName: string): string | number;

Parse the row from Row resource.

Parameter

Name	Description
rowName	`string` A fully-qualified path representing Row resource.

Returns

Type	Description
string \| number	{string} A string representing the row.

matchTableFromRowName(rowName)

matchTableFromRowName(rowName: string): string | number;

Parse the table from Row resource.

Parameter

Name	Description
rowName	`string` A fully-qualified path representing Row resource.

Returns

Type	Description
string \| number	{string} A string representing the table.

matchTableFromTableName(tableName)

matchTableFromTableName(tableName: string): string | number;

Parse the table from Table resource.

Parameter

Name	Description
tableName	`string` A fully-qualified path representing Table resource.

Returns

Type	Description
string \| number	{string} A string representing the table.

matchWorkspaceFromWorkspaceName(workspaceName)

matchWorkspaceFromWorkspaceName(workspaceName: string): string | number;

Parse the workspace from Workspace resource.

Parameter

Name	Description
workspaceName	`string` A fully-qualified path representing Workspace resource.

Returns

Type	Description
string \| number	{string} A string representing the workspace.

rowPath(table, row)

rowPath(table: string, row: string): string;

Return a fully-qualified row resource name string.

Parameters

Name	Description
table	`string`
row	`string`

Returns

Type	Description
string	{string} Resource name string.

tablePath(table)

tablePath(table: string): string;

Return a fully-qualified table resource name string.

Parameter

Name	Description
table	`string`

Returns

Type	Description
string	{string} Resource name string.

updateRow(request, options)

updateRow(request?: protos.google.area120.tables.v1alpha1.IUpdateRowRequest, options?: CallOptions): Promise<[protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IUpdateRowRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IUpdateRowRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IUpdateRowRequest \| undefined, {} \| undefined]>

updateRow(request, options, callback)

updateRow(request: protos.google.area120.tables.v1alpha1.IUpdateRowRequest, options: CallOptions, callback: Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IUpdateRowRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IUpdateRowRequest`
options	`CallOptions`
callback	`Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IUpdateRowRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateRow(request, callback)

updateRow(request: protos.google.area120.tables.v1alpha1.IUpdateRowRequest, callback: Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IUpdateRowRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.area120.tables.v1alpha1.IUpdateRowRequest`
callback	`Callback<protos.google.area120.tables.v1alpha1.IRow, protos.google.area120.tables.v1alpha1.IUpdateRowRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

workspacePath(workspace)

workspacePath(workspace: string): string;

Return a fully-qualified workspace resource name string.

Parameter

Name	Description
workspace	`string`

Returns

Type	Description
string	{string} Resource name string.