googleapis
Version:
Google APIs Client Library for Node.js
1,307 lines • 100 kB
TypeScript
/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* 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 { AxiosPromise } from 'axios';
import { GoogleApis } from '../..';
import { BodyResponseCallback, GlobalOptions, MethodOptions } from '../../lib/api';
/**
* Google Cloud Dataproc API
*
* Manages Hadoop-based clusters and jobs on Google Cloud Platform.
*
* @example
* const google = require('googleapis');
* const dataproc = google.dataproc('v1');
*
* @namespace dataproc
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Dataproc
*/
export declare class Dataproc {
_options: GlobalOptions;
google: GoogleApis;
root: this;
projects: Resource$Projects;
constructor(options: GlobalOptions, google: GoogleApis);
getRoot(): this;
}
/**
* Specifies the type and number of accelerator cards attached to the instances
* of an instance. See GPUs on Compute Engine.
*/
export 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.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;
}
/**
* A request to cancel a job.
*/
export interface Schema$CancelJobRequest {
}
/**
* Describes the identifying information, config, and status of a cluster of
* Compute Engine instances.
*/
export 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: any;
/**
* 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.
*/
export 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;
/**
* 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 role 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/v1/instance/attributes/dataproc-role) if [[
* "${ROLE}" == 'Master' ]]; then ... master specific
* actions ... else ... worker specific actions ... fi
*/
initializationActions: Schema$NodeInitializationAction[];
/**
* 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.
*/
export interface Schema$ClusterMetrics {
/**
* The HDFS metrics.
*/
hdfsMetrics: any;
/**
* The YARN metrics.
*/
yarnMetrics: any;
}
/**
* Metadata describing the operation.
*/
export 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: any;
/**
* 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.
*/
export 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;
}
/**
* The status of a cluster and its instances.
*/
export 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.
*/
export interface Schema$DiagnoseClusterRequest {
}
/**
* The location of diagnostic output.
*/
export 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.
*/
export interface Schema$DiskConfig {
/**
* Optional. Size in GB of the boot disk (default is 500GB).
*/
bootDiskSizeGb: number;
/**
* 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 {}.
*/
export interface Schema$Empty {
}
/**
* Common config settings for resources of Compute Engine cluster instances,
* applicable to all instances in the cluster.
*/
export interface Schema$GceClusterConfig {
/**
* 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: any;
/**
* 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;
}
/**
* 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).
*/
export 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: any;
}
/**
* A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/)
* queries on YARN.
*/
export 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: any;
/**
* 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: any;
}
/**
* Optional. The config settings for Compute Engine resources in an instance
* group, such as a master or worker group.
*/
export 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;
/**
* Output only. The Compute Engine image resource used for cluster instances.
* Inferred from SoftwareConfig.image_version.
*/
imageUri: string;
/**
* Optional. The list of instance names. Cloud Dataproc derives the names from
* cluster_name, num_instances, and the instance group if not set by user
* (recommended practice is to let Cloud Dataproc derive the name).
*/
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. The number of VM instances in the instance group. For master
* instance groups, must be set to 1.
*/
numInstances: number;
}
/**
* A Cloud Dataproc job resource.
*/
export 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;
/**
* 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: any;
/**
* 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 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 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.
*/
export 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.
*/
export 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.
*/
export 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.
*/
export 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;
}
/**
* The list of all clusters in a project.
*/
export 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 ListClustersRequest.
*/
nextPageToken: string;
}
/**
* A list of jobs in a project.
*/
export 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.
*/
export 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[];
}
/**
* The runtime logging config of the job.
*/
export 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: any;
}
/**
* Specifies the resources used to actively manage an instance group.
*/
export 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.
*/
export 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.
*/
export 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: 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: any;
}
/**
* A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries
* on YARN.
*/
export 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: any;
/**
* 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: any;
}
/**
* A Cloud Dataproc job for running Apache PySpark
* (https://spark.apache.org/docs/0.9.0/python-programming-guide.html)
* applications on YARN.
*/
export 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: any;
/**
* 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.
*/
export 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[];
}
/**
* Specifies the selection and config of software inside the cluster.
*/
export interface Schema$SoftwareConfig {
/**
* Optional. The version of software inside the cluster. It must match the
* regular expression [0-9]+\.[0-9]+. If unspecified, it defaults to the
* latest version (see Cloud Dataproc Versioning).
*/
imageVersion: 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: any;
}
/**
* A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/)
* applications on YARN.
*/
export 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: any;
}
/**
* A Cloud Dataproc job for running Apache Spark SQL
* (http://spark.apache.org/sql/) queries.
*/
export 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: any;
/**
* 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: any;
}
/**
* 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.
*/
export 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: 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.
*/
export 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 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.
*/
export 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;
}
export declare class Resource$Projects {
root: Dataproc;
regions: Resource$Projects$Regions;
constructor(root: Dataproc);
getRoot(): Dataproc;
}
export declare class Resource$Projects$Regions {
root: Dataproc;
clusters: Resource$Projects$Regions$Clusters;
jobs: Resource$Projects$Regions$Jobs;
operations: Resource$Projects$Regions$Operations;
constructor(root: Dataproc);
getRoot(): Dataproc;
}
export declare class Resource$Projects$Regions$Clusters {
root: Dataproc;
constructor(root: Dataproc);
getRoot(): Dataproc;
/**
* dataproc.projects.regions.clusters.create
* @desc Creates a cluster in a project.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Dataproc API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/dataproc
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var dataproc = google.dataproc('v1');
*
* authorize(function(authClient) {
* var request = {
* // Required. The ID of the Google Cloud Platform project that the
* cluster belongs to. projectId: 'my-project-id', // TODO: Update
* placeholder value.
*
* // Required. The Cloud Dataproc region in which to handle the request.
* region: 'my-region', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* dataproc.projects.regions.clusters.create(request, function(err,
* response) { if (err) { console.error(err); return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @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?: any, options?: MethodOptions): AxiosPromise<Schema$Operation>;
create(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Operation>, callback?: BodyResponseCallback<Schema$Operation>): void;
/**
* dataproc.projects.regions.clusters.delete
* @desc Deletes a cluster in a project.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Dataproc API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/dataproc
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var dataproc = google.dataproc('v1');
*
* authorize(function(authClient) {
* var request = {
* // Required. The ID of the Google Cloud Platform project that the
* cluster belongs to. projectId: 'my-project-id', // TODO: Update
* placeholder value.
*
* // Required. The Cloud Dataproc region in which to handle the request.
* region: 'my-region', // TODO: Update placeholder value.
*
* // Required. The cluster name.
* clusterName: 'my-cluster-name', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* dataproc.projects.regions.clusters.delete(request, function(err,
* response) { if (err) { console.error(err); return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @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?: any, options?: MethodOptions): AxiosPromise<Schema$Operation>;
delete(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Operation>, callback?: BodyResponseCallback<Schema$Operation>): void;
/**
* dataproc.projects.regions.clusters.diagnose
* @desc Gets cluster diagnostic information. After the operation completes,
* the Operation.response field contains DiagnoseClusterOutputLocation.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Dataproc API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/dataproc
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var dataproc = google.dataproc('v1');
*
* authorize(function(authClient) {
* var request = {
* // Required. The ID of the Google Cloud Platform project that the
* cluster belongs to. projectId: 'my-project-id', // TODO: Update
* placeholder value.
*
* // Required. The Cloud Dataproc region in which to handle the request.
* region: 'my-region', // TODO: Update placeholder value.
*
* // Required. The cluster name.
* clusterName: 'my-cluster-name', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* dataproc.projects.regions.clusters.diagnose(request, function(err,
* response) { if (err) { console.error(err); return;
*