@google-cloud/batch/build/src/v1/batch_service_client.d.ts

Batch client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Google Batch Service.
 *  The service manages user submitted batch jobs and allocates Google Compute
 *  Engine VM instances to run the jobs.
 * @class
 * @memberof v1
 */
export declare class BatchServiceClient {
    private _terminated;
    private _opts;
    private _providedCustomServicePath;
    private _gaxModule;
    private _gaxGrpc;
    private _protos;
    private _defaults;
    private _universeDomain;
    private _servicePath;
    private _log;
    auth: gax.GoogleAuth;
    descriptors: Descriptors;
    warn: (code: string, message: string, warnType?: string) => void;
    innerApiCalls: {
        [name: string]: Function;
    };
    locationsClient: LocationsClient;
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    operationsClient: gax.OperationsClient;
    batchServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of BatchServiceClient.
     *
     * @param {object} [options] - The configuration object.
     * The options accepted by the constructor are described in detail
     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
     * The common options are:
     * @param {object} [options.credentials] - Credentials object.
     * @param {string} [options.credentials.client_email]
     * @param {string} [options.credentials.private_key]
     * @param {string} [options.email] - Account email address. Required when
     *     using a .pem or .p12 keyFilename.
     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
     *     .p12 key downloaded from the Google Developers Console. If you provide
     *     a path to a JSON file, the projectId option below is not necessary.
     *     NOTE: .pem and .p12 require you to specify options.email as well.
     * @param {number} [options.port] - The port on which to connect to
     *     the remote host.
     * @param {string} [options.projectId] - The project ID from the Google
     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
     *     the environment variable GCLOUD_PROJECT for your project ID. If your
     *     app is running in an environment which supports
     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
     *     your project ID will be detected automatically.
     * @param {string} [options.apiEndpoint] - The domain name of the
     *     API remote host.
     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
     *     Follows the structure of {@link gapicConfig}.
     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
     *     For more information, please check the
     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
     *     need to avoid loading the default gRPC version and want to use the fallback
     *     HTTP implementation. Load only fallback version and pass it to the constructor:
     *     ```
     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
     *     const client = new BatchServiceClient({fallback: true}, gax);
     *     ```
     */
    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
    /**
     * Initialize the client.
     * Performs asynchronous operations (such as authentication) and prepares the client.
     * This function will be called automatically when any class method is called for the
     * first time, but if you need to initialize it before calling an actual method,
     * feel free to call initialize() directly.
     *
     * You can await on this method if you want to make sure the client is initialized.
     *
     * @returns {Promise} A promise that resolves to an authenticated service stub.
     */
    initialize(): Promise<{
        [name: string]: Function;
    }>;
    /**
     * The DNS address for this API service.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get servicePath(): string;
    /**
     * The DNS address for this API service - same as servicePath.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get apiEndpoint(): string;
    /**
     * The DNS address for this API service.
     * @returns {string} The DNS address for this service.
     */
    get apiEndpoint(): string;
    get universeDomain(): string;
    /**
     * The port for this API service.
     * @returns {number} The default port for this service.
     */
    static get port(): number;
    /**
     * The scopes needed to make gRPC calls for every method defined
     * in this service.
     * @returns {string[]} List of default scopes.
     */
    static get scopes(): string[];
    getProjectId(): Promise<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): void;
    /**
     * Create a Job.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent resource name where the Job will be created.
     *   Pattern: "projects/{project}/locations/{location}"
     * @param {string} request.jobId
     *   ID used to uniquely identify the Job within its parent scope.
     *   This field should contain at most 63 characters and must start with
     *   lowercase characters.
     *   Only lowercase characters, numbers and '-' are accepted.
     *   The '-' character cannot be the first or the last one.
     *   A system generated ID will be used if the field is not set.
     *
     *   The job.name field in the request will be ignored and the created resource
     *   name of the Job will be "{parent}/jobs/{job_id}".
     * @param {google.cloud.batch.v1.Job} request.job
     *   Required. The Job to create.
     * @param {string} [request.requestId]
     *   Optional. An optional request ID to identify requests. Specify a unique
     *   request ID so that if you must retry your request, the server will know to
     *   ignore the request if it has already been completed. The server will
     *   guarantee that for at least 60 minutes since the first request.
     *
     *   For example, consider a situation where you make an initial request and
     *   the request times out. If you make the request again with the same request
     *   ID, the server can check if original operation with the same request ID
     *   was received, and if so, will ignore the second request. This prevents
     *   clients from accidentally creating duplicate commitments.
     *
     *   The request ID must be a valid UUID with the exception that zero UUID is
     *   not supported (00000000-0000-0000-0000-000000000000).
     * @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.batch.v1.Job|Job}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/batch_service.create_job.js</caption>
     * region_tag:batch_v1_generated_BatchService_CreateJob_async
     */
    createJob(request?: protos.google.cloud.batch.v1.ICreateJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.batch.v1.IJob,
        protos.google.cloud.batch.v1.ICreateJobRequest | undefined,
        {} | undefined
    ]>;
    createJob(request: protos.google.cloud.batch.v1.ICreateJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.batch.v1.IJob, protos.google.cloud.batch.v1.ICreateJobRequest | null | undefined, {} | null | undefined>): void;
    createJob(request: protos.google.cloud.batch.v1.ICreateJobRequest, callback: Callback<protos.google.cloud.batch.v1.IJob, protos.google.cloud.batch.v1.ICreateJobRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Get a Job specified by its resource name.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Job name.
     * @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.batch.v1.Job|Job}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/batch_service.get_job.js</caption>
     * region_tag:batch_v1_generated_BatchService_GetJob_async
     */
    getJob(request?: protos.google.cloud.batch.v1.IGetJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.batch.v1.IJob,
        protos.google.cloud.batch.v1.IGetJobRequest | undefined,
        {} | undefined
    ]>;
    getJob(request: protos.google.cloud.batch.v1.IGetJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.batch.v1.IJob, protos.google.cloud.batch.v1.IGetJobRequest | null | undefined, {} | null | undefined>): void;
    getJob(request: protos.google.cloud.batch.v1.IGetJobRequest, callback: Callback<protos.google.cloud.batch.v1.IJob, protos.google.cloud.batch.v1.IGetJobRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Return a single Task.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Task name.
     * @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.batch.v1.Task|Task}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/batch_service.get_task.js</caption>
     * region_tag:batch_v1_generated_BatchService_GetTask_async
     */
    getTask(request?: protos.google.cloud.batch.v1.IGetTaskRequest, options?: CallOptions): Promise<[
        protos.google.cloud.batch.v1.ITask,
        protos.google.cloud.batch.v1.IGetTaskRequest | undefined,
        {} | undefined
    ]>;
    getTask(request: protos.google.cloud.batch.v1.IGetTaskRequest, options: CallOptions, callback: Callback<protos.google.cloud.batch.v1.ITask, protos.google.cloud.batch.v1.IGetTaskRequest | null | undefined, {} | null | undefined>): void;
    getTask(request: protos.google.cloud.batch.v1.IGetTaskRequest, callback: Callback<protos.google.cloud.batch.v1.ITask, protos.google.cloud.batch.v1.IGetTaskRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Delete a Job.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Job name.
     * @param {string} [request.reason]
     *   Optional. Reason for this deletion.
     * @param {string} [request.requestId]
     *   Optional. An optional request ID to identify requests. Specify a unique
     *   request ID so that if you must retry your request, the server will know to
     *   ignore the request if it has already been completed. The server will
     *   guarantee that for at least 60 minutes after the first request.
     *
     *   For example, consider a situation where you make an initial request and
     *   the request times out. If you make the request again with the same request
     *   ID, the server can check if original operation with the same request ID
     *   was received, and if so, will ignore the second request. This prevents
     *   clients from accidentally creating duplicate commitments.
     *
     *   The request ID must be a valid UUID with the exception that zero UUID is
     *   not supported (00000000-0000-0000-0000-000000000000).
     * @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/v1/batch_service.delete_job.js</caption>
     * region_tag:batch_v1_generated_BatchService_DeleteJob_async
     */
    deleteJob(request?: protos.google.cloud.batch.v1.IDeleteJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.batch.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    deleteJob(request: protos.google.cloud.batch.v1.IDeleteJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.batch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    deleteJob(request: protos.google.cloud.batch.v1.IDeleteJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.batch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `deleteJob()`.
     * @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/v1/batch_service.delete_job.js</caption>
     * region_tag:batch_v1_generated_BatchService_DeleteJob_async
     */
    checkDeleteJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.batch.v1.OperationMetadata>>;
    /**
     * Cancel a Job.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Job name.
     * @param {string} [request.requestId]
     *   Optional. An optional request ID to identify requests. Specify a unique
     *   request ID so that if you must retry your request, the server will know to
     *   ignore the request if it has already been completed. The server will
     *   guarantee that for at least 60 minutes after the first request.
     *
     *   For example, consider a situation where you make an initial request and
     *   the request times out. If you make the request again with the same request
     *   ID, the server can check if original operation with the same request ID
     *   was received, and if so, will ignore the second request. This prevents
     *   clients from accidentally creating duplicate commitments.
     *
     *   The request ID must be a valid UUID with the exception that zero UUID is
     *   not supported (00000000-0000-0000-0000-000000000000).
     * @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/v1/batch_service.cancel_job.js</caption>
     * region_tag:batch_v1_generated_BatchService_CancelJob_async
     */
    cancelJob(request?: protos.google.cloud.batch.v1.ICancelJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.batch.v1.ICancelJobResponse, protos.google.cloud.batch.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    cancelJob(request: protos.google.cloud.batch.v1.ICancelJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.batch.v1.ICancelJobResponse, protos.google.cloud.batch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    cancelJob(request: protos.google.cloud.batch.v1.ICancelJobRequest, callback: Callback<LROperation<protos.google.cloud.batch.v1.ICancelJobResponse, protos.google.cloud.batch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `cancelJob()`.
     * @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/v1/batch_service.cancel_job.js</caption>
     * region_tag:batch_v1_generated_BatchService_CancelJob_async
     */
    checkCancelJobProgress(name: string): Promise<LROperation<protos.google.cloud.batch.v1.CancelJobResponse, protos.google.cloud.batch.v1.OperationMetadata>>;
    /**
    * List all Jobs for a project within a region.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Parent path.
    * @param {string} request.filter
    *   List filter.
    * @param {string} [request.orderBy]
    *   Optional. Sort results. Supported are "name", "name desc", "create_time",
    *   and "create_time desc".
    * @param {number} request.pageSize
    *   Page size.
    * @param {string} request.pageToken
    *   Page token.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
    *   The first element of the array is Array of {@link protos.google.cloud.batch.v1.Job|Job}.
    *   The client library will perform auto-pagination by default: it will call the API as many
    *   times as needed and will merge results from all the pages into this array.
    *   Note that it can affect your quota.
    *   We recommend using `listJobsAsync()`
    *   method described below for async iteration which you can stop as needed.
    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
    *   for more details and examples.
    */
    listJobs(request?: protos.google.cloud.batch.v1.IListJobsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.batch.v1.IJob[],
        protos.google.cloud.batch.v1.IListJobsRequest | null,
        protos.google.cloud.batch.v1.IListJobsResponse
    ]>;
    listJobs(request: protos.google.cloud.batch.v1.IListJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.batch.v1.IListJobsRequest, protos.google.cloud.batch.v1.IListJobsResponse | null | undefined, protos.google.cloud.batch.v1.IJob>): void;
    listJobs(request: protos.google.cloud.batch.v1.IListJobsRequest, callback: PaginationCallback<protos.google.cloud.batch.v1.IListJobsRequest, protos.google.cloud.batch.v1.IListJobsResponse | null | undefined, protos.google.cloud.batch.v1.IJob>): void;
    /**
     * Equivalent to `listJobs`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Parent path.
     * @param {string} request.filter
     *   List filter.
     * @param {string} [request.orderBy]
     *   Optional. Sort results. Supported are "name", "name desc", "create_time",
     *   and "create_time desc".
     * @param {number} request.pageSize
     *   Page size.
     * @param {string} request.pageToken
     *   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 {@link protos.google.cloud.batch.v1.Job|Job} 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 `listJobsAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     */
    listJobsStream(request?: protos.google.cloud.batch.v1.IListJobsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listJobs`, 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
     *   Parent path.
     * @param {string} request.filter
     *   List filter.
     * @param {string} [request.orderBy]
     *   Optional. Sort results. Supported are "name", "name desc", "create_time",
     *   and "create_time desc".
     * @param {number} request.pageSize
     *   Page size.
     * @param {string} request.pageToken
     *   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 protos.google.cloud.batch.v1.Job|Job}. The API will be called under the hood as needed, once per the page,
     *   so you can stop the iteration when you don't need more results.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/batch_service.list_jobs.js</caption>
     * region_tag:batch_v1_generated_BatchService_ListJobs_async
     */
    listJobsAsync(request?: protos.google.cloud.batch.v1.IListJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.batch.v1.IJob>;
    /**
    * List Tasks associated with a job.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. Name of a TaskGroup from which Tasks are being requested.
    *   Pattern:
    *   "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
    * @param {string} request.filter
    *   Task filter, null filter matches all Tasks.
    *   Filter string should be of the format State=TaskStatus.State e.g.
    *   State=RUNNING
    * @param {number} request.pageSize
    *   Page size.
    * @param {string} request.pageToken
    *   Page token.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
    *   The first element of the array is Array of {@link protos.google.cloud.batch.v1.Task|Task}.
    *   The client library will perform auto-pagination by default: it will call the API as many
    *   times as needed and will merge results from all the pages into this array.
    *   Note that it can affect your quota.
    *   We recommend using `listTasksAsync()`
    *   method described below for async iteration which you can stop as needed.
    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
    *   for more details and examples.
    */
    listTasks(request?: protos.google.cloud.batch.v1.IListTasksRequest, options?: CallOptions): Promise<[
        protos.google.cloud.batch.v1.ITask[],
        protos.google.cloud.batch.v1.IListTasksRequest | null,
        protos.google.cloud.batch.v1.IListTasksResponse
    ]>;
    listTasks(request: protos.google.cloud.batch.v1.IListTasksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.batch.v1.IListTasksRequest, protos.google.cloud.batch.v1.IListTasksResponse | null | undefined, protos.google.cloud.batch.v1.ITask>): void;
    listTasks(request: protos.google.cloud.batch.v1.IListTasksRequest, callback: PaginationCallback<protos.google.cloud.batch.v1.IListTasksRequest, protos.google.cloud.batch.v1.IListTasksResponse | null | undefined, protos.google.cloud.batch.v1.ITask>): void;
    /**
     * Equivalent to `listTasks`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. Name of a TaskGroup from which Tasks are being requested.
     *   Pattern:
     *   "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
     * @param {string} request.filter
     *   Task filter, null filter matches all Tasks.
     *   Filter string should be of the format State=TaskStatus.State e.g.
     *   State=RUNNING
     * @param {number} request.pageSize
     *   Page size.
     * @param {string} request.pageToken
     *   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 {@link protos.google.cloud.batch.v1.Task|Task} 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 `listTasksAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     */
    listTasksStream(request?: protos.google.cloud.batch.v1.IListTasksRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listTasks`, 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. Name of a TaskGroup from which Tasks are being requested.
     *   Pattern:
     *   "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
     * @param {string} request.filter
     *   Task filter, null filter matches all Tasks.
     *   Filter string should be of the format State=TaskStatus.State e.g.
     *   State=RUNNING
     * @param {number} request.pageSize
     *   Page size.
     * @param {string} request.pageToken
     *   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 protos.google.cloud.batch.v1.Task|Task}. The API will be called under the hood as needed, once per the page,
     *   so you can stop the iteration when you don't need more results.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/batch_service.list_tasks.js</caption>
     * region_tag:batch_v1_generated_BatchService_ListTasks_async
     */
    listTasksAsync(request?: protos.google.cloud.batch.v1.IListTasksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.batch.v1.ITask>;
    /**
       * 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, optionsOrCallback?: 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.IOperation>;
    /**
     * 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, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | 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, optionsOrCallback?: 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 job resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} job
     * @returns {string} Resource name string.
     */
    jobPath(project: string, location: string, job: string): string;
    /**
     * Parse the project from Job resource.
     *
     * @param {string} jobName
     *   A fully-qualified path representing Job resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromJobName(jobName: string): string | number;
    /**
     * Parse the location from Job resource.
     *
     * @param {string} jobName
     *   A fully-qualified path representing Job resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromJobName(jobName: string): string | number;
    /**
     * Parse the job from Job resource.
     *
     * @param {string} jobName
     *   A fully-qualified path representing Job resource.
     * @returns {string} A string representing the job.
     */
    matchJobFromJobName(jobName: string): string | number;
    /**
     * Return a fully-qualified location resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @returns {string} Resource name string.
     */
    locationPath(project: string, location: string): string;
    /**
     * Parse the project from Location resource.
     *
     * @param {string} locationName
     *   A fully-qualified path representing Location resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromLocationName(locationName: string): string | number;
    /**
     * Parse the location from Location resource.
     *
     * @param {string} locationName
     *   A fully-qualified path representing Location resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromLocationName(locationName: string): string | number;
    /**
     * Return a fully-qualified project resource name string.
     *
     * @param {string} project
     * @returns {string} Resource name string.
     */
    projectPath(project: string): string;
    /**
     * Parse the project from Project resource.
     *
     * @param {string} projectName
     *   A fully-qualified path representing Project resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromProjectName(projectName: string): string | number;
    /**
     * Return a fully-qualified task resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} job
     * @param {string} task_group
     * @param {string} task
     * @returns {string} Resource name string.
     */
    taskPath(project: string, location: string, job: string, taskGroup: string, task: string): string;
    /**
     * Parse the project from Task resource.
     *
     * @param {string} taskName
     *   A fully-qualified path representing Task resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromTaskName(taskName: string): string | number;
    /**
     * Parse the location from Task resource.
     *
     * @param {string} taskName
     *   A fully-qualified path representing Task resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromTaskName(taskName: string): string | number;
    /**
     * Parse the job from Task resource.
     *
     * @param {string} taskName
     *   A fully-qualified path representing Task resource.
     * @returns {string} A string representing the job.
     */
    matchJobFromTaskName(taskName: string): string | number;
    /**
     * Parse the task_group from Task resource.
     *
     * @param {string} taskName
     *   A fully-qualified path representing Task resource.
     * @returns {string} A string representing the task_group.
     */
    matchTaskGroupFromTaskName(taskName: string): string | number;
    /**
     * Parse the task from Task resource.
     *
     * @param {string} taskName
     *   A fully-qualified path representing Task resource.
     * @returns {string} A string representing the task.
     */
    matchTaskFromTaskName(taskName: string): string | number;
    /**
     * Return a fully-qualified taskGroup resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} job
     * @param {string} task_group
     * @returns {string} Resource name string.
     */
    taskGroupPath(project: string, location: string, job: string, taskGroup: string): string;
    /**
     * Parse the project from TaskGroup resource.
     *
     * @param {string} taskGroupName
     *   A fully-qualified path representing TaskGroup resource.
     * @returns {string} A string representing the project.
     */
    matchProjectFromTaskGroupName(taskGroupName: string): string | number;
    /**
     * Parse the location from TaskGroup resource.
     *
     * @param {string} taskGroupName
     *   A fully-qualified path representing TaskGroup resource.
     * @returns {string} A string representing the location.
     */
    matchLocationFromTaskGroupName(taskGroupName: string): string | number;
    /**
     * Parse the job from TaskGroup resource.
     *
     * @param {string} taskGroupName
     *   A fully-qualified path representing TaskGroup resource.
     * @returns {string} A string representing the job.
     */
    matchJobFromTaskGroupName(taskGroupName: string): string | number;
    /**
     * Parse the task_group from TaskGroup resource.
     *
     * @param {string} taskGroupName
     *   A fully-qualified path representing TaskGroup resource.
     * @returns {string} A string representing the task_group.
     */
    matchTaskGroupFromTaskGroupName(taskGroupName: 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>;
}