import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, IamClient, IamProtos } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * The API interface for managing Workflow Templates in the * Dataproc API. * @class * @memberof v1 */ export declare class WorkflowTemplateServiceClient { 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; }; iamClient: IamClient; pathTemplates: { [name: string]: gax.PathTemplate; }; operationsClient: gax.OperationsClient; workflowTemplateServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of WorkflowTemplateServiceClient. * * @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 WorkflowTemplateServiceClient({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; getProjectId(callback: Callback): void; /** * Creates new workflow template. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the region or location, as described * in https://cloud.google.com/apis/design/resource_names. * * * For `projects.regions.workflowTemplates.create`, the resource name of the * region has the following format: * `projects/{project_id}/regions/{region}` * * * For `projects.locations.workflowTemplates.create`, the resource name of * the location has the following format: * `projects/{project_id}/locations/{location}` * @param {google.cloud.dataproc.v1.WorkflowTemplate} request.template * Required. The Dataproc workflow template to create. * @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.dataproc.v1.WorkflowTemplate|WorkflowTemplate}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/workflow_template_service.create_workflow_template.js * region_tag:dataproc_v1_generated_WorkflowTemplateService_CreateWorkflowTemplate_async */ createWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataproc.v1.IWorkflowTemplate, (protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest | undefined), {} | undefined ]>; createWorkflowTemplate(request: protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest, options: CallOptions, callback: Callback): void; createWorkflowTemplate(request: protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest, callback: Callback): void; /** * Retrieves the latest workflow template. * * Can retrieve previously instantiated template by specifying optional * version parameter. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the workflow template, as described * in https://cloud.google.com/apis/design/resource_names. * * * For `projects.regions.workflowTemplates.get`, the resource name of the * template has the following format: * `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * * * For `projects.locations.workflowTemplates.get`, the resource name of the * template has the following format: * `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}` * @param {number} [request.version] * Optional. The version of workflow template to retrieve. Only previously * instantiated versions can be retrieved. * * If unspecified, retrieves the current version. * @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.dataproc.v1.WorkflowTemplate|WorkflowTemplate}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/workflow_template_service.get_workflow_template.js * region_tag:dataproc_v1_generated_WorkflowTemplateService_GetWorkflowTemplate_async */ getWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest | undefined, {} | undefined ]>; getWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest, options: CallOptions, callback: Callback): void; getWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest, callback: Callback): void; /** * Updates (replaces) workflow template. The updated template * must contain version that matches the current server version. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.dataproc.v1.WorkflowTemplate} request.template * Required. The updated workflow template. * * The `template.version` field must match the current version. * @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.dataproc.v1.WorkflowTemplate|WorkflowTemplate}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/workflow_template_service.update_workflow_template.js * region_tag:dataproc_v1_generated_WorkflowTemplateService_UpdateWorkflowTemplate_async */ updateWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataproc.v1.IWorkflowTemplate, (protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest | undefined), {} | undefined ]>; updateWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest, options: CallOptions, callback: Callback): void; updateWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest, callback: Callback): void; /** * Deletes a workflow template. It does not cancel in-progress workflows. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the workflow template, as described * in https://cloud.google.com/apis/design/resource_names. * * * For `projects.regions.workflowTemplates.delete`, the resource name * of the template has the following format: * `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * * * For `projects.locations.workflowTemplates.instantiate`, the resource name * of the template has the following format: * `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}` * @param {number} [request.version] * Optional. The version of workflow template to delete. If specified, * will only delete the template if the current server version matches * specified version. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/workflow_template_service.delete_workflow_template.js * region_tag:dataproc_v1_generated_WorkflowTemplateService_DeleteWorkflowTemplate_async */ deleteWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest | undefined), {} | undefined ]>; deleteWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest, options: CallOptions, callback: Callback): void; deleteWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest, callback: Callback): void; /** * Instantiates a template and begins execution. * * The returned Operation can be used to track execution of * workflow by polling * {@link protos.google.longrunning.Operations.GetOperation|operations.get}. * The Operation will complete when entire workflow is finished. * * The running workflow can be aborted via * {@link protos.google.longrunning.Operations.CancelOperation|operations.cancel}. * This will cause any inflight jobs to be cancelled and workflow-owned * clusters to be deleted. * * The {@link protos.google.longrunning.Operation.metadata|Operation.metadata} will be * [WorkflowMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). * Also see [Using * WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata). * * On successful completion, * {@link protos.google.longrunning.Operation.response|Operation.response} will be * {@link protos.google.protobuf.Empty|Empty}. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the workflow template, as described * in https://cloud.google.com/apis/design/resource_names. * * * For `projects.regions.workflowTemplates.instantiate`, the resource name * of the template has the following format: * `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * * * For `projects.locations.workflowTemplates.instantiate`, the resource name * of the template has the following format: * `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}` * @param {number} [request.version] * Optional. The version of workflow template to instantiate. If specified, * the workflow will be instantiated only if the current version of * the workflow template has the supplied version. * * This option cannot be used to instantiate a previous version of * workflow template. * @param {string} [request.requestId] * Optional. A tag that prevents multiple concurrent workflow * instances with the same tag from running. This mitigates risk of * concurrent instances started due to retries. * * It is recommended to always set this value to a * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). * * The tag must contain only letters (a-z, A-Z), numbers (0-9), * underscores (_), and hyphens (-). The maximum length is 40 characters. * @param {number[]} [request.parameters] * Optional. Map from parameter names to values that should be used for those * parameters. Values may not exceed 1000 characters. * @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 include:samples/generated/v1/workflow_template_service.instantiate_workflow_template.js * region_tag:dataproc_v1_generated_WorkflowTemplateService_InstantiateWorkflowTemplate_async */ instantiateWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.IInstantiateWorkflowTemplateRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; instantiateWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IInstantiateWorkflowTemplateRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; instantiateWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IInstantiateWorkflowTemplateRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `instantiateWorkflowTemplate()`. * @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 include:samples/generated/v1/workflow_template_service.instantiate_workflow_template.js * region_tag:dataproc_v1_generated_WorkflowTemplateService_InstantiateWorkflowTemplate_async */ checkInstantiateWorkflowTemplateProgress(name: string): Promise>; /** * Instantiates a template and begins execution. * * This method is equivalent to executing the sequence * {@link protos.google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate|CreateWorkflowTemplate}, * {@link protos.google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate|InstantiateWorkflowTemplate}, * {@link protos.google.cloud.dataproc.v1.WorkflowTemplateService.DeleteWorkflowTemplate|DeleteWorkflowTemplate}. * * The returned Operation can be used to track execution of * workflow by polling * {@link protos.google.longrunning.Operations.GetOperation|operations.get}. * The Operation will complete when entire workflow is finished. * * The running workflow can be aborted via * {@link protos.google.longrunning.Operations.CancelOperation|operations.cancel}. * This will cause any inflight jobs to be cancelled and workflow-owned * clusters to be deleted. * * The {@link protos.google.longrunning.Operation.metadata|Operation.metadata} will be * [WorkflowMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). * Also see [Using * WorkflowMetadata](https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata). * * On successful completion, * {@link protos.google.longrunning.Operation.response|Operation.response} will be * {@link protos.google.protobuf.Empty|Empty}. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the region or location, as described * in https://cloud.google.com/apis/design/resource_names. * * * For `projects.regions.workflowTemplates,instantiateinline`, the resource * name of the region has the following format: * `projects/{project_id}/regions/{region}` * * * For `projects.locations.workflowTemplates.instantiateinline`, the * resource name of the location has the following format: * `projects/{project_id}/locations/{location}` * @param {google.cloud.dataproc.v1.WorkflowTemplate} request.template * Required. The workflow template to instantiate. * @param {string} [request.requestId] * Optional. A tag that prevents multiple concurrent workflow * instances with the same tag from running. This mitigates risk of * concurrent instances started due to retries. * * It is recommended to always set this value to a * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). * * The tag must contain only letters (a-z, A-Z), numbers (0-9), * underscores (_), and hyphens (-). The maximum length is 40 characters. * @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 include:samples/generated/v1/workflow_template_service.instantiate_inline_workflow_template.js * region_tag:dataproc_v1_generated_WorkflowTemplateService_InstantiateInlineWorkflowTemplate_async */ instantiateInlineWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.IInstantiateInlineWorkflowTemplateRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; instantiateInlineWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IInstantiateInlineWorkflowTemplateRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; instantiateInlineWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IInstantiateInlineWorkflowTemplateRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `instantiateInlineWorkflowTemplate()`. * @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 include:samples/generated/v1/workflow_template_service.instantiate_inline_workflow_template.js * region_tag:dataproc_v1_generated_WorkflowTemplateService_InstantiateInlineWorkflowTemplate_async */ checkInstantiateInlineWorkflowTemplateProgress(name: string): Promise>; /** * Lists workflows that match the specified filter in the request. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the region or location, as described * in https://cloud.google.com/apis/design/resource_names. * * * For `projects.regions.workflowTemplates,list`, the resource * name of the region has the following format: * `projects/{project_id}/regions/{region}` * * * For `projects.locations.workflowTemplates.list`, the * resource name of the location has the following format: * `projects/{project_id}/locations/{location}` * @param {number} [request.pageSize] * Optional. The maximum number of results to return in each response. * @param {string} [request.pageToken] * Optional. The page token, returned by a previous call, to request the * next page of results. * @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.dataproc.v1.WorkflowTemplate|WorkflowTemplate}. * 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 `listWorkflowTemplatesAsync()` * 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. */ listWorkflowTemplates(request?: protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataproc.v1.IWorkflowTemplate[], protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest | null, protos.google.cloud.dataproc.v1.IListWorkflowTemplatesResponse ]>; listWorkflowTemplates(request: protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, options: CallOptions, callback: PaginationCallback): void; listWorkflowTemplates(request: protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, callback: PaginationCallback): void; /** * Equivalent to `listWorkflowTemplates`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the region or location, as described * in https://cloud.google.com/apis/design/resource_names. * * * For `projects.regions.workflowTemplates,list`, the resource * name of the region has the following format: * `projects/{project_id}/regions/{region}` * * * For `projects.locations.workflowTemplates.list`, the * resource name of the location has the following format: * `projects/{project_id}/locations/{location}` * @param {number} [request.pageSize] * Optional. The maximum number of results to return in each response. * @param {string} [request.pageToken] * Optional. The page token, returned by a previous call, to request the * next page of results. * @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.dataproc.v1.WorkflowTemplate|WorkflowTemplate} 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 `listWorkflowTemplatesAsync()` * 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. */ listWorkflowTemplatesStream(request?: protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, options?: CallOptions): Transform; /** * Equivalent to `listWorkflowTemplates`, 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 resource name of the region or location, as described * in https://cloud.google.com/apis/design/resource_names. * * * For `projects.regions.workflowTemplates,list`, the resource * name of the region has the following format: * `projects/{project_id}/regions/{region}` * * * For `projects.locations.workflowTemplates.list`, the * resource name of the location has the following format: * `projects/{project_id}/locations/{location}` * @param {number} [request.pageSize] * Optional. The maximum number of results to return in each response. * @param {string} [request.pageToken] * Optional. The page token, returned by a previous call, to request the * next page of results. * @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.dataproc.v1.WorkflowTemplate|WorkflowTemplate}. 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 include:samples/generated/v1/workflow_template_service.list_workflow_templates.js * region_tag:dataproc_v1_generated_WorkflowTemplateService_ListWorkflowTemplates_async */ listWorkflowTemplatesAsync(request?: protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, options?: CallOptions): AsyncIterable; /** * Gets the access control policy for a resource. Returns an empty policy * if the resource exists and does not have a policy set. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being requested. * See the operation documentation for the appropriate value for this field. * @param {Object} [request.options] * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. This field is only used by Cloud IAM. * * This object should have the same structure as {@link google.iam.v1.GetPolicyOptions | GetPolicyOptions}. * @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/interfaces/CallOptions.html | 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.iam.v1.Policy | Policy}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}. * The promise has a method named "cancel" which cancels the ongoing API call. */ getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise<[IamProtos.google.iam.v1.Policy]>; /** * Returns permissions that a caller has on the specified resource. If the * resource does not exist, this will return an empty set of * permissions, not a NOT_FOUND error. * * Note: This operation is designed to be used for building * permission-aware UIs and command-line tools, not for authorization * checking. This operation may "fail open" without warning. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @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/interfaces/CallOptions.html | 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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. */ setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise<[IamProtos.google.iam.v1.Policy]>; /** * Returns permissions that a caller has on the specified resource. If the * resource does not exist, this will return an empty set of * permissions, not a NOT_FOUND error. * * Note: This operation is designed to be used for building * permission-aware UIs and command-line tools, not for authorization * checking. This operation may "fail open" without warning. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @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/interfaces/CallOptions.html | 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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. * */ testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>; /** * 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, callback?: Callback): 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; /** * 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, callback?: Callback): Promise; /** * 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, callback?: Callback): Promise; /** * Return a fully-qualified batch resource name string. * * @param {string} project * @param {string} location * @param {string} batch * @returns {string} Resource name string. */ batchPath(project: string, location: string, batch: string): string; /** * Parse the project from Batch resource. * * @param {string} batchName * A fully-qualified path representing Batch resource. * @returns {string} A string representing the project. */ matchProjectFromBatchName(batchName: string): string | number; /** * Parse the location from Batch resource. * * @param {string} batchName * A fully-qualified path representing Batch resource. * @returns {string} A string representing the location. */ matchLocationFromBatchName(batchName: string): string | number; /** * Parse the batch from Batch resource. * * @param {string} batchName * A fully-qualified path representing Batch resource. * @returns {string} A string representing the batch. */ matchBatchFromBatchName(batchName: string): string | number; /** * Return a fully-qualified nodeGroup resource name string. * * @param {string} project * @param {string} region * @param {string} cluster * @param {string} node_group * @returns {string} Resource name string. */ nodeGroupPath(project: string, region: string, cluster: string, nodeGroup: string): string; /** * Parse the project from NodeGroup resource. * * @param {string} nodeGroupName * A fully-qualified path representing NodeGroup resource. * @returns {string} A string representing the project. */ matchProjectFromNodeGroupName(nodeGroupName: string): string | number; /** * Parse the region from NodeGroup resource. * * @param {string} nodeGroupName * A fully-qualified path representing NodeGroup resource. * @returns {string} A string representing the region. */ matchRegionFromNodeGroupName(nodeGroupName: string): string | number; /** * Parse the cluster from NodeGroup resource. * * @param {string} nodeGroupName * A fully-qualified path representing NodeGroup resource. * @returns {string} A string representing the cluster. */ matchClusterFromNodeGroupName(nodeGroupName: string): string | number; /** * Parse the node_group from NodeGroup resource. * * @param {string} nodeGroupName * A fully-qualified path representing NodeGroup resource. * @returns {string} A string representing the node_group. */ matchNodeGroupFromNodeGroupName(nodeGroupName: 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 projectLocationAutoscalingPolicy resource name string. * * @param {string} project * @param {string} location * @param {string} autoscaling_policy * @returns {string} Resource name string. */ projectLocationAutoscalingPolicyPath(project: string, location: string, autoscalingPolicy: string): string; /** * Parse the project from ProjectLocationAutoscalingPolicy resource. * * @param {string} projectLocationAutoscalingPolicyName * A fully-qualified path representing project_location_autoscaling_policy resource. * @returns {string} A string representing the project. */ matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number; /** * Parse the location from ProjectLocationAutoscalingPolicy resource. * * @param {string} projectLocationAutoscalingPolicyName * A fully-qualified path representing project_location_autoscaling_policy resource. * @returns {string} A string representing the location. */ matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number; /** * Parse the autoscaling_policy from ProjectLocationAutoscalingPolicy resource. * * @param {string} projectLocationAutoscalingPolicyName * A fully-qualified path representing project_location_autoscaling_policy resource. * @returns {string} A string representing the autoscaling_policy. */ matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number; /** * Return a fully-qualified projectLocationWorkflowTemplate resource name string. * * @param {string} project * @param {string} location * @param {string} workflow_template * @returns {string} Resource name string. */ projectLocationWorkflowTemplatePath(project: string, location: string, workflowTemplate: string): string; /** * Parse the project from ProjectLocationWorkflowTemplate resource. * * @param {string} projectLocationWorkflowTemplateName * A fully-qualified path representing project_location_workflow_template resource. * @returns {string} A string representing the project. */ matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number; /** * Parse the location from ProjectLocationWorkflowTemplate resource. * * @param {string} projectLocationWorkflowTemplateName * A fully-qualified path representing project_location_workflow_template resource. * @returns {string} A string representing the location. */ matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number; /** * Parse the workflow_template from ProjectLocationWorkflowTemplate resource. * * @param {string} projectLocationWorkflowTemplateName * A fully-qualified path representing project_location_workflow_template resource. * @returns {string} A string representing the workflow_template. */ matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number; /** * Return a fully-qualified projectRegionAutoscalingPolicy resource name string. * * @param {string} project * @param {string} region * @param {string} autoscaling_policy * @returns {string} Resource name string. */ projectRegionAutoscalingPolicyPath(project: string, region: string, autoscalingPolicy: string): string; /** * Parse the project from ProjectRegionAutoscalingPolicy resource. * * @param {string} projectRegionAutoscalingPolicyName * A fully-qualified path representing project_region_autoscaling_policy resource. * @returns {string} A string representing the project. */ matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number; /** * Parse the region from ProjectRegionAutoscalingPolicy resource. * * @param {string} projectRegionAutoscalingPolicyName * A fully-qualified path representing project_region_autoscaling_policy resource. * @returns {string} A string representing the region. */ matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number; /** * Parse the autoscaling_policy from ProjectRegionAutoscalingPolicy resource. * * @param {string} projectRegionAutoscalingPolicyName * A fully-qualified path representing project_region_autoscaling_policy resource. * @returns {string} A string representing the autoscaling_policy. */ matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number; /** * Return a fully-qualified projectRegionWorkflowTemplate resource name string. * * @param {string} project * @param {string} region * @param {string} workflow_template * @returns {string} Resource name string. */ projectRegionWorkflowTemplatePath(project: string, region: string, workflowTemplate: string): string; /** * Parse the project from ProjectRegionWorkflowTemplate resource. * * @param {string} projectRegionWorkflowTemplateName * A fully-qualified path representing project_region_workflow_template resource. * @returns {string} A string representing the project. */ matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number; /** * Parse the region from ProjectRegionWorkflowTemplate resource. * * @param {string} projectRegionWorkflowTemplateName * A fully-qualified path representing project_region_workflow_template resource. * @returns {string} A string representing the region. */ matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number; /** * Parse the workflow_template from ProjectRegionWorkflowTemplate resource. * * @param {string} projectRegionWorkflowTemplateName * A fully-qualified path representing project_region_workflow_template resource. * @returns {string} A string representing the workflow_template. */ matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number; /** * Return a fully-qualified region resource name string. * * @param {string} project * @param {string} region * @returns {string} Resource name string. */ regionPath(project: string, region: string): string; /** * Parse the project from Region resource. * * @param {string} regionName * A fully-qualified path representing Region resource. * @returns {string} A string representing the project. */ matchProjectFromRegionName(regionName: string): string | number; /** * Parse the region from Region resource. * * @param {string} regionName * A fully-qualified path representing Region resource. * @returns {string} A string representing the region. */ matchRegionFromRegionName(regionName: string): string | number; /** * Return a fully-qualified session resource name string. * * @param {string} project * @param {string} location * @param {string} session * @returns {string} Resource name string. */ sessionPath(project: string, location: string, session: string): string; /** * Parse the project from Session resource. * * @param {string} sessionName * A fully-qualified path representing Session resource. * @returns {string} A string representing the project. */ matchProjectFromSessionName(sessionName: string): string | number; /** * Parse the location from Session resource. * * @param {string} sessionName * A fully-qualified path representing Session resource. * @returns {string} A string representing the location. */ matchLocationFromSessionName(sessionName: string): string | number; /** * Parse the session from Session resource. * * @param {string} sessionName * A fully-qualified path representing Session resource. * @returns {string} A string representing the session. */ matchSessionFromSessionName(sessionName: string): string | number; /** * Return a fully-qualified sessionTemplate resource name string. * * @param {string} project * @param {string} location * @param {string} template * @returns {string} Resource name string. */ sessionTemplatePath(project: string, location: string, template: string): string; /** * Parse the project from SessionTemplate resource. * * @param {string} sessionTemplateName * A fully-qualified path representing SessionTemplate resource. * @returns {string} A string representing the project. */ matchProjectFromSessionTemplateName(sessionTemplateName: string): string | number; /** * Parse the location from SessionTemplate resource. * * @param {string} sessionTemplateName * A fully-qualified path representing SessionTemplate resource. * @returns {string} A string representing the location. */ matchLocationFromSessionTemplateName(sessionTemplateName: string): string | number; /** * Parse the template from SessionTemplate resource. * * @param {string} sessionTemplateName * A fully-qualified path representing SessionTemplate resource. * @returns {string} A string representing the template. */ matchTemplateFromSessionTemplateName(sessionTemplateName: 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; }