/** * Copyright 2019 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { GaxiosPromise } from 'gaxios'; import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library'; import { BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common'; export declare namespace dataproc_v1beta2 { interface Options extends GlobalOptions { version: 'v1beta2'; } interface StandardParameters { /** * V1 error format. */ '$.xgafv'?: string; /** * OAuth access token. */ access_token?: string; /** * Data format for response. */ alt?: string; /** * JSONP */ callback?: string; /** * Selector specifying which fields to include in a partial response. */ fields?: string; /** * API key. Your API key identifies your project and provides you with API * access, quota, and reports. Required unless you provide an OAuth 2.0 * token. */ key?: string; /** * OAuth 2.0 token for the current user. */ oauth_token?: string; /** * Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** * Available to use for quota purposes for server-side applications. Can be * any arbitrary string assigned to a user, but should not exceed 40 * characters. */ quotaUser?: string; /** * Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** * Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; } /** * Cloud Dataproc API * * Manages Hadoop-based clusters and jobs on Google Cloud Platform. * * @example * const {google} = require('googleapis'); * const dataproc = google.dataproc('v1beta2'); * * @namespace dataproc * @type {Function} * @version v1beta2 * @variation v1beta2 * @param {object=} options Options for Dataproc */ class Dataproc { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * Specifies the type and number of accelerator cards attached to the * instances of an instance group (see GPUs on Compute Engine). */ interface Schema$AcceleratorConfig { /** * The number of the accelerator cards of this type exposed to this * instance. */ acceleratorCount?: number; /** * Full URL, partial URI, or short name of the accelerator type resource to * expose to this instance. See Compute Engine AcceleratorTypes( * /compute/docs/reference/beta/acceleratorTypes)Examples * * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * * * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * * nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud * Dataproc Auto Zone Placement feature, you must use the short name of the * accelerator type resource, for example, nvidia-tesla-k80. */ acceleratorTypeUri?: string; } /** * Allocation Affinity for consuming Zonal allocation. */ interface Schema$AllocationAffinity { consumeAllocationType?: string; /** * Corresponds to the label key of Allocation resource. */ key?: string; /** * Corresponds to the label values of allocation resource. */ values?: string[]; } /** * Associates members with a role. */ interface Schema$Binding { /** * Unimplemented. The condition that is associated with this binding. NOTE: * an unsatisfied condition will not allow user access via current binding. * Different bindings, including their conditions, are examined * independently. */ condition?: Schema$Expr; /** * Specifies the identities requesting access for a Cloud Platform resource. * members can have the following values: allUsers: A special identifier * that represents anyone who is on the internet; with or without a Google * account. allAuthenticatedUsers: A special identifier that represents * anyone who is authenticated with a Google account or a service account. * user:{emailid}: An email address that represents a specific Google * account. For example, alice@gmail.com . serviceAccount:{emailid}: An * email address that represents a service account. For example, * my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email * address that represents a Google group. For example, admins@example.com. * domain:{domain}: A Google Apps domain name that represents all the users * of that domain. For example, google.com or example.com. */ members?: string[]; /** * Role that is assigned to members. For example, roles/viewer, * roles/editor, or roles/owner. */ role?: string; } /** * A request to cancel a job. */ interface Schema$CancelJobRequest { } /** * Describes the identifying information, config, and status of a cluster of * Compute Engine instances. */ interface Schema$Cluster { /** * Required. The cluster name. Cluster names within a project must be * unique. Names of deleted clusters can be reused. */ clusterName?: string; /** * Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc * generates this value when it creates the cluster. */ clusterUuid?: string; /** * Required. The cluster config. Note that Cloud Dataproc may set default * values, and values may change when clusters are updated. */ config?: Schema$ClusterConfig; /** * Optional. The labels to associate with this cluster. Label keys must * contain 1 to 63 characters, and must conform to RFC 1035 * (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, * if present, must contain 1 to 63 characters, and must conform to RFC 1035 * (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be * associated with a cluster. */ labels?: { [key: string]: string; }; /** * Output only. Contains cluster daemon metrics such as HDFS and YARN * stats.Beta Feature: This report is available for testing purposes only. * It may be changed before final release. */ metrics?: Schema$ClusterMetrics; /** * Required. The Google Cloud Platform project ID that the cluster belongs * to. */ projectId?: string; /** * Output only. Cluster status. */ status?: Schema$ClusterStatus; /** * Output only. The previous cluster status. */ statusHistory?: Schema$ClusterStatus[]; } /** * The cluster config. */ interface Schema$ClusterConfig { /** * Optional. A Cloud Storage staging bucket used for sharing generated SSH * keys and config. If you do not specify a staging bucket, Cloud Dataproc * will determine an appropriate Cloud Storage location (US, ASIA, or EU) * for your cluster's staging bucket according to the Google Compute * Engine zone where your cluster is deployed, and then it will create and * manage this project-level, per-location bucket for you. */ configBucket?: string; /** * Optional. Encryption settings for the cluster. */ encryptionConfig?: Schema$EncryptionConfig; /** * Required. The shared Compute Engine config settings for all instances in * a cluster. */ gceClusterConfig?: Schema$GceClusterConfig; /** * Optional. Commands to execute on each node after config is completed. By * default, executables are run on master and all worker nodes. You can test * a node's <code>role</code> metadata to run an executable * on a master or worker node, as shown below using curl (you can also use * wget): ROLE=$(curl -H Metadata-Flavor:Google * http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role) * if [[ "${ROLE}" == 'Master' ]]; then ... master * specific actions ... else ... worker specific actions ... fi */ initializationActions?: Schema$NodeInitializationAction[]; /** * Optional. The config setting for auto delete cluster schedule. */ lifecycleConfig?: Schema$LifecycleConfig; /** * Optional. The Compute Engine config settings for the master instance in a * cluster. */ masterConfig?: Schema$InstanceGroupConfig; /** * Optional. The Compute Engine config settings for additional worker * instances in a cluster. */ secondaryWorkerConfig?: Schema$InstanceGroupConfig; /** * Optional. The config settings for software inside the cluster. */ softwareConfig?: Schema$SoftwareConfig; /** * Optional. The Compute Engine config settings for worker instances in a * cluster. */ workerConfig?: Schema$InstanceGroupConfig; } /** * Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: * This report is available for testing purposes only. It may be changed * before final release. */ interface Schema$ClusterMetrics { /** * The HDFS metrics. */ hdfsMetrics?: { [key: string]: string; }; /** * The YARN metrics. */ yarnMetrics?: { [key: string]: string; }; } /** * The cluster operation triggered by a workflow. */ interface Schema$ClusterOperation { /** * Output only. Indicates the operation is done. */ done?: boolean; /** * Output only. Error, if operation failed. */ error?: string; /** * Output only. The id of the cluster operation. */ operationId?: string; } /** * Metadata describing the operation. */ interface Schema$ClusterOperationMetadata { /** * Output only. Name of the cluster for the operation. */ clusterName?: string; /** * Output only. Cluster UUID for the operation. */ clusterUuid?: string; /** * Output only. Short description of operation. */ description?: string; /** * Output only. Labels associated with the operation */ labels?: { [key: string]: string; }; /** * Output only. The operation type. */ operationType?: string; /** * Output only. Current operation status. */ status?: Schema$ClusterOperationStatus; /** * Output only. The previous operation status. */ statusHistory?: Schema$ClusterOperationStatus[]; /** * Output only. Errors encountered during operation execution. */ warnings?: string[]; } /** * The status of the operation. */ interface Schema$ClusterOperationStatus { /** * Output only. A message containing any operation metadata details. */ details?: string; /** * Output only. A message containing the detailed operation state. */ innerState?: string; /** * Output only. A message containing the operation state. */ state?: string; /** * Output only. The time this state was entered. */ stateStartTime?: string; } /** * A selector that chooses target cluster for jobs based on metadata. */ interface Schema$ClusterSelector { /** * Required. The cluster labels. Cluster must have all labels to match. */ clusterLabels?: { [key: string]: string; }; /** * Optional. The zone where workflow process executes. This parameter does * not affect the selection of the cluster.If unspecified, the zone of the * first cluster matching the selector is used. */ zone?: string; } /** * The status of a cluster and its instances. */ interface Schema$ClusterStatus { /** * Output only. Optional details of cluster's state. */ detail?: string; /** * Output only. The cluster's state. */ state?: string; /** * Output only. Time when this state was entered. */ stateStartTime?: string; /** * Output only. Additional state information that includes status reported * by the agent. */ substate?: string; } /** * A request to collect cluster diagnostic information. */ interface Schema$DiagnoseClusterRequest { } /** * The location of diagnostic output. */ interface Schema$DiagnoseClusterResults { /** * Output only. The Cloud Storage URI of the diagnostic output. The output * report is a plain text file with a summary of collected diagnostics. */ outputUri?: string; } /** * Specifies the config of disk options for a group of VM instances. */ interface Schema$DiskConfig { /** * Optional. Size in GB of the boot disk (default is 500GB). */ bootDiskSizeGb?: number; /** * Optional. Type of the boot disk (default is "pd-standard"). * Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or * "pd-standard" (Persistent Disk Hard Disk Drive). */ bootDiskType?: string; /** * Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs * are not attached, the boot disk is used to store runtime logs and HDFS * (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one * or more SSDs are attached, this runtime bulk data is spread across them, * and the boot disk contains only basic config and installed binaries. */ numLocalSsds?: number; } /** * A generic empty message that you can re-use to avoid defining duplicated * empty messages in your APIs. A typical example is to use it as the request * or the response type of an API method. For instance: service Foo { rpc * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON * representation for Empty is empty JSON object {}. */ interface Schema$Empty { } /** * Encryption settings for the cluster. */ interface Schema$EncryptionConfig { /** * Optional. The Cloud KMS key name to use for PD disk encryption for all * instances in the cluster. */ gcePdKmsKeyName?: string; } /** * Represents an expression text. Example: title: "User account * presence" description: "Determines whether the request has a user * account" expression: "size(request.user) > 0" */ interface Schema$Expr { /** * An optional description of the expression. This is a longer text which * describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** * Textual representation of an expression in Common Expression Language * syntax.The application context of the containing message determines which * well-known feature set of CEL is supported. */ expression?: string; /** * An optional string indicating the location of the expression for error * reporting, e.g. a file name and a position in the file. */ location?: string; /** * An optional title for the expression, i.e. a short string describing its * purpose. This can be used e.g. in UIs which allow to enter the * expression. */ title?: string; } /** * Common config settings for resources of Compute Engine cluster instances, * applicable to all instances in the cluster. */ interface Schema$GceClusterConfig { /** * Allocation Affinity for consuming Zonal allocation. */ allocationAffinity?: Schema$AllocationAffinity; /** * Optional. If true, all instances in the cluster will only have internal * IP addresses. By default, clusters are not restricted to internal IP * addresses, and will have ephemeral external IP addresses assigned to each * instance. This internal_ip_only restriction can only be enabled for * subnetwork enabled networks, and all off-cluster dependencies must be * configured to be accessible without external IP addresses. */ internalIpOnly?: boolean; /** * The Compute Engine metadata entries to add to all instances (see Project * and instance metadata * (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). */ metadata?: { [key: string]: string; }; /** * Optional. The Compute Engine network to be used for machine * communications. Cannot be specified with subnetwork_uri. If neither * network_uri nor subnetwork_uri is specified, the "default" * network of the project is used, if it exists. Cannot be a "Custom * Subnet Network" (see Using Subnetworks for more information).A full * URL, partial URI, or short name are valid. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default * projects/[project_id]/regions/global/default default */ networkUri?: string; /** * Optional. The service account of the instances. Defaults to the default * Compute Engine service account. Custom service accounts need permissions * equivalent to the following IAM roles: roles/logging.logWriter * roles/storage.objectAdmin(see * https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts * for more information). Example: * [account_id]@[project_id].iam.gserviceaccount.com */ serviceAccount?: string; /** * Optional. The URIs of service account scopes to be included in Compute * Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.writeIf no scopes are specified, * the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control */ serviceAccountScopes?: string[]; /** * Optional. The Compute Engine subnetwork to be used for machine * communications. Cannot be specified with network_uri.A full URL, partial * URI, or short name are valid. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0 * projects/[project_id]/regions/us-east1/sub0 sub0 */ subnetworkUri?: string; /** * The Compute Engine tags to add to all instances (see Tagging instances). */ tags?: string[]; /** * Optional. The zone where the Compute Engine cluster will be located. On a * create request, it is required in the "global" region. If * omitted in a non-global Cloud Dataproc region, the service will pick a * zone in the corresponding Compute Engine region. On a get request, zone * will always be present.A full URL, partial URI, or short name are valid. * Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] * projects/[project_id]/zones/[zone] us-central1-f */ zoneUri?: string; } /** * Request message for GetIamPolicy method. */ interface Schema$GetIamPolicyRequest { } /** * A Cloud Dataproc job for running Apache Hadoop MapReduce * (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) * jobs on Apache Hadoop YARN * (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). */ interface Schema$HadoopJob { /** * Optional. HCFS URIs of archives to be extracted in the working directory * of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, * .tgz, or .zip. */ archiveUris?: string[]; /** * Optional. The arguments to pass to the driver. Do not include arguments, * such as -libjars or -Dfoo=bar, that can be set as job properties, since a * collision may occur that causes an incorrect job submission. */ args?: string[]; /** * Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied * to the working directory of Hadoop drivers and distributed tasks. Useful * for naively parallel tasks. */ fileUris?: string[]; /** * Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and * tasks. */ jarFileUris?: string[]; /** * Optional. The runtime log config for job execution. */ loggingConfig?: Schema$LoggingConfig; /** * The name of the driver's main class. The jar file containing the * class must be in the default CLASSPATH or specified in jar_file_uris. */ mainClass?: string; /** * The HCFS URI of the jar file containing the main class. Examples: * 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' * 'hdfs:/tmp/test-samples/custom-wordcount.jar' * 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' */ mainJarFileUri?: string; /** * Optional. A mapping of property names to values, used to configure * Hadoop. Properties that conflict with values set by the Cloud Dataproc * API may be overwritten. Can include properties set in * /etc/hadoop/conf/*-site and classes in user code. */ properties?: { [key: string]: string; }; } /** * A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) * queries on YARN. */ interface Schema$HiveJob { /** * Optional. Whether to continue executing queries if a query fails. The * default value is false. Setting to true can be useful when executing * independent parallel queries. */ continueOnFailure?: boolean; /** * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive * server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. */ jarFileUris?: string[]; /** * Optional. A mapping of property names and values, used to configure Hive. * Properties that conflict with values set by the Cloud Dataproc API may be * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, * /etc/hive/conf/hive-site.xml, and classes in user code. */ properties?: { [key: string]: string; }; /** * The HCFS URI of the script that contains Hive queries. */ queryFileUri?: string; /** * A list of queries. */ queryList?: Schema$QueryList; /** * Optional. Mapping of query variable names to values (equivalent to the * Hive command: SET name="value";). */ scriptVariables?: { [key: string]: string; }; } /** * Optional. The config settings for Compute Engine resources in an instance * group, such as a master or worker group. */ interface Schema$InstanceGroupConfig { /** * Optional. The Compute Engine accelerator configuration for these * instances.Beta Feature: This feature is still under development. It may * be changed before final release. */ accelerators?: Schema$AcceleratorConfig[]; /** * Optional. Disk option config settings. */ diskConfig?: Schema$DiskConfig; /** * Optional. The Compute Engine image resource used for cluster instances. * It can be specified or may be inferred from SoftwareConfig.image_version. */ imageUri?: string; /** * Output only. The list of instance names. Cloud Dataproc derives the names * from cluster_name, num_instances, and the instance group. */ instanceNames?: string[]; /** * Optional. Specifies that this instance group contains preemptible * instances. */ isPreemptible?: boolean; /** * Optional. The Compute Engine machine type used for cluster instances.A * full URL, partial URI, or short name are valid. Examples: * https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 * projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 * n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc * Auto Zone Placement feature, you must use the short name of the machine * type resource, for example, n1-standard-2. */ machineTypeUri?: string; /** * Output only. The config for Compute Engine Instance Group Manager that * manages this group. This is only used for preemptible instance groups. */ managedGroupConfig?: Schema$ManagedGroupConfig; /** * Optional. Specifies the minimum cpu platform for the Instance Group. See * Cloud Dataproc&rarr;Minimum CPU Platform. */ minCpuPlatform?: string; /** * Optional. The number of VM instances in the instance group. For master * instance groups, must be set to 1. */ numInstances?: number; } /** * A request to instantiate a workflow template. */ interface Schema$InstantiateWorkflowTemplateRequest { /** * Deprecated. Please use request_id field instead. */ instanceId?: string; /** * Optional. Map from parameter names to values that should be used for * those parameters. Values may not exceed 100 characters. */ parameters?: { [key: string]: string; }; /** * 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. */ requestId?: string; /** * 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. */ version?: number; } /** * A Cloud Dataproc job resource. */ interface Schema$Job { /** * Output only. If present, the location of miscellaneous control files * which may be used as part of job setup and handling. If not present, * control files may be placed in the same location as driver_output_uri. */ driverControlFilesUri?: string; /** * Output only. A URI pointing to the location of the stdout of the * job's driver program. */ driverOutputResourceUri?: string; /** * Job is a Hadoop job. */ hadoopJob?: Schema$HadoopJob; /** * Job is a Hive job. */ hiveJob?: Schema$HiveJob; /** * Output only. A UUID that uniquely identifies a job within the project * over time. This is in contrast to a user-settable reference.job_id that * may be reused over time. */ jobUuid?: string; /** * Optional. The labels to associate with this job. Label keys must contain * 1 to 63 characters, and must conform to RFC 1035 * (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, * if present, must contain 1 to 63 characters, and must conform to RFC 1035 * (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be * associated with a job. */ labels?: { [key: string]: string; }; /** * Job is a Pig job. */ pigJob?: Schema$PigJob; /** * Required. Job information, including how, when, and where to run the job. */ placement?: Schema$JobPlacement; /** * Job is a Pyspark job. */ pysparkJob?: Schema$PySparkJob; /** * Optional. The fully qualified reference to the job, which can be used to * obtain the equivalent REST path of the job resource. If this property is * not specified when a job is created, the server generates a * <code>job_id</code>. */ reference?: Schema$JobReference; /** * Optional. Job scheduling configuration. */ scheduling?: Schema$JobScheduling; /** * Job is a Spark job. */ sparkJob?: Schema$SparkJob; /** * Job is a SparkR job. */ sparkRJob?: Schema$SparkRJob; /** * Job is a SparkSql job. */ sparkSqlJob?: Schema$SparkSqlJob; /** * Output only. The job status. Additional application-specific status * information may be contained in the <code>type_job</code> and * <code>yarn_applications</code> fields. */ status?: Schema$JobStatus; /** * Output only. The previous job status. */ statusHistory?: Schema$JobStatus[]; /** * Output only. The email address of the user submitting the job. For jobs * submitted on the cluster, the address is * <code>username@hostname</code>. */ submittedBy?: string; /** * Output only. The collection of YARN applications spun up by this job.Beta * Feature: This report is available for testing purposes only. It may be * changed before final release. */ yarnApplications?: Schema$YarnApplication[]; } /** * Cloud Dataproc job config. */ interface Schema$JobPlacement { /** * Required. The name of the cluster where the job will be submitted. */ clusterName?: string; /** * Output only. A cluster UUID generated by the Cloud Dataproc service when * the job is submitted. */ clusterUuid?: string; } /** * Encapsulates the full scoping used to reference a job. */ interface Schema$JobReference { /** * Optional. The job ID, which must be unique within the project. The job ID * is generated by the server upon job submission or provided by the user as * a means to perform retries without creating duplicate jobs. The ID must * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or * hyphens (-). The maximum length is 100 characters. */ jobId?: string; /** * Required. The ID of the Google Cloud Platform project that the job * belongs to. */ projectId?: string; } /** * Job scheduling options. */ interface Schema$JobScheduling { /** * Optional. Maximum number of times per hour a driver may be restarted as a * result of driver terminating with non-zero code before job is reported * failed.A job may be reported as thrashing if driver exits with non-zero * code 4 times within 10 minute window.Maximum value is 10. */ maxFailuresPerHour?: number; } /** * Cloud Dataproc job status. */ interface Schema$JobStatus { /** * Output only. Optional job state details, such as an error description if * the state is <code>ERROR</code>. */ details?: string; /** * Output only. A state message specifying the overall job state. */ state?: string; /** * Output only. The time when this state was entered. */ stateStartTime?: string; /** * Output only. Additional state information, which includes status reported * by the agent. */ substate?: string; } /** * Specifies the cluster auto-delete schedule configuration. */ interface Schema$LifecycleConfig { /** * Optional. The time when cluster will be auto-deleted. */ autoDeleteTime?: string; /** * Optional. The lifetime duration of cluster. The cluster will be * auto-deleted at the end of this period. Valid range: 10m, 14d.Example: * "1d", to delete the cluster 1 day after its creation.. */ autoDeleteTtl?: string; /** * Optional. The duration to keep the cluster alive while idling. Passing * this threshold will cause the cluster to be deleted. Valid range: 10m, * 14d.Example: "10m", the minimum value, to delete the cluster * when it has had no jobs running for 10 minutes. */ idleDeleteTtl?: string; } /** * The list of all clusters in a project. */ interface Schema$ListClustersResponse { /** * Output only. The clusters in the project. */ clusters?: Schema$Cluster[]; /** * Output only. This token is included in the response if there are more * results to fetch. To fetch additional results, provide this value as the * page_token in a subsequent <code>ListClustersRequest</code>. */ nextPageToken?: string; } /** * A list of jobs in a project. */ interface Schema$ListJobsResponse { /** * Output only. Jobs list. */ jobs?: Schema$Job[]; /** * Optional. This token is included in the response if there are more * results to fetch. To fetch additional results, provide this value as the * page_token in a subsequent <code>ListJobsRequest</code>. */ nextPageToken?: string; } /** * The response message for Operations.ListOperations. */ interface Schema$ListOperationsResponse { /** * The standard List next-page token. */ nextPageToken?: string; /** * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; } /** * A response to a request to list workflow templates in a project. */ interface Schema$ListWorkflowTemplatesResponse { /** * Output only. This token is included in the response if there are more * results to fetch. To fetch additional results, provide this value as the * page_token in a subsequent * <code>ListWorkflowTemplatesRequest</code>. */ nextPageToken?: string; /** * Output only. WorkflowTemplates list. */ templates?: Schema$WorkflowTemplate[]; } /** * The runtime logging config of the job. */ interface Schema$LoggingConfig { /** * The per-package log levels for the driver. This may include * "root" package name to configure rootLogger. Examples: * 'com.google = FATAL', 'root = INFO', 'org.apache = * DEBUG' */ driverLogLevels?: { [key: string]: string; }; } /** * Cluster that is managed by the workflow. */ interface Schema$ManagedCluster { /** * Required. The cluster name prefix. A unique cluster name will be formed * by appending a random suffix.The name must contain only lower-case * letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. * Cannot begin or end with hyphen. Must consist of between 2 and 35 * characters. */ clusterName?: string; /** * Required. The cluster configuration. */ config?: Schema$ClusterConfig; /** * Optional. The labels to associate with this cluster.Label keys must be * between 1 and 63 characters long, and must conform to the following PCRE * regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and * 63 characters long, and must conform to the following PCRE regular * expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be * associated with a given cluster. */ labels?: { [key: string]: string; }; } /** * Specifies the resources used to actively manage an instance group. */ interface Schema$ManagedGroupConfig { /** * Output only. The name of the Instance Group Manager for this group. */ instanceGroupManagerName?: string; /** * Output only. The name of the Instance Template used for the Managed * Instance Group. */ instanceTemplateName?: string; } /** * Specifies an executable to run on a fully configured node and a timeout * period for executable completion. */ interface Schema$NodeInitializationAction { /** * Required. Cloud Storage URI of executable file. */ executableFile?: string; /** * Optional. Amount of time executable has to complete. Default is 10 * minutes. Cluster creation fails with an explanatory error message (the * name of the executable that caused the error and the exceeded timeout * period) if the executable is not completed at end of the timeout period. */ executionTimeout?: string; } /** * This resource represents a long-running operation that is the result of a * network API call. */ interface Schema$Operation { /** * If the value is false, it means the operation is still in progress. If * true, the operation is completed, and either error or response is * available. */ done?: boolean; /** * The error result of the operation in case of failure or cancellation. */ error?: Schema$Status; /** * Service-specific metadata associated with the operation. It typically * contains progress information and common metadata such as create time. * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ metadata?: { [key: string]: any; }; /** * The server-assigned name, which is only unique within the same service * that originally returns it. If you use the default HTTP mapping, the name * should have the format of operations/some/unique/name. */ name?: string; /** * The normal response of the operation in case of success. If the original * method returns no data on success, such as Delete, the response is * google.protobuf.Empty. If the original method is standard * Get/Create/Update, the response should be the resource. For other * methods, the response should have the type XxxResponse, where Xxx is the * original method name. For example, if the original method name is * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ response?: { [key: string]: any; }; } /** * A job executed by the workflow. */ interface Schema$OrderedJob { /** * Job is a Hadoop job. */ hadoopJob?: Schema$HadoopJob; /** * Job is a Hive job. */ hiveJob?: Schema$HiveJob; /** * Optional. The labels to associate with this job.Label keys must be * between 1 and 63 characters long, and must conform to the following * regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and * 63 characters long, and must conform to the following regular expression: * \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a * given job. */ labels?: { [key: string]: string; }; /** * Job is a Pig job. */ pigJob?: Schema$PigJob; /** * Optional. The optional list of prerequisite job step_ids. If not * specified, the job will start at the beginning of workflow. */ prerequisiteStepIds?: string[]; /** * Job is a Pyspark job. */ pysparkJob?: Schema$PySparkJob; /** * Optional. Job scheduling configuration. */ scheduling?: Schema$JobScheduling; /** * Job is a Spark job. */ sparkJob?: Schema$SparkJob; /** * Job is a SparkSql job. */ sparkSqlJob?: Schema$SparkSqlJob; /** * Required. The step id. The id must be unique among all jobs within the * template.The step id is used as prefix for job id, as job * goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field * from other steps.The id must contain only letters (a-z, A-Z), numbers * (0-9), underscores (_), and hyphens (-). Cannot begin or end with * underscore or hyphen. Must consist of between 3 and 50 characters. */ stepId?: string; } /** * Configuration for parameter validation. */ interface Schema$ParameterValidation { /** * Validation based on regular expressions. */ regex?: Schema$RegexValidation; /** * Validation based on a list of allowed values. */ values?: Schema$ValueValidation; } /** * A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) * queries on YARN. */ interface Schema$PigJob { /** * Optional. Whether to continue executing queries if a query fails. The * default value is false. Setting to true can be useful when executing * independent parallel queries. */ continueOnFailure?: boolean; /** * Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig * Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. */ jarFileUris?: string[]; /** * Optional. The runtime log config for job execution. */ loggingConfig?: Schema$LoggingConfig; /** * Optional. A mapping of property names to values, used to configure Pig. * Properties that conflict with values set by the Cloud Dataproc API may be * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, * /etc/pig/conf/pig.properties, and classes in user code. */ properties?: { [key: string]: string; }; /** * The HCFS URI of the script that contains the Pig queries. */ queryFileUri?: string; /** * A list of queries. */ queryList?: Schema$QueryList; /** * Optional. Mapping of query variable names to values (equivalent to the * Pig command: name=[value]). */ scriptVariables?: { [key: string]: string; }; } /** * Defines an Identity and Access Management (IAM) policy. It is used to * specify access control policies for Cloud Platform resources.A Policy * consists of a list of bindings. A binding binds a list of members to a * role, where the members can be user accounts, Google groups, Google * domains, and service accounts. A role is a named list of permissions * defined by IAM.JSON Example { "bindings": [ { * "role": "roles/owner", "members": [ * "user:mike@example.com", "group:admins@example.com", * "domain:google.com", * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] * }, { "role": "roles/viewer", * "members": ["user:sean@example.com"] } ] } YAML * Example bindings: - members: - user:mike@example.com - * group:admins@example.com - domain:google.com - * serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner * - members: - user:sean@example.com role: roles/viewer For a description * of IAM and its features, see the IAM developer's guide * (https://cloud.google.com/iam/docs). */ interface Schema$Policy { /** * Associates a list of members to a role. bindings with no members will * result in an error. */ bindings?: Schema$Binding[]; /** * etag is used for optimistic concurrency control as a way to help prevent * simultaneous updates of a policy from overwriting each other. It is * strongly suggested that systems make use of the etag in the * read-modify-write cycle to perform policy updates in order to avoid race * conditions: An etag is returned in the response to getIamPolicy, and * systems are expected to put that etag in the request to setIamPolicy to * ensure that their change will be applied to the same version of the * policy.If no etag is provided in the call to setIamPolicy, then the * existing policy is overwritten blindly. */ etag?: string; /** * Deprecated. */ version?: number; } /** * A Cloud Dataproc job for running Apache PySpark * (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) * applications on YARN. */ interface Schema$PySparkJob { /** * Optional. HCFS URIs of archives to be extracted in the working directory * of .jar, .tar, .tar.gz, .tgz, and .zip. */ archiveUris?: string[]; /** * Optional. The arguments to pass to the driver. Do not include arguments, * such as --conf, that can be set as job properties, since a collision may * occur that causes an incorrect job submission. */ args?: string[]; /** * Optional. HCFS URIs of files to be copied to the working directory of * Python drivers and distributed tasks. Useful for naively parallel tasks. */ fileUris?: string[]; /** * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python * driver and tasks. */ jarFileUris?: string[]; /** * Optional. The runtime log config for job execution. */ loggingConfig?: Schema$LoggingConfig; /** * Required. The HCFS URI of the main Python file to use as the driver. Must * be a .py file. */ mainPythonFileUri?: string; /** * Optional. A mapping of property names to values, used to configure * PySpark. Properties that conflict with values set by the Cloud Dataproc * API may be overwritten. Can include properties set in * /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: { [key: string]: string; }; /** * Optional. HCFS file URIs of Python files to pass to the PySpark * framework. Supported file types: .py, .egg, and .zip. */ pythonFileUris?: string[]; } /** * A list of queries to run on a cluster. */ interface Schema$QueryList { /** * Required. The queries to execute. You do not need to terminate a query * with a semicolon. Multiple queries can be specified in one string by * separating each with a semicolon. Here is an example of an Cloud Dataproc * API snippet that uses a QueryList to specify a HiveJob: * "hiveJob": { "queryList": { "queries": [ * "query1", "query2", "query3;query4", * ] } } */ queries?: string[]; } /** * Validation based on regular expressions. */ interface Schema$RegexValidation { /** * Required. RE2 regular expressions used to validate the parameter's * value. The value must match the regex in its entirety (substring matches * are not sufficient). */ regexes?: string[]; } /** * Request message for SetIamPolicy method. */ interface Schema$SetIamPolicyRequest { /** * REQUIRED: The complete policy to be applied to the resource. The size of * the policy is limited to a few 10s of KB. An empty policy is a valid * policy but certain Cloud Platform services (such as Projects) might * reject them. */ policy?: Schema$Policy; } /** * Specifies the selection and config of software inside the cluster. */ interface Schema$SoftwareConfig { /** * Optional. The version of software inside the cluster. It must be one of * the supported Cloud Dataproc Versions, such as "1.2" (including * a subminor version, such as "1.2.29"), or the * "preview" version. If unspecified, it defaults to the latest * version. */ imageVersion?: string; /** * The set of optional components to activate on the cluster. */ optionalComponents?: string[]; /** * Optional. The properties to set on daemon config files.Property keys are * specified in prefix:property format, such as core:fs.defaultFS. The * following are supported prefixes and their mappings: capacity-scheduler: * capacity-scheduler.xml core: core-site.xml distcp: distcp-default.xml * hdfs: hdfs-site.xml hive: hive-site.xml mapred: mapred-site.xml pig: * pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more * information, see Cluster properties. */ properties?: { [key: string]: string; }; } /** * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) * applications on YARN. */ interface Schema$SparkJob { /** * Optional. HCFS URIs of archives to be extracted in the working directory * of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, * .tgz, and .zip. */ archiveUris?: string[]; /** * Optional. The arguments to pass to the driver. Do not include arguments, * such as --conf, that can be set as job properties, since a collision may * occur that causes an incorrect job submission. */ args?: string[]; /** * Optional. HCFS URIs of files to be copied to the working directory of * Spark drivers and distributed tasks. Useful for naively parallel tasks. */ fileUris?: string[]; /** * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark * driver and tasks. */ jarFileUris?: string[]; /** * Optional. The runtime log config for job execution. */ loggingConfig?: Schema$LoggingConfig; /** * The name of the driver's main class. The jar file that contains the * class must be in the default CLASSPATH or specified in jar_file_uris. */ mainClass?: string; /** * The HCFS URI of the jar file that contains the main class. */ mainJarFileUri?: string; /** * Optional. A mapping of property names to values, used to configure Spark. * Properties that conflict with values set by the Cloud Dataproc API may be * overwritten. Can include properties set in * /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: { [key: string]: string; }; } /** * A Cloud Dataproc job for running Apache SparkR * (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. */ interface Schema$SparkRJob { /** * Optional. HCFS URIs of archives to be extracted in the working directory * of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, * .tgz, and .zip. */ archiveUris?: string[]; /** * Optional. The arguments to pass to the driver. Do not include arguments, * such as --conf, that can be set as job properties, since a collision may * occur that causes an incorrect job submission. */ args?: string[]; /** * Optional. HCFS URIs of files to be copied to the working directory of R * drivers and distributed tasks. Useful for naively parallel tasks. */ fileUris?: string[]; /** * Optional. The runtime log config for job execution. */ loggingConfig?: Schema$LoggingConfig; /** * Required. The HCFS URI of the main R file to use as the driver. Must be a * .R file. */ mainRFileUri?: string; /** * Optional. A mapping of property names to values, used to configure * SparkR. Properties that conflict with values set by the Cloud Dataproc * API may be overwritten. Can include properties set in * /etc/spark/conf/spark-defaults.conf and classes in user code. */ properties?: { [key: string]: string; }; } /** * A Cloud Dataproc job for running Apache Spark SQL * (http://spark.apache.org/sql/) queries. */ interface Schema$SparkSqlJob { /** * Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. */ jarFileUris?: string[]; /** * Optional. The runtime log config for job execution. */ loggingConfig?: Schema$LoggingConfig; /** * Optional. A mapping of property names to values, used to configure Spark * SQL's SparkConf. Properties that conflict with values set by the * Cloud Dataproc API may be overwritten. */ properties?: { [key: string]: string; }; /** * The HCFS URI of the script that contains SQL queries. */ queryFileUri?: string; /** * A list of queries. */ queryList?: Schema$QueryList; /** * Optional. Mapping of query variable names to values (equivalent to the * Spark SQL command: SET name="value";). */ scriptVariables?: { [key: string]: string; }; } /** * The Status type defines a logical error model that is suitable for * different programming environments, including REST APIs and RPC APIs. It is * used by gRPC (https://github.com/grpc). The error model is designed to be: * Simple to use and understand for most users Flexible enough to meet * unexpected needsOverviewThe Status message contains three pieces of data: * error code, error message, and error details. The error code should be an * enum value of google.rpc.Code, but it may accept additional error codes if * needed. The error message should be a developer-facing English message that * helps developers understand and resolve the error. If a localized * user-facing error message is needed, put the localized message in the error * details or localize it in the client. The optional error details may * contain arbitrary information about the error. There is a predefined set of * error detail types in the package google.rpc that can be used for common * error conditions.Language mappingThe Status message is the logical * representation of the error model, but it is not necessarily the actual * wire format. When the Status message is exposed in different client * libraries and different wire protocols, it can be mapped differently. For * example, it will likely be mapped to some exceptions in Java, but more * likely mapped to some error codes in C.Other usesThe error model and the * Status message can be used in a variety of environments, either with or * without APIs, to provide a consistent developer experience across different * environments.Example uses of this error model include: Partial errors. If a * service needs to return partial errors to the client, it may embed the * Status in the normal response to indicate the partial errors. Workflow * errors. A typical workflow has multiple steps. Each step may have a Status * message for error reporting. Batch operations. If a client uses batch * request and batch response, the Status message should be used directly * inside batch response, one for each error sub-response. Asynchronous * operations. If an API call embeds asynchronous operation results in its * response, the status of those operations should be represented directly * using the Status message. Logging. If some API errors are stored in logs, * the message Status could be used directly after any stripping needed for * security/privacy reasons. */ interface Schema$Status { /** * The status code, which should be an enum value of google.rpc.Code. */ code?: number; /** * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ details?: Array<{ [key: string]: any; }>; /** * A developer-facing error message, which should be in English. Any * user-facing error message should be localized and sent in the * google.rpc.Status.details field, or localized by the client. */ message?: string; } /** * A request to submit a job. */ interface Schema$SubmitJobRequest { /** * Required. The job resource. */ job?: Schema$Job; /** * Optional. A unique id used to identify the request. If the server * receives two SubmitJobRequest requests with the same id, then the second * request will be ignored and the first Job 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. */ requestId?: string; } /** * A configurable parameter that replaces one or more fields in the template. * Parameterizable fields: - Labels - File uris - Job properties - Job * arguments - Script variables - Main class (in HadoopJob and SparkJob) - * Zone (in ClusterSelector) */ interface Schema$TemplateParameter { /** * Optional. Brief description of the parameter. Must not exceed 1024 * characters. */ description?: string; /** * Required. Paths to all fields that the parameter replaces. A field is * allowed to appear in at most one parameter's list of field paths.A * field path is similar in syntax to a google.protobuf.FieldMask. For * example, a field path that references the zone field of a workflow * template's cluster selector would be specified as * placement.clusterSelector.zone.Also, field paths can reference fields * using the following syntax: Values in maps can be referenced by key: * labels'key' placement.clusterSelector.clusterLabels'key' * placement.managedCluster.labels'key' * placement.clusterSelector.clusterLabels'key' * jobs'step-id'.labels'key' Jobs in the jobs list can be * referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri * jobs'step-id'.hiveJob.queryFileUri * jobs'step-id'.pySparkJob.mainPythonFileUri * jobs'step-id'.hadoopJob.jarFileUris0 * jobs'step-id'.hadoopJob.archiveUris0 * jobs'step-id'.hadoopJob.fileUris0 * jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields * can be referenced by a zero-based index: * jobs'step-id'.sparkJob.args0 Other examples: * jobs'step-id'.hadoopJob.properties'key' * jobs'step-id'.hadoopJob.args0 * jobs'step-id'.hiveJob.scriptVariables'key' * jobs'step-id'.hadoopJob.mainJarFileUri * placement.clusterSelector.zoneIt may not be possible to parameterize maps * and repeated fields in their entirety since only individual map values * and individual items in repeated fields can be referenced. For example, * the following field paths are invalid: * placement.clusterSelector.clusterLabels * jobs'step-id'.sparkJob.args */ fields?: string[]; /** * Required. Parameter name. The parameter name is used as the key, and * paired with the parameter value, which are passed to the template when * the template is instantiated. The name must contain only capital letters * (A-Z), numbers (0-9), and underscores (_), and must not start with a * number. The maximum length is 40 characters. */ name?: string; /** * Optional. Validation rules to be applied to this parameter's value. */ validation?: Schema$ParameterValidation; } /** * Request message for TestIamPermissions method. */ interface Schema$TestIamPermissionsRequest { /** * The set of permissions to check for the resource. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. * For more information see IAM Overview * (https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } /** * Response message for TestIamPermissions method. */ interface Schema$TestIamPermissionsResponse { /** * A subset of TestPermissionsRequest.permissions that the caller is * allowed. */ permissions?: string[]; } /** * Validation based on a list of allowed values. */ interface Schema$ValueValidation { /** * Required. List of allowed values for the parameter. */ values?: string[]; } /** * The workflow graph. */ interface Schema$WorkflowGraph { /** * Output only. The workflow nodes. */ nodes?: Schema$WorkflowNode[]; } /** * A Cloud Dataproc workflow template resource. */ interface Schema$WorkflowMetadata { /** * Output only. The name of the target cluster. */ clusterName?: string; /** * Output only. The UUID of target cluster. */ clusterUuid?: string; /** * Output only. The create cluster operation metadata. */ createCluster?: Schema$ClusterOperation; /** * Output only. The delete cluster operation metadata. */ deleteCluster?: Schema$ClusterOperation; /** * Output only. Workflow end time. */ endTime?: string; /** * Output only. The workflow graph. */ graph?: Schema$WorkflowGraph; /** * Map from parameter names to values that were used for those parameters. */ parameters?: { [key: string]: string; }; /** * Output only. Workflow start time. */ startTime?: string; /** * Output only. The workflow state. */ state?: string; /** * Output only. The "resource name" of the template. */ template?: string; /** * Output only. The version of template at the time of workflow * instantiation. */ version?: number; } /** * The workflow node. */ interface Schema$WorkflowNode { /** * Output only. The error detail. */ error?: string; /** * Output only. The job id; populated after the node enters RUNNING state. */ jobId?: string; /** * Output only. Node's prerequisite nodes. */ prerequisiteStepIds?: string[]; /** * Output only. The node state. */ state?: string; /** * Output only. The name of the node. */ stepId?: string; } /** * A Cloud Dataproc workflow template resource. */ interface Schema$WorkflowTemplate { /** * Output only. The time template was created. */ createTime?: string; /** * Required. The template id.The id must contain only letters (a-z, A-Z), * numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with * underscore or hyphen. Must consist of between 3 and 50 characters.. */ id?: string; /** * Required. The Directed Acyclic Graph of Jobs to submit. */ jobs?: Schema$OrderedJob[]; /** * Optional. The labels to associate with this template. These labels will * be propagated to all jobs and clusters created by the workflow * instance.Label keys must contain 1 to 63 characters, and must conform to * RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be * empty, but, if present, must contain 1 to 63 characters, and must conform * to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels * can be associated with a template. */ labels?: { [key: string]: string; }; /** * Output only. The "resource name" of the template, as described * in https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** * Optional. Template parameters whose values are substituted into the * template. Values for parameters must be provided when the template is * instantiated. */ parameters?: Schema$TemplateParameter[]; /** * Required. WorkflowTemplate scheduling information. */ placement?: Schema$WorkflowTemplatePlacement; /** * Output only. The time template was last updated. */ updateTime?: string; /** * Optional. Used to perform a consistent read-modify-write.This field * should be left blank for a CreateWorkflowTemplate request. It is required * for an UpdateWorkflowTemplate request, and must match the current server * version. A typical update template flow would fetch the current template * with a GetWorkflowTemplate request, which will return the current * template with the version field filled in with the current server * version. The user updates other fields in the template, then returns it * as part of the UpdateWorkflowTemplate request. */ version?: number; } /** * Specifies workflow execution target.Either managed_cluster or * cluster_selector is required. */ interface Schema$WorkflowTemplatePlacement { /** * Optional. A selector that chooses target cluster for jobs based on * metadata.The selector is evaluated at the time each job is submitted. */ clusterSelector?: Schema$ClusterSelector; /** * Optional. A cluster that is managed by the workflow. */ managedCluster?: Schema$ManagedCluster; } /** * A YARN application created by a job. Application information is a subset of * <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta * Feature: This report is available for testing purposes only. It may be * changed before final release. */ interface Schema$YarnApplication { /** * Required. The application name. */ name?: string; /** * Required. The numerical progress of the application, from 1 to 100. */ progress?: number; /** * Required. The application state. */ state?: string; /** * Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or * TimelineServer that provides application-specific information. The URL * uses the internal hostname, and requires a proxy server for resolution * and, possibly, access. */ trackingUrl?: string; } class Resource$Projects { locations: Resource$Projects$Locations; regions: Resource$Projects$Regions; constructor(); } class Resource$Projects$Locations { workflowTemplates: Resource$Projects$Locations$Workflowtemplates; constructor(); } class Resource$Projects$Locations$Workflowtemplates { constructor(); /** * dataproc.projects.locations.workflowTemplates.create * @desc Creates new workflow template. * @alias dataproc.projects.locations.workflowTemplates.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} * @param {().WorkflowTemplate} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Projects$Locations$Workflowtemplates$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Projects$Locations$Workflowtemplates$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Projects$Locations$Workflowtemplates$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * dataproc.projects.locations.workflowTemplates.delete * @desc Deletes a workflow template. It does not cancel in-progress * workflows. * @alias dataproc.projects.locations.workflowTemplates.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} * @param {integer=} params.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] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Projects$Locations$Workflowtemplates$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Projects$Locations$Workflowtemplates$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Locations$Workflowtemplates$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * dataproc.projects.locations.workflowTemplates.get * @desc Retrieves the latest workflow template.Can retrieve previously * instantiated template by specifying optional version parameter. * @alias dataproc.projects.locations.workflowTemplates.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} * @param {integer=} params.version Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Locations$Workflowtemplates$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Projects$Locations$Workflowtemplates$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Locations$Workflowtemplates$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * dataproc.projects.locations.workflowTemplates.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty * policy if the resource exists and does not have a policy set. * @alias dataproc.projects.locations.workflowTemplates.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ getIamPolicy(params?: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, options?: MethodOptions): GaxiosPromise; getIamPolicy(params: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getIamPolicy(params: Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy, callback: BodyResponseCallback): void; getIamPolicy(callback: BodyResponseCallback): void; /** * dataproc.projects.locations.workflowTemplates.instantiate * @desc Instantiates a template and begins execution.The returned Operation * can be used to track execution of workflow by polling operations.get. The * Operation will complete when entire workflow is finished.The running * workflow can be aborted via operations.cancel. This will cause any * inflight jobs to be cancelled and workflow-owned clusters to be * deleted.The Operation.metadata will be WorkflowMetadata.On successful * completion, Operation.response will be Empty. * @alias dataproc.projects.locations.workflowTemplates.instantiate * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} * @param {().InstantiateWorkflowTemplateRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ instantiate(params?: Params$Resource$Projects$Locations$Workflowtemplates$Instantiate, options?: MethodOptions): GaxiosPromise; instantiate(params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiate, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; instantiate(params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiate, callback: BodyResponseCallback): void; instantiate(callback: BodyResponseCallback): void; /** * dataproc.projects.locations.workflowTemplates.instantiateInline * @desc Instantiates a template and begins execution.This method is * equivalent to executing the sequence CreateWorkflowTemplate, * InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned * Operation can be used to track execution of workflow by polling * operations.get. The Operation will complete when entire workflow is * finished.The running workflow can be aborted via operations.cancel. This * will cause any inflight jobs to be cancelled and workflow-owned clusters * to be deleted.The Operation.metadata will be WorkflowMetadata.On * successful completion, Operation.response will be Empty. * @alias dataproc.projects.locations.workflowTemplates.instantiateInline * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.instanceId Deprecated. Please use request_id field instead. * @param {string} params.parent Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} * @param {string=} params.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 {().WorkflowTemplate} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ instantiateInline(params?: Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline, options?: MethodOptions): GaxiosPromise; instantiateInline(params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; instantiateInline(params: Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline, callback: BodyResponseCallback): void; instantiateInline(callback: BodyResponseCallback): void; /** * dataproc.projects.locations.workflowTemplates.list * @desc Lists workflows that match the specified filter in the request. * @alias dataproc.projects.locations.workflowTemplates.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The maximum number of results to return in each response. * @param {string=} params.pageToken Optional. The page token, returned by a previous call, to request the next page of results. * @param {string} params.parent Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Locations$Workflowtemplates$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Locations$Workflowtemplates$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Locations$Workflowtemplates$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * dataproc.projects.locations.workflowTemplates.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces * any existing policy. * @alias dataproc.projects.locations.workflowTemplates.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. * @param {().SetIamPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ setIamPolicy(params?: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, options?: MethodOptions): GaxiosPromise; setIamPolicy(params: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; setIamPolicy(params: Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy, callback: BodyResponseCallback): void; setIamPolicy(callback: BodyResponseCallback): void; /** * dataproc.projects.locations.workflowTemplates.testIamPermissions * @desc 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. * @alias dataproc.projects.locations.workflowTemplates.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. * @param {().TestIamPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ testIamPermissions(params?: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, options?: MethodOptions): GaxiosPromise; testIamPermissions(params: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; testIamPermissions(params: Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions, callback: BodyResponseCallback): void; testIamPermissions(callback: BodyResponseCallback): void; /** * dataproc.projects.locations.workflowTemplates.update * @desc Updates (replaces) workflow template. The updated template must * contain version that matches the current server version. * @alias dataproc.projects.locations.workflowTemplates.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} * @param {().WorkflowTemplate} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: Params$Resource$Projects$Locations$Workflowtemplates$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Projects$Locations$Workflowtemplates$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Projects$Locations$Workflowtemplates$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Locations$Workflowtemplates$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The "resource name" of the region, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region} */ parent?: string; /** * Request body metadata */ requestBody?: Schema$WorkflowTemplate; } interface Params$Resource$Projects$Locations$Workflowtemplates$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The "resource name" of the workflow template, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** * Optional. The version of workflow template to delete. If specified, will * only delete the template if the current server version matches specified * version. */ version?: number; } interface Params$Resource$Projects$Locations$Workflowtemplates$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The "resource name" of the workflow template, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** * Optional. The version of workflow template to retrieve. Only previously * instatiated versions can be retrieved.If unspecified, retrieves the * current version. */ version?: number; } interface Params$Resource$Projects$Locations$Workflowtemplates$Getiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy is being requested. See the * operation documentation for the appropriate value for this field. */ resource?: string; } interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiate extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The "resource name" of the workflow template, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** * Request body metadata */ requestBody?: Schema$InstantiateWorkflowTemplateRequest; } interface Params$Resource$Projects$Locations$Workflowtemplates$Instantiateinline extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Deprecated. Please use request_id field instead. */ instanceId?: string; /** * Required. The "resource name" of the workflow template region, as * described in https://cloud.google.com/apis/design/resource_names of the * form projects/{project_id}/regions/{region} */ parent?: string; /** * 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. */ requestId?: string; /** * Request body metadata */ requestBody?: Schema$WorkflowTemplate; } interface Params$Resource$Projects$Locations$Workflowtemplates$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Optional. The maximum number of results to return in each response. */ pageSize?: number; /** * Optional. The page token, returned by a previous call, to request the * next page of results. */ pageToken?: string; /** * Required. The "resource name" of the region, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region} */ parent?: string; } interface Params$Resource$Projects$Locations$Workflowtemplates$Setiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy is being specified. See the * operation documentation for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$SetIamPolicyRequest; } interface Params$Resource$Projects$Locations$Workflowtemplates$Testiampermissions extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$TestIamPermissionsRequest; } interface Params$Resource$Projects$Locations$Workflowtemplates$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Output only. The "resource name" of the template, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** * Request body metadata */ requestBody?: Schema$WorkflowTemplate; } class Resource$Projects$Regions { clusters: Resource$Projects$Regions$Clusters; jobs: Resource$Projects$Regions$Jobs; operations: Resource$Projects$Regions$Operations; workflowTemplates: Resource$Projects$Regions$Workflowtemplates; constructor(); } class Resource$Projects$Regions$Clusters { constructor(); /** * dataproc.projects.regions.clusters.create * @desc Creates a cluster in a project. * @alias dataproc.projects.regions.clusters.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {string=} params.requestId Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first 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 {().Cluster} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Projects$Regions$Clusters$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Projects$Regions$Clusters$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Projects$Regions$Clusters$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.clusters.delete * @desc Deletes a cluster in a project. * @alias dataproc.projects.regions.clusters.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.clusterName Required. The cluster name. * @param {string=} params.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} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {string=} params.requestId Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first 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] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Projects$Regions$Clusters$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Projects$Regions$Clusters$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Regions$Clusters$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.clusters.diagnose * @desc Gets cluster diagnostic information. After the operation completes, * the Operation.response field contains DiagnoseClusterOutputLocation. * @alias dataproc.projects.regions.clusters.diagnose * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.clusterName Required. The cluster name. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {().DiagnoseClusterRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ diagnose(params?: Params$Resource$Projects$Regions$Clusters$Diagnose, options?: MethodOptions): GaxiosPromise; diagnose(params: Params$Resource$Projects$Regions$Clusters$Diagnose, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; diagnose(params: Params$Resource$Projects$Regions$Clusters$Diagnose, callback: BodyResponseCallback): void; diagnose(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.clusters.get * @desc Gets the resource representation for a cluster in a project. * @alias dataproc.projects.regions.clusters.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.clusterName Required. The cluster name. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Regions$Clusters$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Projects$Regions$Clusters$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Regions$Clusters$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.clusters.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty * policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.clusters.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ getIamPolicy(params?: Params$Resource$Projects$Regions$Clusters$Getiampolicy, options?: MethodOptions): GaxiosPromise; getIamPolicy(params: Params$Resource$Projects$Regions$Clusters$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getIamPolicy(params: Params$Resource$Projects$Regions$Clusters$Getiampolicy, callback: BodyResponseCallback): void; getIamPolicy(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.clusters.list * @desc Lists all regions/{region}/clusters in a project. * @alias dataproc.projects.regions.clusters.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.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, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR 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 {integer=} params.pageSize Optional. The standard List page size. * @param {string=} params.pageToken Optional. The standard List page token. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the cluster belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Regions$Clusters$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Regions$Clusters$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Regions$Clusters$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.clusters.patch * @desc Updates a cluster in a project. * @alias dataproc.projects.regions.clusters.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.clusterName Required. The cluster name. * @param {string=} params.gracefulDecommissionTimeout Optional. Timeout for graceful YARN decomissioning. 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.Only supported on Dataproc image versions 1.2 and higher. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project the cluster belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {string=} params.requestId Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first 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 {string=} params.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
labelsUpdates labels
config.worker_config.num_instancesResize primary worker group
config.secondary_worker_config.num_instancesResize secondary worker group
config.lifecycle_config.auto_delete_ttlReset MAX TTL duration
config.lifecycle_config.auto_delete_timeUpdate MAX TTL deletion timestamp
config.lifecycle_config.idle_delete_ttlUpdate Idle TTL duration
* @param {().Cluster} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: Params$Resource$Projects$Regions$Clusters$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Projects$Regions$Clusters$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Projects$Regions$Clusters$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.clusters.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces * any existing policy. * @alias dataproc.projects.regions.clusters.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. * @param {().SetIamPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ setIamPolicy(params?: Params$Resource$Projects$Regions$Clusters$Setiampolicy, options?: MethodOptions): GaxiosPromise; setIamPolicy(params: Params$Resource$Projects$Regions$Clusters$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; setIamPolicy(params: Params$Resource$Projects$Regions$Clusters$Setiampolicy, callback: BodyResponseCallback): void; setIamPolicy(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.clusters.testIamPermissions * @desc 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. * @alias dataproc.projects.regions.clusters.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. * @param {().TestIamPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ testIamPermissions(params?: Params$Resource$Projects$Regions$Clusters$Testiampermissions, options?: MethodOptions): GaxiosPromise; testIamPermissions(params: Params$Resource$Projects$Regions$Clusters$Testiampermissions, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; testIamPermissions(params: Params$Resource$Projects$Regions$Clusters$Testiampermissions, callback: BodyResponseCallback): void; testIamPermissions(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Regions$Clusters$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; /** * Optional. A unique id used to identify the request. If the server * receives two CreateClusterRequest requests with the same id, then the * second request will be ignored and the first 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. */ requestId?: string; /** * Request body metadata */ requestBody?: Schema$Cluster; } interface Params$Resource$Projects$Regions$Clusters$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The cluster name. */ clusterName?: string; /** * Optional. Specifying the cluster_uuid means the RPC should fail (with * error NOT_FOUND) if cluster with specified UUID does not exist. */ clusterUuid?: string; /** * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; /** * Optional. A unique id used to identify the request. If the server * receives two DeleteClusterRequest requests with the same id, then the * second request will be ignored and the first 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. */ requestId?: string; } interface Params$Resource$Projects$Regions$Clusters$Diagnose extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The cluster name. */ clusterName?: string; /** * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; /** * Request body metadata */ requestBody?: Schema$DiagnoseClusterRequest; } interface Params$Resource$Projects$Regions$Clusters$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The cluster name. */ clusterName?: string; /** * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; } interface Params$Resource$Projects$Regions$Clusters$Getiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy is being requested. See the * operation documentation for the appropriate value for this field. */ resource?: string; } interface Params$Resource$Projects$Regions$Clusters$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * 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, or UPDATING. ACTIVE contains the * CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING * and ERROR 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 = * */ filter?: string; /** * Optional. The standard List page size. */ pageSize?: number; /** * Optional. The standard List page token. */ pageToken?: string; /** * Required. The ID of the Google Cloud Platform project that the cluster * belongs to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; } interface Params$Resource$Projects$Regions$Clusters$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The cluster name. */ clusterName?: string; /** * Optional. Timeout for graceful YARN decomissioning. 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.Only supported on * Dataproc image versions 1.2 and higher. */ gracefulDecommissionTimeout?: string; /** * Required. The ID of the Google Cloud Platform project the cluster belongs * to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; /** * Optional. A unique id used to identify the request. If the server * receives two UpdateClusterRequest requests with the same id, then the * second request will be ignored and the first 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. */ requestId?: string; /** * 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
labelsUpdates labels
config.worker_config.num_instancesResize primary worker * group
config.secondary_worker_config.num_instancesResize secondary * worker group
config.lifecycle_config.auto_delete_ttlReset MAX TTL * duration
config.lifecycle_config.auto_delete_timeUpdate MAX TTL * deletion timestamp
config.lifecycle_config.idle_delete_ttlUpdate Idle TTL * duration
*/ updateMask?: string; /** * Request body metadata */ requestBody?: Schema$Cluster; } interface Params$Resource$Projects$Regions$Clusters$Setiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy is being specified. See the * operation documentation for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$SetIamPolicyRequest; } interface Params$Resource$Projects$Regions$Clusters$Testiampermissions extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$TestIamPermissionsRequest; } class Resource$Projects$Regions$Jobs { constructor(); /** * dataproc.projects.regions.jobs.cancel * @desc Starts a job cancellation request. To access the job resource after * cancellation, call regions/{region}/jobs.list or * regions/{region}/jobs.get. * @alias dataproc.projects.regions.jobs.cancel * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {().CancelJobRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ cancel(params?: Params$Resource$Projects$Regions$Jobs$Cancel, options?: MethodOptions): GaxiosPromise; cancel(params: Params$Resource$Projects$Regions$Jobs$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; cancel(params: Params$Resource$Projects$Regions$Jobs$Cancel, callback: BodyResponseCallback): void; cancel(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.jobs.delete * @desc Deletes the job from the project. If the job is active, the delete * fails, and the response returns FAILED_PRECONDITION. * @alias dataproc.projects.regions.jobs.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Projects$Regions$Jobs$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Projects$Regions$Jobs$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Regions$Jobs$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.jobs.get * @desc Gets the resource representation for a job in a project. * @alias dataproc.projects.regions.jobs.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Regions$Jobs$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Projects$Regions$Jobs$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Regions$Jobs$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.jobs.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty * policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.jobs.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ getIamPolicy(params?: Params$Resource$Projects$Regions$Jobs$Getiampolicy, options?: MethodOptions): GaxiosPromise; getIamPolicy(params: Params$Resource$Projects$Regions$Jobs$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getIamPolicy(params: Params$Resource$Projects$Regions$Jobs$Getiampolicy, callback: BodyResponseCallback): void; getIamPolicy(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.jobs.list * @desc Lists regions/{region}/jobs in a project. * @alias dataproc.projects.regions.jobs.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.clusterName Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster. * @param {string=} params.filter Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = * * @param {string=} params.jobStateMatcher Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored. * @param {integer=} params.pageSize Optional. The number of results to return in each response. * @param {string=} params.pageToken Optional. The page token, returned by a previous call, to request the next page of results. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Regions$Jobs$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Regions$Jobs$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Regions$Jobs$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.jobs.patch * @desc Updates a job in a project. * @alias dataproc.projects.regions.jobs.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.jobId Required. The job ID. * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {string=} params.updateMask Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. Note: Currently, labels is the only field that can be updated. * @param {().Job} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: Params$Resource$Projects$Regions$Jobs$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Projects$Regions$Jobs$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Projects$Regions$Jobs$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.jobs.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces * any existing policy. * @alias dataproc.projects.regions.jobs.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. * @param {().SetIamPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ setIamPolicy(params?: Params$Resource$Projects$Regions$Jobs$Setiampolicy, options?: MethodOptions): GaxiosPromise; setIamPolicy(params: Params$Resource$Projects$Regions$Jobs$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; setIamPolicy(params: Params$Resource$Projects$Regions$Jobs$Setiampolicy, callback: BodyResponseCallback): void; setIamPolicy(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.jobs.submit * @desc Submits a job to a cluster. * @alias dataproc.projects.regions.jobs.submit * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.projectId Required. The ID of the Google Cloud Platform project that the job belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {().SubmitJobRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ submit(params?: Params$Resource$Projects$Regions$Jobs$Submit, options?: MethodOptions): GaxiosPromise; submit(params: Params$Resource$Projects$Regions$Jobs$Submit, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; submit(params: Params$Resource$Projects$Regions$Jobs$Submit, callback: BodyResponseCallback): void; submit(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.jobs.testIamPermissions * @desc 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. * @alias dataproc.projects.regions.jobs.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. * @param {().TestIamPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ testIamPermissions(params?: Params$Resource$Projects$Regions$Jobs$Testiampermissions, options?: MethodOptions): GaxiosPromise; testIamPermissions(params: Params$Resource$Projects$Regions$Jobs$Testiampermissions, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; testIamPermissions(params: Params$Resource$Projects$Regions$Jobs$Testiampermissions, callback: BodyResponseCallback): void; testIamPermissions(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Regions$Jobs$Cancel extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The job ID. */ jobId?: string; /** * Required. The ID of the Google Cloud Platform project that the job * belongs to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; /** * Request body metadata */ requestBody?: Schema$CancelJobRequest; } interface Params$Resource$Projects$Regions$Jobs$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The job ID. */ jobId?: string; /** * Required. The ID of the Google Cloud Platform project that the job * belongs to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; } interface Params$Resource$Projects$Regions$Jobs$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The job ID. */ jobId?: string; /** * Required. The ID of the Google Cloud Platform project that the job * belongs to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; } interface Params$Resource$Projects$Regions$Jobs$Getiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy is being requested. See the * operation documentation for the appropriate value for this field. */ resource?: string; } interface Params$Resource$Projects$Regions$Jobs$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Optional. If set, the returned jobs list includes only jobs that were * submitted to the named cluster. */ clusterName?: string; /** * Optional. A filter constraining the jobs to list. Filters are * case-sensitive and have the following syntax:field = value AND field = * value ...where field is status.state or labels.[KEY], and [KEY] is a * label key. value can be * to match all values. status.state can be either * ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; * space-separated items are treated as having an implicit AND * operator.Example filter:status.state = ACTIVE AND labels.env = staging * AND labels.starred = * */ filter?: string; /** * Optional. Specifies enumerated categories of jobs to list. (default = * match ALL jobs).If filter is provided, jobStateMatcher will be ignored. */ jobStateMatcher?: string; /** * Optional. The number of results to return in each response. */ pageSize?: number; /** * Optional. The page token, returned by a previous call, to request the * next page of results. */ pageToken?: string; /** * Required. The ID of the Google Cloud Platform project that the job * belongs to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; } interface Params$Resource$Projects$Regions$Jobs$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The job ID. */ jobId?: string; /** * Required. The ID of the Google Cloud Platform project that the job * belongs to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; /** * Required. Specifies the path, relative to Job, of the field * to update. For example, to update the labels of a Job the * update_mask parameter would be specified as * labels, and the PATCH request body would specify the new * value. Note: Currently, labels is the only * field that can be updated. */ updateMask?: string; /** * Request body metadata */ requestBody?: Schema$Job; } interface Params$Resource$Projects$Regions$Jobs$Setiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy is being specified. See the * operation documentation for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$SetIamPolicyRequest; } interface Params$Resource$Projects$Regions$Jobs$Submit extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The ID of the Google Cloud Platform project that the job * belongs to. */ projectId?: string; /** * Required. The Cloud Dataproc region in which to handle the request. */ region?: string; /** * Request body metadata */ requestBody?: Schema$SubmitJobRequest; } interface Params$Resource$Projects$Regions$Jobs$Testiampermissions extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$TestIamPermissionsRequest; } class Resource$Projects$Regions$Operations { constructor(); /** * dataproc.projects.regions.operations.cancel * @desc 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 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 * Operation.error value with a google.rpc.Status.code of 1, corresponding * to Code.CANCELLED. * @alias dataproc.projects.regions.operations.cancel * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The name of the operation resource to be cancelled. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ cancel(params?: Params$Resource$Projects$Regions$Operations$Cancel, options?: MethodOptions): GaxiosPromise; cancel(params: Params$Resource$Projects$Regions$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; cancel(params: Params$Resource$Projects$Regions$Operations$Cancel, callback: BodyResponseCallback): void; cancel(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.operations.delete * @desc 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. * @alias dataproc.projects.regions.operations.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The name of the operation resource to be deleted. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Projects$Regions$Operations$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Projects$Regions$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Regions$Operations$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.operations.get * @desc 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. * @alias dataproc.projects.regions.operations.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The name of the operation resource. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Regions$Operations$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Projects$Regions$Operations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Regions$Operations$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.operations.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty * policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.operations.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ getIamPolicy(params?: Params$Resource$Projects$Regions$Operations$Getiampolicy, options?: MethodOptions): GaxiosPromise; getIamPolicy(params: Params$Resource$Projects$Regions$Operations$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getIamPolicy(params: Params$Resource$Projects$Regions$Operations$Getiampolicy, callback: BodyResponseCallback): void; getIamPolicy(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.operations.list * @desc Lists operations that match the specified filter in the request. If * the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: * the name binding allows API services to override the binding to use * different resource name schemes, such as users/x/operations. To override * the binding, API services can add a binding such as * "/v1/{name=users/x}/operations" to their service configuration. For * backwards compatibility, the default name includes the operations * collection id, however overriding users must ensure the name binding is * the parent resource, without the operations collection id. * @alias dataproc.projects.regions.operations.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.filter The standard list filter. * @param {string} params.name The name of the operation's parent resource. * @param {integer=} params.pageSize The standard list page size. * @param {string=} params.pageToken The standard list page token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Regions$Operations$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Regions$Operations$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Regions$Operations$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.operations.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces * any existing policy. * @alias dataproc.projects.regions.operations.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. * @param {().SetIamPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ setIamPolicy(params?: Params$Resource$Projects$Regions$Operations$Setiampolicy, options?: MethodOptions): GaxiosPromise; setIamPolicy(params: Params$Resource$Projects$Regions$Operations$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; setIamPolicy(params: Params$Resource$Projects$Regions$Operations$Setiampolicy, callback: BodyResponseCallback): void; setIamPolicy(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.operations.testIamPermissions * @desc 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. * @alias dataproc.projects.regions.operations.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. * @param {().TestIamPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ testIamPermissions(params?: Params$Resource$Projects$Regions$Operations$Testiampermissions, options?: MethodOptions): GaxiosPromise; testIamPermissions(params: Params$Resource$Projects$Regions$Operations$Testiampermissions, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; testIamPermissions(params: Params$Resource$Projects$Regions$Operations$Testiampermissions, callback: BodyResponseCallback): void; testIamPermissions(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Regions$Operations$Cancel extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The name of the operation resource to be cancelled. */ name?: string; } interface Params$Resource$Projects$Regions$Operations$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The name of the operation resource to be deleted. */ name?: string; } interface Params$Resource$Projects$Regions$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The name of the operation resource. */ name?: string; } interface Params$Resource$Projects$Regions$Operations$Getiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy is being requested. See the * operation documentation for the appropriate value for this field. */ resource?: string; } interface Params$Resource$Projects$Regions$Operations$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The standard list filter. */ filter?: string; /** * The name of the operation's parent resource. */ name?: string; /** * The standard list page size. */ pageSize?: number; /** * The standard list page token. */ pageToken?: string; } interface Params$Resource$Projects$Regions$Operations$Setiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy is being specified. See the * operation documentation for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$SetIamPolicyRequest; } interface Params$Resource$Projects$Regions$Operations$Testiampermissions extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$TestIamPermissionsRequest; } class Resource$Projects$Regions$Workflowtemplates { constructor(); /** * dataproc.projects.regions.workflowTemplates.create * @desc Creates new workflow template. * @alias dataproc.projects.regions.workflowTemplates.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} * @param {().WorkflowTemplate} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Projects$Regions$Workflowtemplates$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Projects$Regions$Workflowtemplates$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Projects$Regions$Workflowtemplates$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.workflowTemplates.delete * @desc Deletes a workflow template. It does not cancel in-progress * workflows. * @alias dataproc.projects.regions.workflowTemplates.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} * @param {integer=} params.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] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Projects$Regions$Workflowtemplates$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Projects$Regions$Workflowtemplates$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Regions$Workflowtemplates$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.workflowTemplates.get * @desc Retrieves the latest workflow template.Can retrieve previously * instantiated template by specifying optional version parameter. * @alias dataproc.projects.regions.workflowTemplates.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} * @param {integer=} params.version Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Regions$Workflowtemplates$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Projects$Regions$Workflowtemplates$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Regions$Workflowtemplates$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.workflowTemplates.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty * policy if the resource exists and does not have a policy set. * @alias dataproc.projects.regions.workflowTemplates.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ getIamPolicy(params?: Params$Resource$Projects$Regions$Workflowtemplates$Getiampolicy, options?: MethodOptions): GaxiosPromise; getIamPolicy(params: Params$Resource$Projects$Regions$Workflowtemplates$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getIamPolicy(params: Params$Resource$Projects$Regions$Workflowtemplates$Getiampolicy, callback: BodyResponseCallback): void; getIamPolicy(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.workflowTemplates.instantiate * @desc Instantiates a template and begins execution.The returned Operation * can be used to track execution of workflow by polling operations.get. The * Operation will complete when entire workflow is finished.The running * workflow can be aborted via operations.cancel. This will cause any * inflight jobs to be cancelled and workflow-owned clusters to be * deleted.The Operation.metadata will be WorkflowMetadata.On successful * completion, Operation.response will be Empty. * @alias dataproc.projects.regions.workflowTemplates.instantiate * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} * @param {().InstantiateWorkflowTemplateRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ instantiate(params?: Params$Resource$Projects$Regions$Workflowtemplates$Instantiate, options?: MethodOptions): GaxiosPromise; instantiate(params: Params$Resource$Projects$Regions$Workflowtemplates$Instantiate, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; instantiate(params: Params$Resource$Projects$Regions$Workflowtemplates$Instantiate, callback: BodyResponseCallback): void; instantiate(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.workflowTemplates.instantiateInline * @desc Instantiates a template and begins execution.This method is * equivalent to executing the sequence CreateWorkflowTemplate, * InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned * Operation can be used to track execution of workflow by polling * operations.get. The Operation will complete when entire workflow is * finished.The running workflow can be aborted via operations.cancel. This * will cause any inflight jobs to be cancelled and workflow-owned clusters * to be deleted.The Operation.metadata will be WorkflowMetadata.On * successful completion, Operation.response will be Empty. * @alias dataproc.projects.regions.workflowTemplates.instantiateInline * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.instanceId Deprecated. Please use request_id field instead. * @param {string} params.parent Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} * @param {string=} params.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 {().WorkflowTemplate} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ instantiateInline(params?: Params$Resource$Projects$Regions$Workflowtemplates$Instantiateinline, options?: MethodOptions): GaxiosPromise; instantiateInline(params: Params$Resource$Projects$Regions$Workflowtemplates$Instantiateinline, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; instantiateInline(params: Params$Resource$Projects$Regions$Workflowtemplates$Instantiateinline, callback: BodyResponseCallback): void; instantiateInline(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.workflowTemplates.list * @desc Lists workflows that match the specified filter in the request. * @alias dataproc.projects.regions.workflowTemplates.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The maximum number of results to return in each response. * @param {string=} params.pageToken Optional. The page token, returned by a previous call, to request the next page of results. * @param {string} params.parent Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Regions$Workflowtemplates$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Regions$Workflowtemplates$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Regions$Workflowtemplates$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.workflowTemplates.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces * any existing policy. * @alias dataproc.projects.regions.workflowTemplates.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. * @param {().SetIamPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ setIamPolicy(params?: Params$Resource$Projects$Regions$Workflowtemplates$Setiampolicy, options?: MethodOptions): GaxiosPromise; setIamPolicy(params: Params$Resource$Projects$Regions$Workflowtemplates$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; setIamPolicy(params: Params$Resource$Projects$Regions$Workflowtemplates$Setiampolicy, callback: BodyResponseCallback): void; setIamPolicy(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.workflowTemplates.testIamPermissions * @desc 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. * @alias dataproc.projects.regions.workflowTemplates.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. * @param {().TestIamPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ testIamPermissions(params?: Params$Resource$Projects$Regions$Workflowtemplates$Testiampermissions, options?: MethodOptions): GaxiosPromise; testIamPermissions(params: Params$Resource$Projects$Regions$Workflowtemplates$Testiampermissions, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; testIamPermissions(params: Params$Resource$Projects$Regions$Workflowtemplates$Testiampermissions, callback: BodyResponseCallback): void; testIamPermissions(callback: BodyResponseCallback): void; /** * dataproc.projects.regions.workflowTemplates.update * @desc Updates (replaces) workflow template. The updated template must * contain version that matches the current server version. * @alias dataproc.projects.regions.workflowTemplates.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} * @param {().WorkflowTemplate} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: Params$Resource$Projects$Regions$Workflowtemplates$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Projects$Regions$Workflowtemplates$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Projects$Regions$Workflowtemplates$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Regions$Workflowtemplates$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The "resource name" of the region, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region} */ parent?: string; /** * Request body metadata */ requestBody?: Schema$WorkflowTemplate; } interface Params$Resource$Projects$Regions$Workflowtemplates$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The "resource name" of the workflow template, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** * Optional. The version of workflow template to delete. If specified, will * only delete the template if the current server version matches specified * version. */ version?: number; } interface Params$Resource$Projects$Regions$Workflowtemplates$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The "resource name" of the workflow template, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** * Optional. The version of workflow template to retrieve. Only previously * instatiated versions can be retrieved.If unspecified, retrieves the * current version. */ version?: number; } interface Params$Resource$Projects$Regions$Workflowtemplates$Getiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy is being requested. See the * operation documentation for the appropriate value for this field. */ resource?: string; } interface Params$Resource$Projects$Regions$Workflowtemplates$Instantiate extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The "resource name" of the workflow template, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** * Request body metadata */ requestBody?: Schema$InstantiateWorkflowTemplateRequest; } interface Params$Resource$Projects$Regions$Workflowtemplates$Instantiateinline extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Deprecated. Please use request_id field instead. */ instanceId?: string; /** * Required. The "resource name" of the workflow template region, as * described in https://cloud.google.com/apis/design/resource_names of the * form projects/{project_id}/regions/{region} */ parent?: string; /** * 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. */ requestId?: string; /** * Request body metadata */ requestBody?: Schema$WorkflowTemplate; } interface Params$Resource$Projects$Regions$Workflowtemplates$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Optional. The maximum number of results to return in each response. */ pageSize?: number; /** * Optional. The page token, returned by a previous call, to request the * next page of results. */ pageToken?: string; /** * Required. The "resource name" of the region, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region} */ parent?: string; } interface Params$Resource$Projects$Regions$Workflowtemplates$Setiampolicy extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy is being specified. See the * operation documentation for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$SetIamPolicyRequest; } interface Params$Resource$Projects$Regions$Workflowtemplates$Testiampermissions extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. */ resource?: string; /** * Request body metadata */ requestBody?: Schema$TestIamPermissionsRequest; } interface Params$Resource$Projects$Regions$Workflowtemplates$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Output only. The "resource name" of the template, as described in * https://cloud.google.com/apis/design/resource_names of the form * projects/{project_id}/regions/{region}/workflowTemplates/{template_id} */ name?: string; /** * Request body metadata */ requestBody?: Schema$WorkflowTemplate; } }