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 ClusterControllerService provides methods to manage clusters * of Compute Engine instances. * @class * @memberof v1 */ export declare class ClusterControllerClient { 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; clusterControllerStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of ClusterControllerClient. * * @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 ClusterControllerClient({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; /** * Gets the resource representation for a cluster in a project. * * @param {Object} request * The request object that will be sent. * @param {string} request.projectId * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. * @param {string} request.region * Required. The Dataproc region in which to handle the request. * @param {string} request.clusterName * Required. The cluster 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.dataproc.v1.Cluster|Cluster}. * 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/cluster_controller.get_cluster.js * region_tag:dataproc_v1_generated_ClusterController_GetCluster_async */ getCluster(request?: protos.google.cloud.dataproc.v1.IGetClusterRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataproc.v1.ICluster, protos.google.cloud.dataproc.v1.IGetClusterRequest | undefined, {} | undefined ]>; getCluster(request: protos.google.cloud.dataproc.v1.IGetClusterRequest, options: CallOptions, callback: Callback): void; getCluster(request: protos.google.cloud.dataproc.v1.IGetClusterRequest, callback: Callback): void; /** * Creates a cluster in a project. The returned * {@link protos.google.longrunning.Operation.metadata|Operation.metadata} will be * [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). * * @param {Object} request * The request object that will be sent. * @param {string} request.projectId * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. * @param {string} request.region * Required. The Dataproc region in which to handle the request. * @param {google.cloud.dataproc.v1.Cluster} request.cluster * Required. The cluster to create. * @param {string} [request.requestId] * Optional. A unique ID used to identify the request. If the server receives * two * [CreateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateClusterRequest)s * with the same id, then the second request will be ignored and the * first {@link protos.google.longrunning.Operation|google.longrunning.Operation} created * and stored in the backend is returned. * * It is recommended to always set this value to a * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). * * The ID must contain only letters (a-z, A-Z), numbers (0-9), * underscores (_), and hyphens (-). The maximum length is 40 characters. * @param {google.cloud.dataproc.v1.FailureAction} [request.actionOnFailedPrimaryWorkers] * Optional. Failure action when primary worker creation fails. * @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/cluster_controller.create_cluster.js * region_tag:dataproc_v1_generated_ClusterController_CreateCluster_async */ createCluster(request?: protos.google.cloud.dataproc.v1.ICreateClusterRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createCluster(request: protos.google.cloud.dataproc.v1.ICreateClusterRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createCluster(request: protos.google.cloud.dataproc.v1.ICreateClusterRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createCluster()`. * @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/cluster_controller.create_cluster.js * region_tag:dataproc_v1_generated_ClusterController_CreateCluster_async */ checkCreateClusterProgress(name: string): Promise>; /** * Updates a cluster in a project. The returned * {@link protos.google.longrunning.Operation.metadata|Operation.metadata} will be * [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). * The cluster must be in a * {@link protos.google.cloud.dataproc.v1.ClusterStatus.State|`RUNNING`} state or an error * is returned. * * @param {Object} request * The request object that will be sent. * @param {string} request.projectId * Required. The ID of the Google Cloud Platform project the * cluster belongs to. * @param {string} request.region * Required. The Dataproc region in which to handle the request. * @param {string} request.clusterName * Required. The cluster name. * @param {google.cloud.dataproc.v1.Cluster} request.cluster * Required. The changes to the cluster. * @param {google.protobuf.Duration} [request.gracefulDecommissionTimeout] * Optional. Timeout for graceful YARN decommissioning. Graceful * decommissioning allows removing nodes from the cluster without * interrupting jobs in progress. Timeout specifies how long to wait for jobs * in progress to finish before forcefully removing nodes (and potentially * interrupting jobs). Default timeout is 0 (for forceful decommission), and * the maximum allowed timeout is 1 day. (see JSON representation of * [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)). * * Only supported on Dataproc image versions 1.2 and higher. * @param {google.protobuf.FieldMask} request.updateMask * Required. Specifies the path, relative to `Cluster`, of * the field to update. For example, to change the number of workers * in a cluster to 5, the `update_mask` parameter would be * specified as `config.worker_config.num_instances`, * and the `PATCH` request body would specify the new value, as follows: * * { * "config":{ * "workerConfig":{ * "numInstances":"5" * } * } * } * Similarly, to change the number of preemptible workers in a cluster to 5, * the `update_mask` parameter would be * `config.secondary_worker_config.num_instances`, and the `PATCH` request * body would be set as follows: * * { * "config":{ * "secondaryWorkerConfig":{ * "numInstances":"5" * } * } * } * Note: Currently, only the following fields can be updated: * * * * * * * * * * * * * * * * * * * * * * * *
MaskPurpose
labelsUpdate labels
config.worker_config.num_instancesResize primary worker group
config.secondary_worker_config.num_instancesResize secondary worker group
config.autoscaling_config.policy_uriUse, stop using, or * change autoscaling policies
* @param {string} [request.requestId] * Optional. A unique ID used to identify the request. If the server * receives two * [UpdateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.UpdateClusterRequest)s * with the same id, then the second request will be ignored and the * first {@link protos.google.longrunning.Operation|google.longrunning.Operation} created * and stored in the backend is returned. * * It is recommended to always set this value to a * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). * * The ID 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/cluster_controller.update_cluster.js * region_tag:dataproc_v1_generated_ClusterController_UpdateCluster_async */ updateCluster(request?: protos.google.cloud.dataproc.v1.IUpdateClusterRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateCluster(request: protos.google.cloud.dataproc.v1.IUpdateClusterRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateCluster(request: protos.google.cloud.dataproc.v1.IUpdateClusterRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updateCluster()`. * @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/cluster_controller.update_cluster.js * region_tag:dataproc_v1_generated_ClusterController_UpdateCluster_async */ checkUpdateClusterProgress(name: string): Promise>; /** * Stops a cluster in a project. * * @param {Object} request * The request object that will be sent. * @param {string} request.projectId * Required. The ID of the Google Cloud Platform project the * cluster belongs to. * @param {string} request.region * Required. The Dataproc region in which to handle the request. * @param {string} request.clusterName * Required. The cluster name. * @param {string} [request.clusterUuid] * Optional. Specifying the `cluster_uuid` means the RPC will fail * (with error NOT_FOUND) if a cluster with the specified UUID does not exist. * @param {string} [request.requestId] * Optional. A unique ID used to identify the request. If the server * receives two * [StopClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StopClusterRequest)s * with the same id, then the second request will be ignored and the * first {@link protos.google.longrunning.Operation|google.longrunning.Operation} created * and stored in the backend is returned. * * Recommendation: Set this value to a * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). * * The ID 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/cluster_controller.stop_cluster.js * region_tag:dataproc_v1_generated_ClusterController_StopCluster_async */ stopCluster(request?: protos.google.cloud.dataproc.v1.IStopClusterRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; stopCluster(request: protos.google.cloud.dataproc.v1.IStopClusterRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; stopCluster(request: protos.google.cloud.dataproc.v1.IStopClusterRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `stopCluster()`. * @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/cluster_controller.stop_cluster.js * region_tag:dataproc_v1_generated_ClusterController_StopCluster_async */ checkStopClusterProgress(name: string): Promise>; /** * Starts a cluster in a project. * * @param {Object} request * The request object that will be sent. * @param {string} request.projectId * Required. The ID of the Google Cloud Platform project the * cluster belongs to. * @param {string} request.region * Required. The Dataproc region in which to handle the request. * @param {string} request.clusterName * Required. The cluster name. * @param {string} [request.clusterUuid] * Optional. Specifying the `cluster_uuid` means the RPC will fail * (with error NOT_FOUND) if a cluster with the specified UUID does not exist. * @param {string} [request.requestId] * Optional. A unique ID used to identify the request. If the server * receives two * [StartClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StartClusterRequest)s * with the same id, then the second request will be ignored and the * first {@link protos.google.longrunning.Operation|google.longrunning.Operation} created * and stored in the backend is returned. * * Recommendation: Set this value to a * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). * * The ID 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/cluster_controller.start_cluster.js * region_tag:dataproc_v1_generated_ClusterController_StartCluster_async */ startCluster(request?: protos.google.cloud.dataproc.v1.IStartClusterRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; startCluster(request: protos.google.cloud.dataproc.v1.IStartClusterRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; startCluster(request: protos.google.cloud.dataproc.v1.IStartClusterRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `startCluster()`. * @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/cluster_controller.start_cluster.js * region_tag:dataproc_v1_generated_ClusterController_StartCluster_async */ checkStartClusterProgress(name: string): Promise>; /** * Deletes a cluster in a project. The returned * {@link protos.google.longrunning.Operation.metadata|Operation.metadata} will be * [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). * * @param {Object} request * The request object that will be sent. * @param {string} request.projectId * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. * @param {string} request.region * Required. The Dataproc region in which to handle the request. * @param {string} request.clusterName * Required. The cluster name. * @param {string} [request.clusterUuid] * Optional. Specifying the `cluster_uuid` means the RPC should fail * (with error NOT_FOUND) if cluster with specified UUID does not exist. * @param {string} [request.requestId] * Optional. A unique ID used to identify the request. If the server * receives two * [DeleteClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteClusterRequest)s * with the same id, then the second request will be ignored and the * first {@link protos.google.longrunning.Operation|google.longrunning.Operation} created * and stored in the backend is returned. * * It is recommended to always set this value to a * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). * * The ID 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/cluster_controller.delete_cluster.js * region_tag:dataproc_v1_generated_ClusterController_DeleteCluster_async */ deleteCluster(request?: protos.google.cloud.dataproc.v1.IDeleteClusterRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteCluster(request: protos.google.cloud.dataproc.v1.IDeleteClusterRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteCluster(request: protos.google.cloud.dataproc.v1.IDeleteClusterRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteCluster()`. * @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/cluster_controller.delete_cluster.js * region_tag:dataproc_v1_generated_ClusterController_DeleteCluster_async */ checkDeleteClusterProgress(name: string): Promise>; /** * Gets cluster diagnostic information. The returned * {@link protos.google.longrunning.Operation.metadata|Operation.metadata} will be * [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). * After the operation completes, * {@link protos.google.longrunning.Operation.response|Operation.response} * contains * [DiagnoseClusterResults](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults). * * @param {Object} request * The request object that will be sent. * @param {string} request.projectId * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. * @param {string} request.region * Required. The Dataproc region in which to handle the request. * @param {string} request.clusterName * Required. The cluster name. * @param {string} [request.tarballGcsDir] * Optional. (Optional) The output Cloud Storage directory for the diagnostic * tarball. If not specified, a task-specific directory in the cluster's * staging bucket will be used. * @param {google.cloud.dataproc.v1.DiagnoseClusterRequest.TarballAccess} [request.tarballAccess] * Optional. (Optional) The access type to the diagnostic tarball. If not * specified, falls back to default access of the bucket * @param {google.type.Interval} [request.diagnosisInterval] * Optional. Time interval in which diagnosis should be carried out on the * cluster. * @param {string[]} [request.jobs] * Optional. Specifies a list of jobs on which diagnosis is to be performed. * Format: projects/{project}/regions/{region}/jobs/{job} * @param {string[]} [request.yarnApplicationIds] * Optional. Specifies a list of yarn applications on which diagnosis is to be * performed. * @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/cluster_controller.diagnose_cluster.js * region_tag:dataproc_v1_generated_ClusterController_DiagnoseCluster_async */ diagnoseCluster(request?: protos.google.cloud.dataproc.v1.IDiagnoseClusterRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; diagnoseCluster(request: protos.google.cloud.dataproc.v1.IDiagnoseClusterRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; diagnoseCluster(request: protos.google.cloud.dataproc.v1.IDiagnoseClusterRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `diagnoseCluster()`. * @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/cluster_controller.diagnose_cluster.js * region_tag:dataproc_v1_generated_ClusterController_DiagnoseCluster_async */ checkDiagnoseClusterProgress(name: string): Promise>; /** * Lists all regions/{region}/clusters in a project alphabetically. * * @param {Object} request * The request object that will be sent. * @param {string} request.projectId * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. * @param {string} request.region * Required. The Dataproc region in which to handle the request. * @param {string} [request.filter] * Optional. A filter constraining the clusters to list. Filters are * case-sensitive and have the following syntax: * * field = value [AND [field = value]] ... * * where **field** is one of `status.state`, `clusterName`, or `labels.[KEY]`, * and `[KEY]` is a label key. **value** can be `*` to match all values. * `status.state` can be one of the following: `ACTIVE`, `INACTIVE`, * `CREATING`, `RUNNING`, `ERROR`, `DELETING`, `UPDATING`, `STOPPING`, or * `STOPPED`. `ACTIVE` contains the `CREATING`, `UPDATING`, and `RUNNING` * states. `INACTIVE` contains the `DELETING`, `ERROR`, `STOPPING`, and * `STOPPED` states. `clusterName` is the name of the cluster provided at * creation time. Only the logical `AND` operator is supported; * space-separated items are treated as having an implicit `AND` operator. * * Example filter: * * status.state = ACTIVE AND clusterName = mycluster * AND labels.env = staging AND labels.starred = * * @param {number} [request.pageSize] * Optional. The standard List page size. * @param {string} [request.pageToken] * Optional. 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 {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.dataproc.v1.Cluster|Cluster}. * 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 `listClustersAsync()` * 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. */ listClusters(request?: protos.google.cloud.dataproc.v1.IListClustersRequest, options?: CallOptions): Promise<[ protos.google.cloud.dataproc.v1.ICluster[], protos.google.cloud.dataproc.v1.IListClustersRequest | null, protos.google.cloud.dataproc.v1.IListClustersResponse ]>; listClusters(request: protos.google.cloud.dataproc.v1.IListClustersRequest, options: CallOptions, callback: PaginationCallback): void; listClusters(request: protos.google.cloud.dataproc.v1.IListClustersRequest, callback: PaginationCallback): void; /** * Equivalent to `listClusters`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.projectId * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. * @param {string} request.region * Required. The Dataproc region in which to handle the request. * @param {string} [request.filter] * Optional. A filter constraining the clusters to list. Filters are * case-sensitive and have the following syntax: * * field = value [AND [field = value]] ... * * where **field** is one of `status.state`, `clusterName`, or `labels.[KEY]`, * and `[KEY]` is a label key. **value** can be `*` to match all values. * `status.state` can be one of the following: `ACTIVE`, `INACTIVE`, * `CREATING`, `RUNNING`, `ERROR`, `DELETING`, `UPDATING`, `STOPPING`, or * `STOPPED`. `ACTIVE` contains the `CREATING`, `UPDATING`, and `RUNNING` * states. `INACTIVE` contains the `DELETING`, `ERROR`, `STOPPING`, and * `STOPPED` states. `clusterName` is the name of the cluster provided at * creation time. Only the logical `AND` operator is supported; * space-separated items are treated as having an implicit `AND` operator. * * Example filter: * * status.state = ACTIVE AND clusterName = mycluster * AND labels.env = staging AND labels.starred = * * @param {number} [request.pageSize] * Optional. The standard List page size. * @param {string} [request.pageToken] * Optional. 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 {Stream} * An object stream which emits an object representing {@link protos.google.cloud.dataproc.v1.Cluster|Cluster} 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 `listClustersAsync()` * 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. */ listClustersStream(request?: protos.google.cloud.dataproc.v1.IListClustersRequest, options?: CallOptions): Transform; /** * Equivalent to `listClusters`, 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.projectId * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. * @param {string} request.region * Required. The Dataproc region in which to handle the request. * @param {string} [request.filter] * Optional. A filter constraining the clusters to list. Filters are * case-sensitive and have the following syntax: * * field = value [AND [field = value]] ... * * where **field** is one of `status.state`, `clusterName`, or `labels.[KEY]`, * and `[KEY]` is a label key. **value** can be `*` to match all values. * `status.state` can be one of the following: `ACTIVE`, `INACTIVE`, * `CREATING`, `RUNNING`, `ERROR`, `DELETING`, `UPDATING`, `STOPPING`, or * `STOPPED`. `ACTIVE` contains the `CREATING`, `UPDATING`, and `RUNNING` * states. `INACTIVE` contains the `DELETING`, `ERROR`, `STOPPING`, and * `STOPPED` states. `clusterName` is the name of the cluster provided at * creation time. Only the logical `AND` operator is supported; * space-separated items are treated as having an implicit `AND` operator. * * Example filter: * * status.state = ACTIVE AND clusterName = mycluster * AND labels.env = staging AND labels.starred = * * @param {number} [request.pageSize] * Optional. The standard List page size. * @param {string} [request.pageToken] * Optional. 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 protos.google.cloud.dataproc.v1.Cluster|Cluster}. 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/cluster_controller.list_clusters.js * region_tag:dataproc_v1_generated_ClusterController_ListClusters_async */ listClustersAsync(request?: protos.google.cloud.dataproc.v1.IListClustersRequest, 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 cryptoKey resource name string. * * @param {string} project * @param {string} location * @param {string} key_ring * @param {string} crypto_key * @returns {string} Resource name string. */ cryptoKeyPath(project: string, location: string, keyRing: string, cryptoKey: string): string; /** * Parse the project from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the project. */ matchProjectFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the location from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the location. */ matchLocationFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the key_ring from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the key_ring. */ matchKeyRingFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the crypto_key from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the crypto_key. */ matchCryptoKeyFromCryptoKeyName(cryptoKeyName: 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 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 service resource name string. * * @param {string} project * @param {string} location * @param {string} service * @returns {string} Resource name string. */ servicePath(project: string, location: string, service: string): string; /** * Parse the project from Service resource. * * @param {string} serviceName * A fully-qualified path representing Service resource. * @returns {string} A string representing the project. */ matchProjectFromServiceName(serviceName: string): string | number; /** * Parse the location from Service resource. * * @param {string} serviceName * A fully-qualified path representing Service resource. * @returns {string} A string representing the location. */ matchLocationFromServiceName(serviceName: string): string | number; /** * Parse the service from Service resource. * * @param {string} serviceName * A fully-qualified path representing Service resource. * @returns {string} A string representing the service. */ matchServiceFromServiceName(serviceName: 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; }