@google-cloud/chronicle
Version:
Chronicle API client for Node.js
728 lines • 80.1 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* DataTableManager provides an interface for managing data tables.
* @class
* @memberof v1
*/
export declare class DataTableServiceClient {
private _terminated;
private _opts;
private _providedCustomServicePath;
private _gaxModule;
private _gaxGrpc;
private _protos;
private _defaults;
private _universeDomain;
private _servicePath;
private _log;
auth: gax.GoogleAuth;
descriptors: Descriptors;
warn: (code: string, message: string, warnType?: string) => void;
innerApiCalls: {
[name: string]: Function;
};
pathTemplates: {
[name: string]: gax.PathTemplate;
};
dataTableServiceStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of DataTableServiceClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - 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.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - 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
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: 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 DataTableServiceClient({fallback: true}, gax);
* ```
*/
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
/**
* 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 {Promise} A promise that resolves to an authenticated service stub.
*/
initialize(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint(): string;
get universeDomain(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): string[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
* Create a new data table.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource where this data table will be created.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @param {google.cloud.chronicle.v1.DataTable} request.dataTable
* Required. The data table being created.
* @param {string} request.dataTableId
* Required. The ID to use for the data table. This is also the display name
* for the data table. It must satisfy the following requirements:
* - Starts with letter.
* - Contains only letters, numbers and underscore.
* - Must be unique and has length < 256.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.chronicle.v1.DataTable|DataTable}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.create_data_table.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_CreateDataTable_async
*/
createDataTable(request?: protos.google.cloud.chronicle.v1.ICreateDataTableRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataTable,
protos.google.cloud.chronicle.v1.ICreateDataTableRequest | undefined,
{} | undefined
]>;
createDataTable(request: protos.google.cloud.chronicle.v1.ICreateDataTableRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataTable, protos.google.cloud.chronicle.v1.ICreateDataTableRequest | null | undefined, {} | null | undefined>): void;
createDataTable(request: protos.google.cloud.chronicle.v1.ICreateDataTableRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataTable, protos.google.cloud.chronicle.v1.ICreateDataTableRequest | null | undefined, {} | null | undefined>): void;
/**
* Get data table info.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The resource name of the data table to retrieve.
* Format:
* projects/{project}/locations/{location}/instances/{instances}/dataTables/{data_table}
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.chronicle.v1.DataTable|DataTable}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.get_data_table.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_GetDataTable_async
*/
getDataTable(request?: protos.google.cloud.chronicle.v1.IGetDataTableRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataTable,
protos.google.cloud.chronicle.v1.IGetDataTableRequest | undefined,
{} | undefined
]>;
getDataTable(request: protos.google.cloud.chronicle.v1.IGetDataTableRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataTable, protos.google.cloud.chronicle.v1.IGetDataTableRequest | null | undefined, {} | null | undefined>): void;
getDataTable(request: protos.google.cloud.chronicle.v1.IGetDataTableRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataTable, protos.google.cloud.chronicle.v1.IGetDataTableRequest | null | undefined, {} | null | undefined>): void;
/**
* Update data table.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.chronicle.v1.DataTable} request.dataTable
* Required. This field is used to identify the datatable to update.
* Format:
* projects/{project}/locations/{locations}/instances/{instance}/dataTables/{data_table}
* @param {google.protobuf.FieldMask} [request.updateMask]
* Optional. The list of metadata fields to update. Currently data tables only
* support updating the `description`, `row_time_to_live` and `scope_info`
* fields. When no field mask is supplied, all non-empty fields will be
* updated. A field mask of "*" will update all fields, whether empty or not.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.chronicle.v1.DataTable|DataTable}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.update_data_table.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_UpdateDataTable_async
*/
updateDataTable(request?: protos.google.cloud.chronicle.v1.IUpdateDataTableRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataTable,
protos.google.cloud.chronicle.v1.IUpdateDataTableRequest | undefined,
{} | undefined
]>;
updateDataTable(request: protos.google.cloud.chronicle.v1.IUpdateDataTableRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataTable, protos.google.cloud.chronicle.v1.IUpdateDataTableRequest | null | undefined, {} | null | undefined>): void;
updateDataTable(request: protos.google.cloud.chronicle.v1.IUpdateDataTableRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataTable, protos.google.cloud.chronicle.v1.IUpdateDataTableRequest | null | undefined, {} | null | undefined>): void;
/**
* Delete data table.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The resource name of the data table to delete.
* Format
* projects/{project}/locations/{location}/instances/{instances}/dataTables/{data_table}
* @param {boolean} [request.force]
* Optional. If set to true, any rows under this data table will also be
* deleted. (Otherwise, the request will only work if the data table has no
* rows.)
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.delete_data_table.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_DeleteDataTable_async
*/
deleteDataTable(request?: protos.google.cloud.chronicle.v1.IDeleteDataTableRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.chronicle.v1.IDeleteDataTableRequest | undefined,
{} | undefined
]>;
deleteDataTable(request: protos.google.cloud.chronicle.v1.IDeleteDataTableRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataTableRequest | null | undefined, {} | null | undefined>): void;
deleteDataTable(request: protos.google.cloud.chronicle.v1.IDeleteDataTableRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataTableRequest | null | undefined, {} | null | undefined>): void;
/**
* Create a new data table row.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The resource id of the data table.
* Format:
* /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
* @param {google.cloud.chronicle.v1.DataTableRow} request.dataTableRow
* Required. The data table row to create.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.chronicle.v1.DataTableRow|DataTableRow}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.create_data_table_row.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_CreateDataTableRow_async
*/
createDataTableRow(request?: protos.google.cloud.chronicle.v1.ICreateDataTableRowRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataTableRow,
protos.google.cloud.chronicle.v1.ICreateDataTableRowRequest | undefined,
{} | undefined
]>;
createDataTableRow(request: protos.google.cloud.chronicle.v1.ICreateDataTableRowRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataTableRow, protos.google.cloud.chronicle.v1.ICreateDataTableRowRequest | null | undefined, {} | null | undefined>): void;
createDataTableRow(request: protos.google.cloud.chronicle.v1.ICreateDataTableRowRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataTableRow, protos.google.cloud.chronicle.v1.ICreateDataTableRowRequest | null | undefined, {} | null | undefined>): void;
/**
* Update data table row
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.chronicle.v1.DataTableRow} request.dataTableRow
* Required. Format:
* projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}
* @param {google.protobuf.FieldMask} [request.updateMask]
* Optional. The list of fields to update. Currently data table rows only
* support updating the `values` field. When no field mask is supplied, all
* non-empty fields will be updated. A field mask of "*" will update all
* fields, whether empty or not.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.chronicle.v1.DataTableRow|DataTableRow}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.update_data_table_row.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_UpdateDataTableRow_async
*/
updateDataTableRow(request?: protos.google.cloud.chronicle.v1.IUpdateDataTableRowRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataTableRow,
protos.google.cloud.chronicle.v1.IUpdateDataTableRowRequest | undefined,
{} | undefined
]>;
updateDataTableRow(request: protos.google.cloud.chronicle.v1.IUpdateDataTableRowRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataTableRow, protos.google.cloud.chronicle.v1.IUpdateDataTableRowRequest | null | undefined, {} | null | undefined>): void;
updateDataTableRow(request: protos.google.cloud.chronicle.v1.IUpdateDataTableRowRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataTableRow, protos.google.cloud.chronicle.v1.IUpdateDataTableRowRequest | null | undefined, {} | null | undefined>): void;
/**
* Get data table row
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The resource name of the data table row i,e row_id.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.chronicle.v1.DataTableRow|DataTableRow}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.get_data_table_row.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_GetDataTableRow_async
*/
getDataTableRow(request?: protos.google.cloud.chronicle.v1.IGetDataTableRowRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataTableRow,
protos.google.cloud.chronicle.v1.IGetDataTableRowRequest | undefined,
{} | undefined
]>;
getDataTableRow(request: protos.google.cloud.chronicle.v1.IGetDataTableRowRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataTableRow, protos.google.cloud.chronicle.v1.IGetDataTableRowRequest | null | undefined, {} | null | undefined>): void;
getDataTableRow(request: protos.google.cloud.chronicle.v1.IGetDataTableRowRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataTableRow, protos.google.cloud.chronicle.v1.IGetDataTableRowRequest | null | undefined, {} | null | undefined>): void;
/**
* Delete data table row.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The resource name of the data table row i,e row_id.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.delete_data_table_row.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_DeleteDataTableRow_async
*/
deleteDataTableRow(request?: protos.google.cloud.chronicle.v1.IDeleteDataTableRowRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.chronicle.v1.IDeleteDataTableRowRequest | undefined,
{} | undefined
]>;
deleteDataTableRow(request: protos.google.cloud.chronicle.v1.IDeleteDataTableRowRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataTableRowRequest | null | undefined, {} | null | undefined>): void;
deleteDataTableRow(request: protos.google.cloud.chronicle.v1.IDeleteDataTableRowRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataTableRowRequest | null | undefined, {} | null | undefined>): void;
/**
* Create data table rows in bulk.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The resource id of the data table.
* Format:
* /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
* @param {number[]} request.requests
* Required. Data table rows to create. A maximum of 1000 rows (for sync
* requests) or 2000 rows (for async requests) can be created in a single
* request. Total size of the rows should be less than 4MB.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.chronicle.v1.BulkCreateDataTableRowsResponse|BulkCreateDataTableRowsResponse}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.bulk_create_data_table_rows.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_BulkCreateDataTableRows_async
*/
bulkCreateDataTableRows(request?: protos.google.cloud.chronicle.v1.IBulkCreateDataTableRowsRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IBulkCreateDataTableRowsResponse,
(protos.google.cloud.chronicle.v1.IBulkCreateDataTableRowsRequest | undefined),
{} | undefined
]>;
bulkCreateDataTableRows(request: protos.google.cloud.chronicle.v1.IBulkCreateDataTableRowsRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IBulkCreateDataTableRowsResponse, protos.google.cloud.chronicle.v1.IBulkCreateDataTableRowsRequest | null | undefined, {} | null | undefined>): void;
bulkCreateDataTableRows(request: protos.google.cloud.chronicle.v1.IBulkCreateDataTableRowsRequest, callback: Callback<protos.google.cloud.chronicle.v1.IBulkCreateDataTableRowsResponse, protos.google.cloud.chronicle.v1.IBulkCreateDataTableRowsRequest | null | undefined, {} | null | undefined>): void;
/**
* Get data table rows in bulk.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The resource id of the data table.
* Format:
* /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
* @param {number[]} request.requests
* Required. Data table rows to get. At max 1,000 rows can be there in a
* request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.chronicle.v1.BulkGetDataTableRowsResponse|BulkGetDataTableRowsResponse}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.bulk_get_data_table_rows.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_BulkGetDataTableRows_async
*/
bulkGetDataTableRows(request?: protos.google.cloud.chronicle.v1.IBulkGetDataTableRowsRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IBulkGetDataTableRowsResponse,
protos.google.cloud.chronicle.v1.IBulkGetDataTableRowsRequest | undefined,
{} | undefined
]>;
bulkGetDataTableRows(request: protos.google.cloud.chronicle.v1.IBulkGetDataTableRowsRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IBulkGetDataTableRowsResponse, protos.google.cloud.chronicle.v1.IBulkGetDataTableRowsRequest | null | undefined, {} | null | undefined>): void;
bulkGetDataTableRows(request: protos.google.cloud.chronicle.v1.IBulkGetDataTableRowsRequest, callback: Callback<protos.google.cloud.chronicle.v1.IBulkGetDataTableRowsResponse, protos.google.cloud.chronicle.v1.IBulkGetDataTableRowsRequest | null | undefined, {} | null | undefined>): void;
/**
* Replace all existing data table rows with new data table rows.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The resource id of the data table.
* Format:
* /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
* @param {number[]} request.requests
* Required. Data table rows to replace the existing data table rows. A
* maximum of 1000 rows (for sync requests) or 2000 rows (for async requests)
* can be replaced in a single request. Total size of the rows should be less
* than 4MB.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.chronicle.v1.BulkReplaceDataTableRowsResponse|BulkReplaceDataTableRowsResponse}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.bulk_replace_data_table_rows.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_BulkReplaceDataTableRows_async
*/
bulkReplaceDataTableRows(request?: protos.google.cloud.chronicle.v1.IBulkReplaceDataTableRowsRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IBulkReplaceDataTableRowsResponse,
(protos.google.cloud.chronicle.v1.IBulkReplaceDataTableRowsRequest | undefined),
{} | undefined
]>;
bulkReplaceDataTableRows(request: protos.google.cloud.chronicle.v1.IBulkReplaceDataTableRowsRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IBulkReplaceDataTableRowsResponse, protos.google.cloud.chronicle.v1.IBulkReplaceDataTableRowsRequest | null | undefined, {} | null | undefined>): void;
bulkReplaceDataTableRows(request: protos.google.cloud.chronicle.v1.IBulkReplaceDataTableRowsRequest, callback: Callback<protos.google.cloud.chronicle.v1.IBulkReplaceDataTableRowsResponse, protos.google.cloud.chronicle.v1.IBulkReplaceDataTableRowsRequest | null | undefined, {} | null | undefined>): void;
/**
* Update data table rows in bulk.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The resource id of the data table.
* Format:
* /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
* @param {number[]} request.requests
* Required. Data table rows to update. At max 1,000 rows (or rows with size
* less than 2MB) can be there in a request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.chronicle.v1.BulkUpdateDataTableRowsResponse|BulkUpdateDataTableRowsResponse}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.bulk_update_data_table_rows.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_BulkUpdateDataTableRows_async
*/
bulkUpdateDataTableRows(request?: protos.google.cloud.chronicle.v1.IBulkUpdateDataTableRowsRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IBulkUpdateDataTableRowsResponse,
(protos.google.cloud.chronicle.v1.IBulkUpdateDataTableRowsRequest | undefined),
{} | undefined
]>;
bulkUpdateDataTableRows(request: protos.google.cloud.chronicle.v1.IBulkUpdateDataTableRowsRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IBulkUpdateDataTableRowsResponse, protos.google.cloud.chronicle.v1.IBulkUpdateDataTableRowsRequest | null | undefined, {} | null | undefined>): void;
bulkUpdateDataTableRows(request: protos.google.cloud.chronicle.v1.IBulkUpdateDataTableRowsRequest, callback: Callback<protos.google.cloud.chronicle.v1.IBulkUpdateDataTableRowsResponse, protos.google.cloud.chronicle.v1.IBulkUpdateDataTableRowsRequest | null | undefined, {} | null | undefined>): void;
/**
* Get the error for a data table operation.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. Resource name for the data table operation errors.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/dataTableOperationErrors/{data_table_operation_errors}
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.chronicle.v1.DataTableOperationErrors|DataTableOperationErrors}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.get_data_table_operation_errors.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_GetDataTableOperationErrors_async
*/
getDataTableOperationErrors(request?: protos.google.cloud.chronicle.v1.IGetDataTableOperationErrorsRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataTableOperationErrors,
(protos.google.cloud.chronicle.v1.IGetDataTableOperationErrorsRequest | undefined),
{} | undefined
]>;
getDataTableOperationErrors(request: protos.google.cloud.chronicle.v1.IGetDataTableOperationErrorsRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataTableOperationErrors, protos.google.cloud.chronicle.v1.IGetDataTableOperationErrorsRequest | null | undefined, {} | null | undefined>): void;
getDataTableOperationErrors(request: protos.google.cloud.chronicle.v1.IGetDataTableOperationErrorsRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataTableOperationErrors, protos.google.cloud.chronicle.v1.IGetDataTableOperationErrorsRequest | null | undefined, {} | null | undefined>): void;
/**
* List data tables.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource where this data table will be created.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @param {number} [request.pageSize]
* Optional. The maximum number of data tables to return. The service may
* return fewer than this value. If unspecified, at most 100 data tables will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListDataTables` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListDataTables` must match the call that provided the page
* token.
* @param {string} [request.orderBy]
* Optional. Configures ordering of DataTables in the response.
* Note: Our implementation currently supports order by "create_time asc" only
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of {@link protos.google.cloud.chronicle.v1.DataTable|DataTable}.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed and will merge results from all the pages into this array.
* Note that it can affect your quota.
* We recommend using `listDataTablesAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listDataTables(request?: protos.google.cloud.chronicle.v1.IListDataTablesRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataTable[],
protos.google.cloud.chronicle.v1.IListDataTablesRequest | null,
protos.google.cloud.chronicle.v1.IListDataTablesResponse
]>;
listDataTables(request: protos.google.cloud.chronicle.v1.IListDataTablesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataTablesRequest, protos.google.cloud.chronicle.v1.IListDataTablesResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataTable>): void;
listDataTables(request: protos.google.cloud.chronicle.v1.IListDataTablesRequest, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataTablesRequest, protos.google.cloud.chronicle.v1.IListDataTablesResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataTable>): void;
/**
* Equivalent to `listDataTables`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource where this data table will be created.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @param {number} [request.pageSize]
* Optional. The maximum number of data tables to return. The service may
* return fewer than this value. If unspecified, at most 100 data tables will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListDataTables` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListDataTables` must match the call that provided the page
* token.
* @param {string} [request.orderBy]
* Optional. Configures ordering of DataTables in the response.
* Note: Our implementation currently supports order by "create_time asc" only
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.chronicle.v1.DataTable|DataTable} 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 `listDataTablesAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listDataTablesStream(request?: protos.google.cloud.chronicle.v1.IListDataTablesRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listDataTables`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource where this data table will be created.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @param {number} [request.pageSize]
* Optional. The maximum number of data tables to return. The service may
* return fewer than this value. If unspecified, at most 100 data tables will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListDataTables` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListDataTables` must match the call that provided the page
* token.
* @param {string} [request.orderBy]
* Optional. Configures ordering of DataTables in the response.
* Note: Our implementation currently supports order by "create_time asc" only
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.chronicle.v1.DataTable|DataTable}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.list_data_tables.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_ListDataTables_async
*/
listDataTablesAsync(request?: protos.google.cloud.chronicle.v1.IListDataTablesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.chronicle.v1.IDataTable>;
/**
* List data table rows.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The resource id of the data table.
* Format:
* projects/{project}/locations/{locations}/instances/{instance}/dataTables/{data_table}
* @param {number} [request.pageSize]
* Optional. The maximum number of data table rows to return. The service may
* return fewer than this value. If unspecified, at most 100 data table rows
* will be returned. The maximum value is 1000; values above 1000 will be
* coerced to 1000.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListDataTableRows` call.
* @param {string} [request.orderBy]
* Optional. Configures ordering of DataTables in the response.
* Note: Our implementation currently supports order by "create_time asc" only
* @param {string} [request.filter]
* Optional. Filter facilitating search over data table rows. This filter
* performs a case-insensitive substring match on the row values.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of {@link protos.google.cloud.chronicle.v1.DataTableRow|DataTableRow}.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed and will merge results from all the pages into this array.
* Note that it can affect your quota.
* We recommend using `listDataTableRowsAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listDataTableRows(request?: protos.google.cloud.chronicle.v1.IListDataTableRowsRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataTableRow[],
protos.google.cloud.chronicle.v1.IListDataTableRowsRequest | null,
protos.google.cloud.chronicle.v1.IListDataTableRowsResponse
]>;
listDataTableRows(request: protos.google.cloud.chronicle.v1.IListDataTableRowsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataTableRowsRequest, protos.google.cloud.chronicle.v1.IListDataTableRowsResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataTableRow>): void;
listDataTableRows(request: protos.google.cloud.chronicle.v1.IListDataTableRowsRequest, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataTableRowsRequest, protos.google.cloud.chronicle.v1.IListDataTableRowsResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataTableRow>): void;
/**
* Equivalent to `listDataTableRows`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The resource id of the data table.
* Format:
* projects/{project}/locations/{locations}/instances/{instance}/dataTables/{data_table}
* @param {number} [request.pageSize]
* Optional. The maximum number of data table rows to return. The service may
* return fewer than this value. If unspecified, at most 100 data table rows
* will be returned. The maximum value is 1000; values above 1000 will be
* coerced to 1000.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListDataTableRows` call.
* @param {string} [request.orderBy]
* Optional. Configures ordering of DataTables in the response.
* Note: Our implementation currently supports order by "create_time asc" only
* @param {string} [request.filter]
* Optional. Filter facilitating search over data table rows. This filter
* performs a case-insensitive substring match on the row values.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.chronicle.v1.DataTableRow|DataTableRow} 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 `listDataTableRowsAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listDataTableRowsStream(request?: protos.google.cloud.chronicle.v1.IListDataTableRowsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listDataTableRows`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The resource id of the data table.
* Format:
* projects/{project}/locations/{locations}/instances/{instance}/dataTables/{data_table}
* @param {number} [request.pageSize]
* Optional. The maximum number of data table rows to return. The service may
* return fewer than this value. If unspecified, at most 100 data table rows
* will be returned. The maximum value is 1000; values above 1000 will be
* coerced to 1000.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListDataTableRows` call.
* @param {string} [request.orderBy]
* Optional. Configures ordering of DataTables in the response.
* Note: Our implementation currently supports order by "create_time asc" only
* @param {string} [request.filter]
* Optional. Filter facilitating search over data table rows. This filter
* performs a case-insensitive substring match on the row values.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.chronicle.v1.DataTableRow|DataTableRow}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/data_table_service.list_data_table_rows.js</caption>
* region_tag:chronicle_v1_generated_DataTableService_ListDataTableRows_async
*/
listDataTableRowsAsync(request?: protos.google.cloud.chronicle.v1.IListDataTableRowsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.chronicle.v1.IDataTableRow>;
/**
* Return a fully-qualified bigQueryExport resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @returns {string} Resource name string.
*/
bigQueryExportPath(project: string, location: string, instance: string): string;
/**
* Parse the project from BigQueryExport resource.
*
* @param {string} bigQueryExportName
* A fully-qualified path representing BigQueryExport resource.
* @returns {string} A string representing the project.
*/
matchProjectFromBigQueryExportName(bigQueryExportName: string): string | number;
/**
* Parse the location from BigQueryExport resource.
*
* @param {string} bigQueryExportName
* A fully-qualified path representing BigQueryExport resource.
* @returns {string} A string representing the location.
*/
matchLocationFromBigQueryExportName(bigQueryExportName: string): string | number;
/**
* Parse the instance from BigQueryExport resource.
*
* @param {st