TablesServiceClient - Documentation

Constructor

new TablesServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of TablesServiceClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new TablesServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

close() → {Promise}

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	A promise that resolves when the client is closed.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

initialize() → {Promise}

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	A promise that resolves to an authenticated service stub.

listRowsAsync(request, optionsopt) → {Object}

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 Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The parent table. Format: tables/{table}
`pageSize`	number		The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.
`pageToken`	string		A page token, received from a previous `ListRows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRows` must match the call that provided the page token.
`view`	google.area120.tables.v1alpha1.View	<optional>	Optional. Column key to use for values in the row. Defaults to user entered name.
`filter`	string	<optional>	Optional. Raw text query to search for in rows of the table. Special characters must be escaped. Logical operators and field specific filtering not supported.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent table.
   *  Format: tables/{table}
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of rows to return. The service may return fewer than
   *  this value.
   *  If unspecified, at most 50 rows are returned. The maximum value is 1,000;
   *  values above 1,000 are coerced to 1,000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListRows` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListRows` must match
   *  the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Column key to use for values in the row.
   *  Defaults to user entered name.
   */
  // const view = {}
  /**
   *  Optional. Raw text query to search for in rows of the table.
   *  Special characters must be escaped. Logical operators and field specific
   *  filtering not supported.
   */
  // const filter = 'abc123'

  // Imports the Tables library
  const {TablesServiceClient} = require('@google/area120-tables').v1alpha1;

  // Instantiates a client
  const tablesClient = new TablesServiceClient();

  async function callListRows() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = tablesClient.listRowsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListRows();

listRowsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The parent table. Format: tables/{table}
`pageSize`	number		The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.
`pageToken`	string		A page token, received from a previous `ListRows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRows` must match the call that provided the page token.
`view`	google.area120.tables.v1alpha1.View	<optional>	Optional. Column key to use for values in the row. Defaults to user entered name.
`filter`	string	<optional>	Optional. Raw text query to search for in rows of the table. Special characters must be escaped. Logical operators and field specific filtering not supported.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
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 for more details and examples.

listTablesAsync(request, optionsopt) → {Object}

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 Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

pageSize

number

The maximum number of tables to return. The service may return fewer than this value.

If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.

pageToken

string

A page token, received from a previous ListTables call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTables must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The maximum number of tables to return. The service may return fewer than
   *  this value.
   *  If unspecified, at most 20 tables are returned. The maximum value is 100;
   *  values above 100 are coerced to 100.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListTables` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListTables` must match
   *  the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Tables library
  const {TablesServiceClient} = require('@google/area120-tables').v1alpha1;

  // Instantiates a client
  const tablesClient = new TablesServiceClient();

  async function callListTables() {
    // Construct request
    const request = {
    };

    // Run request
    const iterable = tablesClient.listTablesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListTables();

listTablesStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

pageSize

number

The maximum number of tables to return. The service may return fewer than this value.

If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.

pageToken

string

A page token, received from a previous ListTables call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTables must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
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 for more details and examples.

listWorkspacesAsync(request, optionsopt) → {Object}

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 Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

pageSize

number

The maximum number of workspaces to return. The service may return fewer than this value.

If unspecified, at most 10 workspaces are returned. The maximum value is 25; values above 25 are coerced to 25.

pageToken

string

A page token, received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The maximum number of workspaces to return. The service may return fewer
   *  than this value.
   *  If unspecified, at most 10 workspaces are returned. The maximum value is
   *  25; values above 25 are coerced to 25.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListWorkspaces` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListWorkspaces` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Tables library
  const {TablesServiceClient} = require('@google/area120-tables').v1alpha1;

  // Instantiates a client
  const tablesClient = new TablesServiceClient();

  async function callListWorkspaces() {
    // Construct request
    const request = {
    };

    // Run request
    const iterable = tablesClient.listWorkspacesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListWorkspaces();

listWorkspacesStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

pageSize

number

The maximum number of workspaces to return. The service may return fewer than this value.

If unspecified, at most 10 workspaces are returned. The maximum value is 25; values above 25 are coerced to 25.

pageToken

string

A page token, received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
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 for more details and examples.

matchRowFromRowName(rowName) → {string}

Parse the row from Row resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the row.

matchTableFromRowName(rowName) → {string}

Parse the table from Row resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the table.

matchTableFromTableName(tableName) → {string}

Parse the table from Table resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the table.

matchWorkspaceFromWorkspaceName(workspaceName) → {string}

Parse the workspace from Workspace resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the workspace.

rowPath(table, row) → {string}

Return a fully-qualified row resource name string.

Parameters:

Name	Type	Description
`table`	string
`row`	string

Returns:

Type	Description
string	Resource name string.

tablePath(table) → {string}

Return a fully-qualified table resource name string.

Parameters:

Name	Type	Description
`table`	string

Returns:

Type	Description
string	Resource name string.

workspacePath(workspace) → {string}

Return a fully-qualified workspace resource name string.

Parameters:

Name	Type	Description
`workspace`	string

Returns:

Type	Description
string	Resource name string.