@google-cloud/discoveryengine 0.1.0

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

@@ -0,0 +1,445 @@
+import type * as gax from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation } from 'google-gax';
+import * as protos from '../../protos/protos';
+/**
+ *  Service for ingesting end user actions on a website to Discovery Engine API.
+ * @class
+ * @memberof v1beta
+ */
+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;
+    };
+    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 | "rest"} [options.fallback] - Use HTTP fallback mode.
+     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     *     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: 'rest'}, 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}/dataStores/{data_store}`.
+     * @param {google.cloud.discoveryengine.v1beta.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 [UserEvent]{@link google.cloud.discoveryengine.v1beta.UserEvent}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/user_event_service.write_user_event.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_UserEventService_WriteUserEvent_async
+     */
+    writeUserEvent(request?: protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.discoveryengine.v1beta.IUserEvent,
+        (protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest | undefined),
+        {} | undefined
+    ]>;
+    writeUserEvent(request: protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IUserEvent, protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest | null | undefined, {} | null | undefined>): void;
+    writeUserEvent(request: protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IUserEvent, protos.google.cloud.discoveryengine.v1beta.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 3rd 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}/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 3rd 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 [HttpBody]{@link google.api.HttpBody}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/user_event_service.collect_user_event.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_UserEventService_CollectUserEvent_async
+     */
+    collectUserEvent(request?: protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest, options?: CallOptions): Promise<[
+        protos.google.api.IHttpBody,
+        (protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest | undefined),
+        {} | undefined
+    ]>;
+    collectUserEvent(request: protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
+    collectUserEvent(request: protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * 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.v1beta.ImportUserEventsRequest.InlineSource} request.inlineSource
+     *   Required. The Inline source for the input content for UserEvents.
+     * @param {google.cloud.discoveryengine.v1beta.GcsSource} request.gcsSource
+     *   Required. Google Cloud Storage location for the input content.
+     * @param {google.cloud.discoveryengine.v1beta.BigQuerySource} request.bigquerySource
+     *   Required. BigQuery input source.
+     * @param {string} request.parent
+     *   Required. Parent DataStore resource name, of the form
+     *   `projects/{project}/locations/{location}/dataStores/{data_store}`
+     * @param {google.cloud.discoveryengine.v1beta.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
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/user_event_service.import_user_events.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_UserEventService_ImportUserEvents_async
+     */
+    importUserEvents(request?: protos.google.cloud.discoveryengine.v1beta.IImportUserEventsRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.discoveryengine.v1beta.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.IImportUserEventsMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    importUserEvents(request: protos.google.cloud.discoveryengine.v1beta.IImportUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.IImportUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    importUserEvents(request: protos.google.cloud.discoveryengine.v1beta.IImportUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.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
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/user_event_service.import_user_events.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_UserEventService_ImportUserEvents_async
+     */
+    checkImportUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.ImportUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.ImportUserEventsMetadata>>;
+    /**
+     * 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 [gax.CallOptions]{@link
+     *   https://googleapis.github.io/gax-nodejs/global.html#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
+     * [google.longrunning.Operation]{@link
+     * external:"google.longrunning.Operation"}.
+     * @return {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     * [google.longrunning.Operation]{@link
+     * external:"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 [gax.CallOptions]{@link
+     *   https://googleapis.github.io/gax-nodejs/global.html#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.
+     *
+     * @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 [gax.CallOptions]{@link
+     * https://googleapis.github.io/gax-nodejs/global.html#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 [gax.CallOptions]{@link
+     * https://googleapis.github.io/gax-nodejs/global.html#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 dataStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    dataStorePath(project: string, location: string, dataStore: string): string;
+    /**
+     * Parse the project from DataStore resource.
+     *
+     * @param {string} dataStoreName
+     *   A fully-qualified path representing DataStore resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromDataStoreName(dataStoreName: string): string | number;
+    /**
+     * Parse the location from DataStore resource.
+     *
+     * @param {string} dataStoreName
+     *   A fully-qualified path representing DataStore resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromDataStoreName(dataStoreName: string): string | number;
+    /**
+     * Parse the data_store from DataStore resource.
+     *
+     * @param {string} dataStoreName
+     *   A fully-qualified path representing DataStore resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromDataStoreName(dataStoreName: string): string | number;
+    /**
+     * Return a fully-qualified document resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} branch
+     * @param {string} document
+     * @returns {string} Resource name string.
+     */
+    documentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
+    /**
+     * Parse the project from Document resource.
+     *
+     * @param {string} documentName
+     *   A fully-qualified path representing Document resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromDocumentName(documentName: string): string | number;
+    /**
+     * Parse the location from Document resource.
+     *
+     * @param {string} documentName
+     *   A fully-qualified path representing Document resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromDocumentName(documentName: string): string | number;
+    /**
+     * Parse the data_store from Document resource.
+     *
+     * @param {string} documentName
+     *   A fully-qualified path representing Document resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromDocumentName(documentName: string): string | number;
+    /**
+     * Parse the branch from Document resource.
+     *
+     * @param {string} documentName
+     *   A fully-qualified path representing Document resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromDocumentName(documentName: string): string | number;
+    /**
+     * Parse the document from Document resource.
+     *
+     * @param {string} documentName
+     *   A fully-qualified path representing Document resource.
+     * @returns {string} A string representing the document.
+     */
+    matchDocumentFromDocumentName(documentName: 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>;
+}