@google-cloud/chronicle
Version:
Chronicle API client for Node.js
832 lines • 54.9 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';
/**
* DataAccessControlService exposes resources and endpoints related to data
* access control.
* @class
* @memberof v1
*/
export declare class DataAccessControlServiceClient {
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;
};
dataAccessControlServiceStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of DataAccessControlServiceClient.
*
* @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 DataAccessControlServiceClient({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;
/**
* Creates a data access label.
* Data access labels are applied to incoming event data and selected in data
* access scopes (another resource), and only users with scopes containing the
* label can see data with that label. Currently, the data access label
* resource only includes custom labels, which are labels that correspond
* to UDM queries over event data.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource where this Data Access Label will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* @param {google.cloud.chronicle.v1.DataAccessLabel} request.dataAccessLabel
* Required. Data access label to create.
* @param {string} request.dataAccessLabelId
* Required. The ID to use for the data access label, which will become the
* label's display name and the final component of the label's resource name.
* The maximum number of characters should be 63. Regex pattern is as per AIP:
* https://google.aip.dev/122#resource-id-segments
* @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.DataAccessLabel|DataAccessLabel}.
* 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_access_control_service.create_data_access_label.js</caption>
* region_tag:chronicle_v1_generated_DataAccessControlService_CreateDataAccessLabel_async
*/
createDataAccessLabel(request?: protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataAccessLabel,
(protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest | undefined),
{} | undefined
]>;
createDataAccessLabel(request: protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
createDataAccessLabel(request: protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.ICreateDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets a data access label.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The ID of the data access label to retrieve.
* Format:
* `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
* @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.DataAccessLabel|DataAccessLabel}.
* 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_access_control_service.get_data_access_label.js</caption>
* region_tag:chronicle_v1_generated_DataAccessControlService_GetDataAccessLabel_async
*/
getDataAccessLabel(request?: protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataAccessLabel,
protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest | undefined,
{} | undefined
]>;
getDataAccessLabel(request: protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
getDataAccessLabel(request: protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IGetDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
/**
* Updates a data access label.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.chronicle.v1.DataAccessLabel} request.dataAccessLabel
* Required. The data access label to update.
*
* The label's `name` field is used to identify the label to update.
* Format:
* `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
* @param {google.protobuf.FieldMask} request.updateMask
* The list of fields to update. If not included, all fields with a non-empty
* value will be overwritten. Currently, only the description and definition
* fields are supported for update; an update call that attempts to update any
* other fields will return INVALID_ARGUMENT.
* @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.DataAccessLabel|DataAccessLabel}.
* 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_access_control_service.update_data_access_label.js</caption>
* region_tag:chronicle_v1_generated_DataAccessControlService_UpdateDataAccessLabel_async
*/
updateDataAccessLabel(request?: protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataAccessLabel,
(protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest | undefined),
{} | undefined
]>;
updateDataAccessLabel(request: protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
updateDataAccessLabel(request: protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessLabel, protos.google.cloud.chronicle.v1.IUpdateDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes a data access label. When a label is deleted, new
* data that enters in the system will not receive the label, but the label
* will not be removed from old data that still refers to it.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The ID of the data access label to delete.
* Format:
* `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
* @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_access_control_service.delete_data_access_label.js</caption>
* region_tag:chronicle_v1_generated_DataAccessControlService_DeleteDataAccessLabel_async
*/
deleteDataAccessLabel(request?: protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest | undefined),
{} | undefined
]>;
deleteDataAccessLabel(request: protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
deleteDataAccessLabel(request: protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessLabelRequest | null | undefined, {} | null | undefined>): void;
/**
* Creates a data access scope.
* Data access scope is a combination of allowed and denied labels attached
* to a permission group. If a scope has allowed labels A and B and denied
* labels C and D, then the group of people attached to the scope
* will have permissions to see all events labeled with A or B (or both) and
* not labeled with either C or D.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource where this Data Access Scope will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* @param {google.cloud.chronicle.v1.DataAccessScope} request.dataAccessScope
* Required. Data access scope to create.
* @param {string} request.dataAccessScopeId
* Required. The user provided scope id which will become the last part of the
* name of the scope resource. Needs to be compliant with
* https://google.aip.dev/122
* @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.DataAccessScope|DataAccessScope}.
* 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_access_control_service.create_data_access_scope.js</caption>
* region_tag:chronicle_v1_generated_DataAccessControlService_CreateDataAccessScope_async
*/
createDataAccessScope(request?: protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataAccessScope,
(protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest | undefined),
{} | undefined
]>;
createDataAccessScope(request: protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
createDataAccessScope(request: protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.ICreateDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
/**
* Retrieves an existing data access scope.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The ID of the data access scope to retrieve.
* Format:
* `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
* @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.DataAccessScope|DataAccessScope}.
* 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_access_control_service.get_data_access_scope.js</caption>
* region_tag:chronicle_v1_generated_DataAccessControlService_GetDataAccessScope_async
*/
getDataAccessScope(request?: protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataAccessScope,
protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest | undefined,
{} | undefined
]>;
getDataAccessScope(request: protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
getDataAccessScope(request: protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IGetDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
/**
* Updates a data access scope.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.chronicle.v1.DataAccessScope} request.dataAccessScope
* Required. The data access scope to update.
*
* The scope's `name` field is used to identify the scope to update.
* Format:
* `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
* @param {google.protobuf.FieldMask} request.updateMask
* The list of fields to update. If not included, all fields with a non-empty
* value will be overwritten. Currently, only the description, the allowed
* and denied labels list fields are supported for update;
* an update call that attempts to update any
* other fields will return INVALID_ARGUMENT.
* @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.DataAccessScope|DataAccessScope}.
* 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_access_control_service.update_data_access_scope.js</caption>
* region_tag:chronicle_v1_generated_DataAccessControlService_UpdateDataAccessScope_async
*/
updateDataAccessScope(request?: protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataAccessScope,
(protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest | undefined),
{} | undefined
]>;
updateDataAccessScope(request: protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest, options: CallOptions, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
updateDataAccessScope(request: protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest, callback: Callback<protos.google.cloud.chronicle.v1.IDataAccessScope, protos.google.cloud.chronicle.v1.IUpdateDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes a data access scope.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The ID of the data access scope to delete.
* Format:
* `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
* @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_access_control_service.delete_data_access_scope.js</caption>
* region_tag:chronicle_v1_generated_DataAccessControlService_DeleteDataAccessScope_async
*/
deleteDataAccessScope(request?: protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest | undefined),
{} | undefined
]>;
deleteDataAccessScope(request: protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
deleteDataAccessScope(request: protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.chronicle.v1.IDeleteDataAccessScopeRequest | null | undefined, {} | null | undefined>): void;
/**
* Lists all data access labels for the customer.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource where this data access label will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* @param {number} request.pageSize
* The maximum number of data access labels to return. The service may return
* fewer than this value. If unspecified, at most 100 data access labels will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
* @param {string} request.pageToken
* A page token, received from a previous `ListDataAccessLabelsRequest` call.
* Provide this to retrieve the subsequent page.
* @param {string} [request.filter]
* Optional. A filter which should follow the guidelines of AIP-160.
* Supports filtering on all fieds of DataAccessLabel and all operations as
* mentioned in https://google.aip.dev/160.
* example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
* display_name:\"-21-1\"".
* @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.DataAccessLabel|DataAccessLabel}.
* 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 `listDataAccessLabelsAsync()`
* 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.
*/
listDataAccessLabels(request?: protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataAccessLabel[],
protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest | null,
protos.google.cloud.chronicle.v1.IListDataAccessLabelsResponse
]>;
listDataAccessLabels(request: protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, protos.google.cloud.chronicle.v1.IListDataAccessLabelsResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessLabel>): void;
listDataAccessLabels(request: protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, protos.google.cloud.chronicle.v1.IListDataAccessLabelsResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessLabel>): void;
/**
* Equivalent to `listDataAccessLabels`, 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 access label will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* @param {number} request.pageSize
* The maximum number of data access labels to return. The service may return
* fewer than this value. If unspecified, at most 100 data access labels will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
* @param {string} request.pageToken
* A page token, received from a previous `ListDataAccessLabelsRequest` call.
* Provide this to retrieve the subsequent page.
* @param {string} [request.filter]
* Optional. A filter which should follow the guidelines of AIP-160.
* Supports filtering on all fieds of DataAccessLabel and all operations as
* mentioned in https://google.aip.dev/160.
* example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
* display_name:\"-21-1\"".
* @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.DataAccessLabel|DataAccessLabel} 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 `listDataAccessLabelsAsync()`
* 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.
*/
listDataAccessLabelsStream(request?: protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listDataAccessLabels`, 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 access label will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* @param {number} request.pageSize
* The maximum number of data access labels to return. The service may return
* fewer than this value. If unspecified, at most 100 data access labels will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
* @param {string} request.pageToken
* A page token, received from a previous `ListDataAccessLabelsRequest` call.
* Provide this to retrieve the subsequent page.
* @param {string} [request.filter]
* Optional. A filter which should follow the guidelines of AIP-160.
* Supports filtering on all fieds of DataAccessLabel and all operations as
* mentioned in https://google.aip.dev/160.
* example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
* display_name:\"-21-1\"".
* @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.DataAccessLabel|DataAccessLabel}. 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_access_control_service.list_data_access_labels.js</caption>
* region_tag:chronicle_v1_generated_DataAccessControlService_ListDataAccessLabels_async
*/
listDataAccessLabelsAsync(request?: protos.google.cloud.chronicle.v1.IListDataAccessLabelsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.chronicle.v1.IDataAccessLabel>;
/**
* Lists all existing data access scopes for the customer.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource where this data access scope will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* @param {number} request.pageSize
* The maximum number of data access scopes to return. The service may return
* fewer than this value. If unspecified, at most 100 data access scopes will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
* @param {string} request.pageToken
* A page token, received from a previous `ListDataAccessScopesRequest` call.
* Provide this to retrieve the subsequent page.
* @param {string} [request.filter]
* Optional. A filter which should follow the guidelines of AIP-160.
* Supports filtering on all fieds of DataAccessScope and all operations as
* mentioned in https://google.aip.dev/160.
* example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
* display_name:\"-21-1\"".
* @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.DataAccessScope|DataAccessScope}.
* 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 `listDataAccessScopesAsync()`
* 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.
*/
listDataAccessScopes(request?: protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, options?: CallOptions): Promise<[
protos.google.cloud.chronicle.v1.IDataAccessScope[],
protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest | null,
protos.google.cloud.chronicle.v1.IListDataAccessScopesResponse
]>;
listDataAccessScopes(request: protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, protos.google.cloud.chronicle.v1.IListDataAccessScopesResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessScope>): void;
listDataAccessScopes(request: protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, callback: PaginationCallback<protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, protos.google.cloud.chronicle.v1.IListDataAccessScopesResponse | null | undefined, protos.google.cloud.chronicle.v1.IDataAccessScope>): void;
/**
* Equivalent to `listDataAccessScopes`, 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 access scope will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* @param {number} request.pageSize
* The maximum number of data access scopes to return. The service may return
* fewer than this value. If unspecified, at most 100 data access scopes will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
* @param {string} request.pageToken
* A page token, received from a previous `ListDataAccessScopesRequest` call.
* Provide this to retrieve the subsequent page.
* @param {string} [request.filter]
* Optional. A filter which should follow the guidelines of AIP-160.
* Supports filtering on all fieds of DataAccessScope and all operations as
* mentioned in https://google.aip.dev/160.
* example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
* display_name:\"-21-1\"".
* @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.DataAccessScope|DataAccessScope} 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 `listDataAccessScopesAsync()`
* 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.
*/
listDataAccessScopesStream(request?: protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listDataAccessScopes`, 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 access scope will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* @param {number} request.pageSize
* The maximum number of data access scopes to return. The service may return
* fewer than this value. If unspecified, at most 100 data access scopes will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
* @param {string} request.pageToken
* A page token, received from a previous `ListDataAccessScopesRequest` call.
* Provide this to retrieve the subsequent page.
* @param {string} [request.filter]
* Optional. A filter which should follow the guidelines of AIP-160.
* Supports filtering on all fieds of DataAccessScope and all operations as
* mentioned in https://google.aip.dev/160.
* example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
* display_name:\"-21-1\"".
* @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.DataAccessScope|DataAccessScope}. 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_access_control_service.list_data_access_scopes.js</caption>
* region_tag:chronicle_v1_generated_DataAccessControlService_ListDataAccessScopes_async
*/
listDataAccessScopesAsync(request?: protos.google.cloud.chronicle.v1.IListDataAccessScopesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.chronicle.v1.IDataAccessScope>;
/**
* Return a fully-qualified dataAccessLabel resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @param {string} data_access_label
* @returns {string} Resource name string.
*/
dataAccessLabelPath(project: string, location: string, instance: string, dataAccessLabel: string): string;
/**
* Parse the project from DataAccessLabel resource.
*
* @param {string} dataAccessLabelName
* A fully-qualified path representing DataAccessLabel resource.
* @returns {string} A string representing the project.
*/
matchProjectFromDataAccessLabelName(dataAccessLabelName: string): string | number;
/**
* Parse the location from DataAccessLabel resource.
*
* @param {string} dataAccessLabelName
* A fully-qualified path representing DataAccessLabel resource.
* @returns {string} A string representing the location.
*/
matchLocationFromDataAccessLabelName(dataAccessLabelName: string): string | number;
/**
* Parse the instance from DataAccessLabel resource.
*
* @param {string} dataAccessLabelName
* A fully-qualified path representing DataAccessLabel resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromDataAccessLabelName(dataAccessLabelName: string): string | number;
/**
* Parse the data_access_label from DataAccessLabel resource.
*
* @param {string} dataAccessLabelName
* A fully-qualified path representing DataAccessLabel resource.
* @returns {string} A string representing the data_access_label.
*/
matchDataAccessLabelFromDataAccessLabelName(dataAccessLabelName: string): string | number;
/**
* Return a fully-qualified dataAccessScope resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @param {string} data_access_scope
* @returns {string} Resource name string.
*/
dataAccessScopePath(project: string, location: string, instance: string, dataAccessScope: string): string;
/**
* Parse the project from DataAccessScope resource.
*
* @param {string} dataAccessScopeName
* A fully-qualified path representing DataAccessScope resource.
* @returns {string} A string representing the project.
*/
matchProjectFromDataAccessScopeName(dataAccessScopeName: string): string | number;
/**
* Parse the location from DataAccessScope resource.
*
* @param {string} dataAccessScopeName
* A fully-qualified path representing DataAccessScope resource.
* @returns {string} A string representing the location.
*/
matchLocationFromDataAccessScopeName(dataAccessScopeName: string): string | number;
/**
* Parse the instance from DataAccessScope resource.
*
* @param {string} dataAccessScopeName
* A fully-qualified path representing DataAccessScope resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromDataAccessScopeName(dataAccessScopeName: string): string | number;
/**
* Parse the data_access_scope from DataAccessScope resource.
*
* @param {string} dataAccessScopeName
* A fully-qualified path representing DataAccessScope resource.
* @returns {string} A string representing the data_access_scope.
*/
matchDataAccessScopeFromDataAccessScopeName(dataAccessScopeName: string): string | number;
/**
* Return a fully-qualified instance resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @returns {string} Resource name string.
*/
instancePath(project: string, location: string, instance: string): string;
/**
* Parse the project from Instance resource.
*
* @param {string} instanceName
* A fully-qualified path representing Instance resource.
* @returns {string} A string representing the project.
*/
matchProjectFromInstanceName(instanceName: string): string | number;
/**
* Parse the location from Instance resource.
*
* @param {string} instanceName
* A fully-qualified path representing Instance resource.
* @returns {string} A string representing the location.
*/
matchLocationFromInstanceName(instanceName: string): string | number;
/**
* Parse the instance from Instance resource.
*
* @param {string} instanceName
* A fully-qualified path representing Instance resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromInstanceName(instanceName: string): string | number;
/**
* Return a fully-qualified location resource name string.
*
* @param {string} project
* @param {string} location
* @returns {string} Resource name string.
*/
locationPath(project: string, location: string): string;
/**
* Parse the project from Location resource.
*
* @param {string} locationName
* A fully-qualified path representing Location resource.
* @returns {string} A string representing the project.
*/
matchProjectFromLocationName(locationName: string): string | number;
/**
* Parse the location from Location resource.
*
* @param {string} locationName
* A fully-qualified path representing Location resource.
* @returns {string} A string representing the location.
*/
matchLocationFromLocationName(locationName: string): string | number;
/**
* Return a fully-qualified project resource name string.
*
* @param {string} project
* @returns {string} Resource name string.
*/
projectPath(project: string): string;
/**
* Parse the project from Project resource.
*
* @param {string} projectName
* A fully-qualified path representing Project resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectName(projectName: string): string | number;
/**
* Return a fully-qualified referenceList resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @param {string} reference_list
* @returns {string} Resource name string.
*/
referenceListPath(project: string, location: string, instance: string, referenceList: string): string;
/**
* Parse the project from ReferenceList resource.
*
* @param {string} referenceListName
* A fully-qualified path representing ReferenceList resource.
* @returns {string} A string representing the project.
*/
matchProjectFromReferenceListName(referenceListName: string): string | number;
/**
* Parse the location from ReferenceList resource.
*
* @param {string} referenceListName
* A fully-qualified path representing ReferenceList resource.
* @returns {string} A string representing the location.
*/
matchLocationFromReferenceListName(referenceListName: string): string | number;
/**
* Parse the instance from ReferenceList resource.
*
* @param {string} referenceListName
* A fully-qualified path representing ReferenceList resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromReferenceListName(referenceListName: string): string | number;
/**
* Parse the reference_list from ReferenceList resource.
*
* @param {string} referenceListName
* A fully-qualified path representing ReferenceList resource.
* @returns {string} A string representing the reference_list.
*/
matchReferenceListFromReferenceListName(referenceListName: string): string | number;
/**
* Return a fully-qualified retrohunt resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @param {string} rule
* @param {string} retrohunt
* @returns {string} Resource name string.
*/
retrohuntPath(project: string, location: string, instance: string, rule: string, retrohunt: string): string;
/**
* Parse the project from Retrohunt resource.
*
* @param {string} retrohuntName
* A fully-qualified path representing Retrohunt resource.
* @returns {string} A string representing the project.
*/
matchProjectFromRetrohuntName(retrohuntName: string): string | number;
/**
* Parse the location from Retrohunt resource.
*
* @param {string} retrohuntName
* A fully-qualified path representing Retrohunt resource.
* @returns {string} A string representing the location.
*/
matchLocationFromRetrohuntName(retrohuntName: string): string | number;
/**
* Parse the instance from Retrohunt resource.
*
* @param {string} retrohuntName
* A fully-qualified path representing Retrohunt resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromRetrohuntName(retrohuntName: string): string | number;
/**
* Parse the rule from Retrohunt resource.
*
* @param {string} retrohuntName
* A fully-qualified path representing Retrohunt resource.
* @returns {string} A string representing the rule.
*/
matchRuleFromRetrohuntName(retrohuntName: string): string | number;
/**
* Parse the retrohunt from Retrohunt resource.
*
* @param {string} retrohuntName
* A fully-qualified path representing Retrohunt resource.
* @returns {string} A string representing the retrohunt.
*/
matchRetrohuntFromRetrohuntName(retrohuntName: string): string | number;
/**
* Return a fully-qualified rule resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
*