adaptation_client.d.ts 24.9 KB
/// <reference types="node" />
import * as gax from 'google-gax';
import { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Service that implements Google Cloud Speech Adaptation API.
 * @class
 * @memberof v1p1beta1
 */
export declare class AdaptationClient {
    private _terminated;
    private _opts;
    private _gaxModule;
    private _gaxGrpc;
    private _protos;
    private _defaults;
    auth: gax.GoogleAuth;
    descriptors: Descriptors;
    innerApiCalls: {
        [name: string]: Function;
    };
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    adaptationStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of AdaptationClient.
     *
     * @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/master/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 fallback mode.
     *     In fallback mode, a special browser-compatible transport implementation is used
     *     instead of gRPC transport. In browser context (if the `window` object is defined)
     *     the fallback mode is enabled automatically; set `options.fallback` to `false`
     *     if you need to override this behavior.
     */
    constructor(opts?: ClientOptions);
    /**
     * 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;
    createPhraseSet(request: protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest | undefined, {} | undefined]>;
    createPhraseSet(request: protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest | null | undefined, {} | null | undefined>): void;
    createPhraseSet(request: protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.ICreatePhraseSetRequest | null | undefined, {} | null | undefined>): void;
    getPhraseSet(request: protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest | undefined, {} | undefined]>;
    getPhraseSet(request: protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest | null | undefined, {} | null | undefined>): void;
    getPhraseSet(request: protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IGetPhraseSetRequest | null | undefined, {} | null | undefined>): void;
    updatePhraseSet(request: protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest | undefined, {} | undefined]>;
    updatePhraseSet(request: protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest | null | undefined, {} | null | undefined>): void;
    updatePhraseSet(request: protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.IPhraseSet, protos.google.cloud.speech.v1p1beta1.IUpdatePhraseSetRequest | null | undefined, {} | null | undefined>): void;
    deletePhraseSet(request: protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest | undefined, {} | undefined]>;
    deletePhraseSet(request: protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest | null | undefined, {} | null | undefined>): void;
    deletePhraseSet(request: protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeletePhraseSetRequest | null | undefined, {} | null | undefined>): void;
    createCustomClass(request: protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass, (protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest | undefined), {} | undefined]>;
    createCustomClass(request: protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest | null | undefined, {} | null | undefined>): void;
    createCustomClass(request: protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.ICreateCustomClassRequest | null | undefined, {} | null | undefined>): void;
    getCustomClass(request: protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest | undefined, {} | undefined]>;
    getCustomClass(request: protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest | null | undefined, {} | null | undefined>): void;
    getCustomClass(request: protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IGetCustomClassRequest | null | undefined, {} | null | undefined>): void;
    updateCustomClass(request: protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass, (protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest | undefined), {} | undefined]>;
    updateCustomClass(request: protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest, options: CallOptions, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest | null | undefined, {} | null | undefined>): void;
    updateCustomClass(request: protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest, callback: Callback<protos.google.cloud.speech.v1p1beta1.ICustomClass, protos.google.cloud.speech.v1p1beta1.IUpdateCustomClassRequest | null | undefined, {} | null | undefined>): void;
    deleteCustomClass(request: protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest | undefined), {} | undefined]>;
    deleteCustomClass(request: protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest | null | undefined, {} | null | undefined>): void;
    deleteCustomClass(request: protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.speech.v1p1beta1.IDeleteCustomClassRequest | null | undefined, {} | null | undefined>): void;
    listPhraseSet(request: protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.IPhraseSet[], protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest | null, protos.google.cloud.speech.v1p1beta1.IListPhraseSetResponse]>;
    listPhraseSet(request: protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, protos.google.cloud.speech.v1p1beta1.IListPhraseSetResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.IPhraseSet>): void;
    listPhraseSet(request: protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, callback: PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, protos.google.cloud.speech.v1p1beta1.IListPhraseSetResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.IPhraseSet>): void;
    /**
     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent, which owns this collection of phrase set.
     *   Format:
     *   projects/{project}/locations/{location}
     * @param {number} request.pageSize
     *   The maximum number of phrase sets to return. The service may return
     *   fewer than this value. If unspecified, at most 50 phrase sets 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 `ListPhraseSet` call.
     *   Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to `ListPhraseSet` must
     *   match the call that provided the page token.
     * @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 [PhraseSet]{@link google.cloud.speech.v1p1beta1.PhraseSet} 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 `listPhraseSetAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the
     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
     *   for more details and examples.
     */
    listPhraseSetStream(request?: protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listPhraseSet`, 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, which owns this collection of phrase set.
     *   Format:
     *   projects/{project}/locations/{location}
     * @param {number} request.pageSize
     *   The maximum number of phrase sets to return. The service may return
     *   fewer than this value. If unspecified, at most 50 phrase sets 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 `ListPhraseSet` call.
     *   Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to `ListPhraseSet` must
     *   match the call that provided the 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 [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
     *   When you iterate the returned iterable, each element will be an object representing
     *   [PhraseSet]{@link google.cloud.speech.v1p1beta1.PhraseSet}. The API will be called under the hood as needed, once per the page,
     *   so you can stop the iteration when you don't need more results.
     *   Please see the
     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
     *   for more details and examples.
     * @example
     * const iterable = client.listPhraseSetAsync(request);
     * for await (const response of iterable) {
     *   // process response
     * }
     */
    listPhraseSetAsync(request?: protos.google.cloud.speech.v1p1beta1.IListPhraseSetRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.speech.v1p1beta1.IPhraseSet>;
    listCustomClasses(request: protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, options?: CallOptions): Promise<[protos.google.cloud.speech.v1p1beta1.ICustomClass[], protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest | null, protos.google.cloud.speech.v1p1beta1.IListCustomClassesResponse]>;
    listCustomClasses(request: protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, protos.google.cloud.speech.v1p1beta1.IListCustomClassesResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.ICustomClass>): void;
    listCustomClasses(request: protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, callback: PaginationCallback<protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, protos.google.cloud.speech.v1p1beta1.IListCustomClassesResponse | null | undefined, protos.google.cloud.speech.v1p1beta1.ICustomClass>): void;
    /**
     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent, which owns this collection of custom classes.
     *   Format:
     *   {api_version}/projects/{project}/locations/{location}/customClasses
     * @param {number} request.pageSize
     *   The maximum number of custom classes to return. The service may return
     *   fewer than this value. If unspecified, at most 50 custom classes 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 `ListCustomClass` call.
     *   Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to `ListCustomClass` must
     *   match the call that provided the page token.
     * @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 [CustomClass]{@link google.cloud.speech.v1p1beta1.CustomClass} 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 `listCustomClassesAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the
     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
     *   for more details and examples.
     */
    listCustomClassesStream(request?: protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listCustomClasses`, 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, which owns this collection of custom classes.
     *   Format:
     *   {api_version}/projects/{project}/locations/{location}/customClasses
     * @param {number} request.pageSize
     *   The maximum number of custom classes to return. The service may return
     *   fewer than this value. If unspecified, at most 50 custom classes 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 `ListCustomClass` call.
     *   Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to `ListCustomClass` must
     *   match the call that provided the 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 [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
     *   When you iterate the returned iterable, each element will be an object representing
     *   [CustomClass]{@link google.cloud.speech.v1p1beta1.CustomClass}. The API will be called under the hood as needed, once per the page,
     *   so you can stop the iteration when you don't need more results.
     *   Please see the
     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
     *   for more details and examples.
     * @example
     * const iterable = client.listCustomClassesAsync(request);
     * for await (const response of iterable) {
     *   // process response
     * }
     */
    listCustomClassesAsync(request?: protos.google.cloud.speech.v1p1beta1.IListCustomClassesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.speech.v1p1beta1.ICustomClass>;
    /**
     * Return a fully-qualified customClass resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} custom_class
     * @returns {string} Resource name string.
     */
    customClassPath(project: string, location: string, customClass: string): string;
    /**
     * Parse the project from CustomClass resource.
     *
     * @param {string} customClassName
     *   A fully-qualified path representing CustomClass resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromCustomClassName(customClassName: string): string | number;
    /**
     * Parse the location from CustomClass resource.
     *
     * @param {string} customClassName
     *   A fully-qualified path representing CustomClass resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromCustomClassName(customClassName: string): string | number;
    /**
     * Parse the custom_class from CustomClass resource.
     *
     * @param {string} customClassName
     *   A fully-qualified path representing CustomClass resource.
     * @returns {string} A string representing the custom_class.
     */
    matchCustomClassFromCustomClassName(customClassName: 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 phraseSet resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} phrase_set
     * @returns {string} Resource name string.
     */
    phraseSetPath(project: string, location: string, phraseSet: string): string;
    /**
     * Parse the project from PhraseSet resource.
     *
     * @param {string} phraseSetName
     *   A fully-qualified path representing PhraseSet resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromPhraseSetName(phraseSetName: string): string | number;
    /**
     * Parse the location from PhraseSet resource.
     *
     * @param {string} phraseSetName
     *   A fully-qualified path representing PhraseSet resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromPhraseSetName(phraseSetName: string): string | number;
    /**
     * Parse the phrase_set from PhraseSet resource.
     *
     * @param {string} phraseSetName
     *   A fully-qualified path representing PhraseSet resource.
     * @returns {string} A string representing the phrase_set.
     */
    matchPhraseSetFromPhraseSetName(phraseSetName: 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;
    /**
     * 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>;
}