@google-cloud/discoveryengine 1.1.0 → 1.2.0

package/build/src/v1alpha/user_event_service_client.d.ts

@@ -0,0 +1,853 @@
+import type * as gax from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, LocationsClient, LocationProtos } from 'google-gax';
+import * as protos from '../../protos/protos';
+/**
+ *  Service for ingesting end user actions on a website to Discovery Engine API.
+ * @class
+ * @memberof v1alpha
+ */
+export declare class UserEventServiceClient {
+    private _terminated;
+    private _opts;
+    private _providedCustomServicePath;
+    private _gaxModule;
+    private _gaxGrpc;
+    private _protos;
+    private _defaults;
+    auth: gax.GoogleAuth;
+    descriptors: Descriptors;
+    warn: (code: string, message: string, warnType?: string) => void;
+    innerApiCalls: {
+        [name: string]: Function;
+    };
+    locationsClient: LocationsClient;
+    pathTemplates: {
+        [name: string]: gax.PathTemplate;
+    };
+    operationsClient: gax.OperationsClient;
+    userEventServiceStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of UserEventServiceClient.
+     *
+     * @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://developers.google.com/identity/protocols/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 UserEventServiceClient({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.
+     * @returns {string} The DNS address for this service.
+     */
+    static get servicePath(): string;
+    /**
+     * The DNS address for this API service - same as servicePath(),
+     * exists for compatibility reasons.
+     * @returns {string} The DNS address for this service.
+     */
+    static get apiEndpoint(): 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;
+    /**
+     * Writes a single user event.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent DataStore resource name, such as
+     *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+     * @param {google.cloud.discoveryengine.v1alpha.UserEvent} request.userEvent
+     *   Required. User event to write.
+     * @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.discoveryengine.v1alpha.UserEvent|UserEvent}.
+     *   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/v1alpha/user_event_service.write_user_event.js</caption>
+     * region_tag:discoveryengine_v1alpha_generated_UserEventService_WriteUserEvent_async
+     */
+    writeUserEvent(request?: protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.discoveryengine.v1alpha.IUserEvent,
+        (protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest | undefined),
+        {} | undefined
+    ]>;
+    writeUserEvent(request: protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IUserEvent, protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest | null | undefined, {} | null | undefined>): void;
+    writeUserEvent(request: protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IUserEvent, protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Writes a single user event from the browser. This uses a GET request to
+     * due to browser restriction of POST-ing to a third-party domain.
+     *
+     * This method is used only by the Discovery Engine API JavaScript pixel and
+     * Google Tag Manager. Users should not call this method directly.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent DataStore resource name, such as
+     *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+     * @param {string} request.userEvent
+     *   Required. URL encoded UserEvent proto with a length limit of 2,000,000
+     *   characters.
+     * @param {string} request.uri
+     *   The URL including cgi-parameters but excluding the hash fragment with a
+     *   length limit of 5,000 characters. This is often more useful than the
+     *   referer URL, because many browsers only send the domain for third-party
+     *   requests.
+     * @param {number} request.ets
+     *   The event timestamp in milliseconds. This prevents browser caching of
+     *   otherwise identical get requests. The name is abbreviated to reduce the
+     *   payload bytes.
+     * @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.api.HttpBody|HttpBody}.
+     *   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/v1alpha/user_event_service.collect_user_event.js</caption>
+     * region_tag:discoveryengine_v1alpha_generated_UserEventService_CollectUserEvent_async
+     */
+    collectUserEvent(request?: protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest, options?: CallOptions): Promise<[
+        protos.google.api.IHttpBody,
+        (protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest | undefined),
+        {} | undefined
+    ]>;
+    collectUserEvent(request: protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
+    collectUserEvent(request: protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Deletes permanently all user events specified by the filter provided.
+     * Depending on the number of events specified by the filter, this operation
+     * could take hours or days to complete. To test a filter, use the list
+     * command first.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name of the catalog under which the events are
+     *   created. The format is
+     *   `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
+     * @param {string} request.filter
+     *   Required. The filter string to specify the events to be deleted with a
+     *   length limit of 5,000 characters. The eligible fields for filtering are:
+     *
+     *   * `eventType`: Double quoted
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.UserEvent.event_type|UserEvent.event_type}
+     *   string.
+     *   * `eventTime`: in ISO 8601 "zulu" format.
+     *   * `userPseudoId`: Double quoted string. Specifying this will delete all
+     *     events associated with a visitor.
+     *   * `userId`: Double quoted string. Specifying this will delete all events
+     *     associated with a user.
+     *
+     *   Examples:
+     *
+     *   * Deleting all events in a time range:
+     *     `eventTime > "2012-04-23T18:25:43.511Z"
+     *     eventTime < "2012-04-23T18:30:43.511Z"`
+     *   * Deleting specific eventType:
+     *     `eventType = "search"`
+     *   * Deleting all events for a specific visitor:
+     *     `userPseudoId = "visitor1024"`
+     *   * Deleting all events inside a DataStore:
+     *     `*`
+     *
+     *   The filtering fields are assumed to have an implicit AND.
+     * @param {boolean} request.force
+     *   The `force` field is currently not supported. Purge user event requests
+     *   will permanently delete all purgeable events. Once the development is
+     *   complete:
+     *   If `force` is set to false, the method will return the expected
+     *   purge count without deleting any user events. This field will default to
+     *   false if not included in the 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
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1alpha/user_event_service.purge_user_events.js</caption>
+     * region_tag:discoveryengine_v1alpha_generated_UserEventService_PurgeUserEvents_async
+     */
+    purgeUserEvents(request?: protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    purgeUserEvents(request: protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    purgeUserEvents(request: protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `purgeUserEvents()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1alpha/user_event_service.purge_user_events.js</caption>
+     * region_tag:discoveryengine_v1alpha_generated_UserEventService_PurgeUserEvents_async
+     */
+    checkPurgeUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.PurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.PurgeUserEventsMetadata>>;
+    /**
+     * Bulk import of User events. Request processing might be
+     * synchronous. Events that already exist are skipped.
+     * Use this method for backfilling historical user events.
+     *
+     * Operation.response is of type ImportResponse. Note that it is
+     * possible for a subset of the items to be successfully inserted.
+     * Operation.metadata is of type ImportMetadata.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.cloud.discoveryengine.v1alpha.ImportUserEventsRequest.InlineSource} request.inlineSource
+     *   The Inline source for the input content for UserEvents.
+     * @param {google.cloud.discoveryengine.v1alpha.GcsSource} request.gcsSource
+     *   Cloud Storage location for the input content.
+     * @param {google.cloud.discoveryengine.v1alpha.BigQuerySource} request.bigquerySource
+     *   BigQuery input source.
+     * @param {string} request.parent
+     *   Required. Parent DataStore resource name, of the form
+     *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
+     * @param {google.cloud.discoveryengine.v1alpha.ImportErrorConfig} request.errorConfig
+     *   The desired location of errors incurred during the Import. Cannot be set
+     *   for inline user event imports.
+     * @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
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1alpha/user_event_service.import_user_events.js</caption>
+     * region_tag:discoveryengine_v1alpha_generated_UserEventService_ImportUserEvents_async
+     */
+    importUserEvents(request?: protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    importUserEvents(request: protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    importUserEvents(request: protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `importUserEvents()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1alpha/user_event_service.import_user_events.js</caption>
+     * region_tag:discoveryengine_v1alpha_generated_UserEventService_ImportUserEvents_async
+     */
+    checkImportUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.ImportUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.ImportUserEventsMetadata>>;
+    /**
+     * Gets information about a location.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Resource name for the location.
+     * @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 google.cloud.location.Location | Location}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example
+     * ```
+     * const [response] = await client.getLocation(request);
+     * ```
+     */
+    getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
+    /**
+     * Lists information about the supported locations for this service. 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.name
+     *   The resource that owns the locations collection, if applicable.
+     * @param {string} request.filter
+     *   The standard list filter.
+     * @param {number} request.pageSize
+     *   The standard list page size.
+     * @param {string} request.pageToken
+     *   The standard list page token.
+     * @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 google.cloud.location.Location | Location}. 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
+     * ```
+     * const iterable = client.listLocationsAsync(request);
+     * for await (const response of iterable) {
+     *   // process response
+     * }
+     * ```
+     */
+    listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
+    /**
+     * Gets the latest state of a long-running operation.  Clients can use this
+     * method to poll the operation result at intervals as recommended by the API
+     * service.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation resource.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     *   e.g, timeout, retries, paginations, etc. See {@link
+     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
+     *   for the details.
+     * @param {function(?Error, ?Object)=} callback
+     *   The function which will be called with the result of the API call.
+     *
+     *   The second parameter to the callback is an object representing
+     *   {@link google.longrunning.Operation | google.longrunning.Operation}.
+     * @return {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     * {@link google.longrunning.Operation | google.longrunning.Operation}.
+     * The promise has a method named "cancel" which cancels the ongoing API call.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * const name = '';
+     * const [response] = await client.getOperation({name});
+     * // doThingsWith(response)
+     * ```
+     */
+    getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
+    /**
+     * Lists operations that match the specified filter in the request. If the
+     * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
+     *
+     * For-await-of syntax is used with the iterable to recursively get response element on-demand.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation collection.
+     * @param {string} request.filter - The standard list filter.
+     * @param {number=} request.pageSize -
+     *   The maximum number of resources contained in the underlying API
+     *   response. If page streaming is performed per-resource, this
+     *   parameter does not affect the return value. If page streaming is
+     *   performed per-page, this determines the maximum number of
+     *   resources in a page.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     *   e.g, timeout, retries, paginations, etc. See {@link
+     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
+     *   details.
+     * @returns {Object}
+     *   An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * for await (const response of client.listOperationsAsync(request));
+     * // doThingsWith(response)
+     * ```
+     */
+    listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
+    /**
+     * Starts asynchronous cancellation on a long-running operation.  The server
+     * makes a best effort to cancel the operation, but success is not
+     * guaranteed.  If the server doesn't support this method, it returns
+     * `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
+     * {@link Operations.GetOperation} or
+     * other methods to check whether the cancellation succeeded or whether the
+     * operation completed despite cancellation. On successful cancellation,
+     * the operation is not deleted; instead, it becomes an operation with
+     * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
+     * 1, corresponding to `Code.CANCELLED`.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation resource to be cancelled.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     * e.g, timeout, retries, paginations, etc. See {@link
+     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
+     * details.
+     * @param {function(?Error)=} callback
+     *   The function which will be called with the result of the API call.
+     * @return {Promise} - The promise which resolves when API call finishes.
+     *   The promise has a method named "cancel" which cancels the ongoing API
+     * call.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * await client.cancelOperation({name: ''});
+     * ```
+     */
+    cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
+    /**
+     * Deletes a long-running operation. This method indicates that the client is
+     * no longer interested in the operation result. It does not cancel the
+     * operation. If the server doesn't support this method, it returns
+     * `google.rpc.Code.UNIMPLEMENTED`.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation resource to be deleted.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     * e.g, timeout, retries, paginations, etc. See {@link
+     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
+     * for the details.
+     * @param {function(?Error)=} callback
+     *   The function which will be called with the result of the API call.
+     * @return {Promise} - The promise which resolves when API call finishes.
+     *   The promise has a method named "cancel" which cancels the ongoing API
+     * call.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * await client.deleteOperation({name: ''});
+     * ```
+     */
+    deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} branch
+     * @param {string} document
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the document.
+     */
+    matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} schema
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the schema.
+     */
+    matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} branch
+     * @param {string} document
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the document from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the document.
+     */
+    matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the conversation from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreSchema resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} schema
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the schema from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the schema.
+     */
+    matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * Terminate the gRPC channel and close the client.
+     *
+     * The client will no longer be usable and all future behavior is undefined.
+     * @returns {Promise} A promise that resolves when the client is closed.
+     */
+    close(): Promise<void>;
+}