1268 lines
70 KiB
TypeScript
1268 lines
70 KiB
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.
|
|
*/
|
|
|
|
/* jshint maxlen: false */
|
|
|
|
import createAPIRequest from '../../lib/apirequest';
|
|
|
|
/**
|
|
* Google 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
|
|
*/
|
|
function Dataproc(options) { // eslint-disable-line
|
|
const self = this;
|
|
self._options = options || {};
|
|
|
|
self.projects = {
|
|
regions: {
|
|
clusters: {
|
|
|
|
/**
|
|
* dataproc.projects.regions.clusters.create
|
|
*
|
|
* @desc Creates a cluster in a project.
|
|
*
|
|
* @alias dataproc.projects.regions.clusters.create
|
|
* @memberOf! dataproc(v1beta2)
|
|
*
|
|
* @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 {dataproc(v1beta2).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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/clusters').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region'],
|
|
pathParams: ['projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* dataproc.projects.regions.clusters.delete
|
|
*
|
|
* @desc Deletes a cluster in a project.
|
|
*
|
|
* @alias dataproc.projects.regions.clusters.delete
|
|
* @memberOf! dataproc(v1beta2)
|
|
*
|
|
* @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
|
|
*/
|
|
delete: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'DELETE'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region', 'clusterName'],
|
|
pathParams: ['clusterName', 'projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* 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! dataproc(v1beta2)
|
|
*
|
|
* @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 {dataproc(v1beta2).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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region', 'clusterName'],
|
|
pathParams: ['clusterName', 'projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* dataproc.projects.regions.clusters.get
|
|
*
|
|
* @desc Gets the resource representation for a cluster in a project.
|
|
*
|
|
* @alias dataproc.projects.regions.clusters.get
|
|
* @memberOf! dataproc(v1beta2)
|
|
*
|
|
* @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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region', 'clusterName'],
|
|
pathParams: ['clusterName', 'projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* 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! dataproc(v1beta2)
|
|
*
|
|
* @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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{resource}:getIamPolicy').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['resource'],
|
|
pathParams: ['resource'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* dataproc.projects.regions.clusters.list
|
|
*
|
|
* @desc Lists all regions/{region}/clusters in a project.
|
|
*
|
|
* @alias dataproc.projects.regions.clusters.list
|
|
* @memberOf! dataproc(v1beta2)
|
|
*
|
|
* @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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/clusters').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region'],
|
|
pathParams: ['projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* dataproc.projects.regions.clusters.patch
|
|
*
|
|
* @desc Updates a cluster in a project.
|
|
*
|
|
* @alias dataproc.projects.regions.clusters.patch
|
|
* @memberOf! dataproc(v1beta2)
|
|
*
|
|
* @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.updateMask Required. Specifies the path, relative to <code>Cluster</code>, of the field to update. For example, to change the number of workers in a cluster to 5, the <code>update_mask</code> parameter would be specified as <code>config.worker_config.num_instances</code>, 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 <code>update_mask</code> parameter would be <code>config.secondary_worker_config.num_instances</code>, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } <strong>Note:</strong> currently only some fields can be updated: |Mask|Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize primary worker group| |config.secondary_worker_config.num_instances|Resize secondary worker group|
|
|
* @param {dataproc(v1beta2).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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PATCH'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region', 'clusterName'],
|
|
pathParams: ['clusterName', 'projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* 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! dataproc(v1beta2)
|
|
*
|
|
* @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 {dataproc(v1beta2).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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{resource}:setIamPolicy').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['resource'],
|
|
pathParams: ['resource'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* 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! dataproc(v1beta2)
|
|
*
|
|
* @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 {dataproc(v1beta2).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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{resource}:testIamPermissions').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['resource'],
|
|
pathParams: ['resource'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
},
|
|
jobs: {
|
|
|
|
/**
|
|
* 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! dataproc(v1beta2)
|
|
*
|
|
* @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 {dataproc(v1beta2).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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region', 'jobId'],
|
|
pathParams: ['jobId', 'projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* 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! dataproc(v1beta2)
|
|
*
|
|
* @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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'DELETE'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region', 'jobId'],
|
|
pathParams: ['jobId', 'projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* dataproc.projects.regions.jobs.get
|
|
*
|
|
* @desc Gets the resource representation for a job in a project.
|
|
*
|
|
* @alias dataproc.projects.regions.jobs.get
|
|
* @memberOf! dataproc(v1beta2)
|
|
*
|
|
* @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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region', 'jobId'],
|
|
pathParams: ['jobId', 'projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* dataproc.projects.regions.jobs.list
|
|
*
|
|
* @desc Lists regions/{region}/jobs in a project.
|
|
*
|
|
* @alias dataproc.projects.regions.jobs.list
|
|
* @memberOf! dataproc(v1beta2)
|
|
*
|
|
* @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 INACTIVE. 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).
|
|
* @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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/jobs').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region'],
|
|
pathParams: ['projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* dataproc.projects.regions.jobs.patch
|
|
*
|
|
* @desc Updates a job in a project.
|
|
*
|
|
* @alias dataproc.projects.regions.jobs.patch
|
|
* @memberOf! dataproc(v1beta2)
|
|
*
|
|
* @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 <code>Job</code>, of the field to update. For example, to update the labels of a Job the <code>update_mask</code> parameter would be specified as <code>labels</code>, and the PATCH request body would specify the new value. <strong>Note:</strong> Currently, <code>labels</code> is the only field that can be updated.
|
|
* @param {dataproc(v1beta2).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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PATCH'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region', 'jobId'],
|
|
pathParams: ['jobId', 'projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* dataproc.projects.regions.jobs.submit
|
|
*
|
|
* @desc Submits a job to a cluster.
|
|
*
|
|
* @alias dataproc.projects.regions.jobs.submit
|
|
* @memberOf! dataproc(v1beta2)
|
|
*
|
|
* @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 {dataproc(v1beta2).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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/projects/{projectId}/regions/{region}/jobs:submit').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId', 'region'],
|
|
pathParams: ['projectId', 'region'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
},
|
|
operations: {
|
|
|
|
/**
|
|
* 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! dataproc(v1beta2)
|
|
*
|
|
* @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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{name}:cancel').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* 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! dataproc(v1beta2)
|
|
*
|
|
* @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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'DELETE'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* 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! dataproc(v1beta2)
|
|
*
|
|
* @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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* 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! dataproc(v1beta2)
|
|
*
|
|
* @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: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* @typedef AcceleratorConfig
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {integer} acceleratorCount The number of the accelerator cards of this type exposed to this instance.
|
|
* @property {string} acceleratorTypeUri Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google 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-k80
|
|
*/
|
|
|
|
/**
|
|
* @typedef Binding
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string[]} members 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 or joe@example.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.
|
|
* @property {string} role Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. Required
|
|
*/
|
|
|
|
/**
|
|
* @typedef CancelJobRequest
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
*/
|
|
|
|
/**
|
|
* @typedef Cluster
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} clusterName Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
|
|
* @property {string} clusterUuid Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
|
|
* @property {dataproc(v1beta2).ClusterConfig} config Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
|
|
* @property {object} labels 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.
|
|
* @property {dataproc(v1beta2).ClusterMetrics} metrics 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.
|
|
* @property {string} projectId Required. The Google Cloud Platform project ID that the cluster belongs to.
|
|
* @property {dataproc(v1beta2).ClusterStatus} status Output-only. Cluster status.
|
|
* @property {dataproc(v1beta2).ClusterStatus[]} statusHistory Output-only. The previous cluster status.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ClusterConfig
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} configBucket Optional. A Google 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.
|
|
* @property {dataproc(v1beta2).GceClusterConfig} gceClusterConfig Required. The shared Google Compute Engine config settings for all instances in a cluster.
|
|
* @property {dataproc(v1beta2).NodeInitializationAction[]} initializationActions 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
|
|
|
|
* @property {dataproc(v1beta2).LifecycleConfig} lifecycleConfig Optional. The config setting for auto delete cluster schedule.
|
|
* @property {dataproc(v1beta2).InstanceGroupConfig} masterConfig Optional. The Google Compute Engine config settings for the master instance in a cluster.
|
|
* @property {dataproc(v1beta2).InstanceGroupConfig} secondaryWorkerConfig Optional. The Google Compute Engine config settings for additional worker instances in a cluster.
|
|
* @property {dataproc(v1beta2).SoftwareConfig} softwareConfig Optional. The config settings for software inside the cluster.
|
|
* @property {dataproc(v1beta2).InstanceGroupConfig} workerConfig Optional. The Google Compute Engine config settings for worker instances in a cluster.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ClusterMetrics
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {object} hdfsMetrics The HDFS metrics.
|
|
* @property {object} yarnMetrics The YARN metrics.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ClusterOperationMetadata
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} clusterName Output-only. Name of the cluster for the operation.
|
|
* @property {string} clusterUuid Output-only. Cluster UUID for the operation.
|
|
* @property {string} description Output-only. Short description of operation.
|
|
* @property {object} labels Output-only. Labels associated with the operation
|
|
* @property {string} operationType Output-only. The operation type.
|
|
* @property {dataproc(v1beta2).ClusterOperationStatus} status Output-only. Current operation status.
|
|
* @property {dataproc(v1beta2).ClusterOperationStatus[]} statusHistory Output-only. The previous operation status.
|
|
* @property {string[]} warnings Output-only. Errors encountered during operation execution.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ClusterOperationStatus
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} details Output-only.A message containing any operation metadata details.
|
|
* @property {string} innerState Output-only. A message containing the detailed operation state.
|
|
* @property {string} state Output-only. A message containing the operation state.
|
|
* @property {string} stateStartTime Output-only. The time this state was entered.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ClusterStatus
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} detail Output-only. Optional details of cluster's state.
|
|
* @property {string} state Output-only. The cluster's state.
|
|
* @property {string} stateStartTime Output-only. Time when this state was entered.
|
|
* @property {string} substate Output-only. Additional state information that includes status reported by the agent.
|
|
*/
|
|
|
|
/**
|
|
* @typedef DiagnoseClusterRequest
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
*/
|
|
|
|
/**
|
|
* @typedef DiagnoseClusterResults
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} outputUri Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.
|
|
*/
|
|
|
|
/**
|
|
* @typedef DiskConfig
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {integer} bootDiskSizeGb Optional. Size in GB of the boot disk (default is 500GB).
|
|
* @property {integer} numLocalSsds 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.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Empty
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
*/
|
|
|
|
/**
|
|
* @typedef GceClusterConfig
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {boolean} internalIpOnly 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.
|
|
* @property {object} metadata The Google 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)).
|
|
* @property {string} networkUri Optional. The Google 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
|
|
* @property {string} serviceAccount Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing 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
|
|
* @property {string[]} serviceAccountScopes Optional. The URIs of service account scopes to be included in Google 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
|
|
* @property {string} subnetworkUri Optional. The Google 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
|
|
* @property {string[]} tags The Google Compute Engine tags to add to all instances (see Tagging instances).
|
|
* @property {string} zoneUri Optional. The zone where the Google 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
|
|
*/
|
|
|
|
/**
|
|
* @typedef HadoopJob
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string[]} archiveUris 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.
|
|
* @property {string[]} args 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.
|
|
* @property {string[]} fileUris 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.
|
|
* @property {string[]} jarFileUris Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
|
|
* @property {dataproc(v1beta2).LoggingConfig} loggingConfig Optional. The runtime log config for job execution.
|
|
* @property {string} mainClass 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.
|
|
* @property {string} mainJarFileUri 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'
|
|
* @property {object} properties 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.
|
|
*/
|
|
|
|
/**
|
|
* @typedef HiveJob
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {boolean} continueOnFailure 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.
|
|
* @property {string[]} jarFileUris 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.
|
|
* @property {object} properties 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.
|
|
* @property {string} queryFileUri The HCFS URI of the script that contains Hive queries.
|
|
* @property {dataproc(v1beta2).QueryList} queryList A list of queries.
|
|
* @property {object} scriptVariables Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
|
|
*/
|
|
|
|
/**
|
|
* @typedef InstanceGroupConfig
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {dataproc(v1beta2).AcceleratorConfig[]} accelerators Optional. The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
|
|
* @property {dataproc(v1beta2).DiskConfig} diskConfig Optional. Disk option config settings.
|
|
* @property {string} imageUri Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
|
|
* @property {string[]} instanceNames 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).
|
|
* @property {boolean} isPreemptible Optional. Specifies that this instance group contains preemptible instances.
|
|
* @property {string} machineTypeUri Optional. The Google 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-2
|
|
* @property {dataproc(v1beta2).ManagedGroupConfig} managedGroupConfig Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
|
|
* @property {integer} numInstances Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Job
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} driverControlFilesUri 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.
|
|
* @property {string} driverOutputResourceUri Output-only. A URI pointing to the location of the stdout of the job's driver program.
|
|
* @property {dataproc(v1beta2).HadoopJob} hadoopJob Job is a Hadoop job.
|
|
* @property {dataproc(v1beta2).HiveJob} hiveJob Job is a Hive job.
|
|
* @property {object} labels 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.
|
|
* @property {dataproc(v1beta2).PigJob} pigJob Job is a Pig job.
|
|
* @property {dataproc(v1beta2).JobPlacement} placement Required. Job information, including how, when, and where to run the job.
|
|
* @property {dataproc(v1beta2).PySparkJob} pysparkJob Job is a Pyspark job.
|
|
* @property {dataproc(v1beta2).JobReference} reference 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>.
|
|
* @property {dataproc(v1beta2).JobScheduling} scheduling Optional. Job scheduling configuration.
|
|
* @property {dataproc(v1beta2).SparkJob} sparkJob Job is a Spark job.
|
|
* @property {dataproc(v1beta2).SparkSqlJob} sparkSqlJob Job is a SparkSql job.
|
|
* @property {dataproc(v1beta2).JobStatus} status 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.
|
|
* @property {dataproc(v1beta2).JobStatus[]} statusHistory Output-only. The previous job status.
|
|
* @property {dataproc(v1beta2).YarnApplication[]} yarnApplications 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.
|
|
*/
|
|
|
|
/**
|
|
* @typedef JobPlacement
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} clusterName Required. The name of the cluster where the job will be submitted.
|
|
* @property {string} clusterUuid Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
|
|
*/
|
|
|
|
/**
|
|
* @typedef JobReference
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} jobId 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.
|
|
* @property {string} projectId Required. The ID of the Google Cloud Platform project that the job belongs to.
|
|
*/
|
|
|
|
/**
|
|
* @typedef JobScheduling
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {integer} maxFailuresPerHour 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.
|
|
*/
|
|
|
|
/**
|
|
* @typedef JobStatus
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} details Output-only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
|
|
* @property {string} state Output-only. A state message specifying the overall job state.
|
|
* @property {string} stateStartTime Output-only. The time when this state was entered.
|
|
* @property {string} substate Output-only. Additional state information, which includes status reported by the agent.
|
|
*/
|
|
|
|
/**
|
|
* @typedef LifecycleConfig
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} autoDeleteTime Optional. The time when cluster will be auto-deleted.
|
|
* @property {string} autoDeleteTtl Optional. The life duration of cluster, the cluster will be auto-deleted at the end of this duration.
|
|
* @property {string} idleDeleteTtl Optional. The longest duration that cluster would keep alive while staying idle; passing this threshold will cause cluster to be auto-deleted.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ListClustersResponse
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {dataproc(v1beta2).Cluster[]} clusters Output-only. The clusters in the project.
|
|
* @property {string} nextPageToken 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>.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ListJobsResponse
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {dataproc(v1beta2).Job[]} jobs Output-only. Jobs list.
|
|
* @property {string} nextPageToken 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>.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ListOperationsResponse
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} nextPageToken The standard List next-page token.
|
|
* @property {dataproc(v1beta2).Operation[]} operations A list of operations that matches the specified filter in the request.
|
|
*/
|
|
|
|
/**
|
|
* @typedef LoggingConfig
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {object} driverLogLevels 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'
|
|
*/
|
|
|
|
/**
|
|
* @typedef ManagedGroupConfig
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} instanceGroupManagerName Output-only. The name of the Instance Group Manager for this group.
|
|
* @property {string} instanceTemplateName Output-only. The name of the Instance Template used for the Managed Instance Group.
|
|
*/
|
|
|
|
/**
|
|
* @typedef NodeInitializationAction
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} executableFile Required. Google Cloud Storage URI of executable file.
|
|
* @property {string} executionTimeout 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.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Operation
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {boolean} done 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.
|
|
* @property {dataproc(v1beta2).Status} error The error result of the operation in case of failure or cancellation.
|
|
* @property {object} metadata 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.
|
|
* @property {string} name 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.
|
|
* @property {object} response 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.
|
|
*/
|
|
|
|
/**
|
|
* @typedef PigJob
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {boolean} continueOnFailure 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.
|
|
* @property {string[]} jarFileUris Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
|
|
* @property {dataproc(v1beta2).LoggingConfig} loggingConfig Optional. The runtime log config for job execution.
|
|
* @property {object} properties 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.
|
|
* @property {string} queryFileUri The HCFS URI of the script that contains the Pig queries.
|
|
* @property {dataproc(v1beta2).QueryList} queryList A list of queries.
|
|
* @property {object} scriptVariables Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
|
|
*/
|
|
|
|
/**
|
|
* @typedef Policy
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {dataproc(v1beta2).Binding[]} bindings Associates a list of members to a role. bindings with no members will result in an error.
|
|
* @property {string} etag 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.
|
|
* @property {integer} version Version of the Policy. The default version is 0.
|
|
*/
|
|
|
|
/**
|
|
* @typedef PySparkJob
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string[]} archiveUris Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
|
|
* @property {string[]} args 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.
|
|
* @property {string[]} fileUris Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
|
|
* @property {string[]} jarFileUris Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
|
|
* @property {dataproc(v1beta2).LoggingConfig} loggingConfig Optional. The runtime log config for job execution.
|
|
* @property {string} mainPythonFileUri Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
|
|
* @property {object} properties 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.
|
|
* @property {string[]} pythonFileUris Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
|
|
*/
|
|
|
|
/**
|
|
* @typedef QueryList
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string[]} queries 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",
|
|
]
|
|
}
|
|
}
|
|
|
|
*/
|
|
|
|
/**
|
|
* @typedef SetIamPolicyRequest
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {dataproc(v1beta2).Policy} policy 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.
|
|
*/
|
|
|
|
/**
|
|
* @typedef SoftwareConfig
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} imageVersion 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).
|
|
* @property {object} properties 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.
|
|
*/
|
|
|
|
/**
|
|
* @typedef SparkJob
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string[]} archiveUris 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.
|
|
* @property {string[]} args 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.
|
|
* @property {string[]} fileUris Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
|
|
* @property {string[]} jarFileUris Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
|
|
* @property {dataproc(v1beta2).LoggingConfig} loggingConfig Optional. The runtime log config for job execution.
|
|
* @property {string} mainClass 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.
|
|
* @property {string} mainJarFileUri The HCFS URI of the jar file that contains the main class.
|
|
* @property {object} properties 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.
|
|
*/
|
|
|
|
/**
|
|
* @typedef SparkSqlJob
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string[]} jarFileUris Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
|
|
* @property {dataproc(v1beta2).LoggingConfig} loggingConfig Optional. The runtime log config for job execution.
|
|
* @property {object} properties 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.
|
|
* @property {string} queryFileUri The HCFS URI of the script that contains SQL queries.
|
|
* @property {dataproc(v1beta2).QueryList} queryList A list of queries.
|
|
* @property {object} scriptVariables Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
|
|
*/
|
|
|
|
/**
|
|
* @typedef Status
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {integer} code The status code, which should be an enum value of google.rpc.Code.
|
|
* @property {object[]} details A list of messages that carry the error details. There is a common set of message types for APIs to use.
|
|
* @property {string} message 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.
|
|
*/
|
|
|
|
/**
|
|
* @typedef SubmitJobRequest
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {dataproc(v1beta2).Job} job Required. The job resource.
|
|
*/
|
|
|
|
/**
|
|
* @typedef TestIamPermissionsRequest
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string[]} permissions 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).
|
|
*/
|
|
|
|
/**
|
|
* @typedef TestIamPermissionsResponse
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string[]} permissions A subset of TestPermissionsRequest.permissions that the caller is allowed.
|
|
*/
|
|
|
|
/**
|
|
* @typedef YarnApplication
|
|
* @memberOf! dataproc(v1beta2)
|
|
* @type object
|
|
* @property {string} name Required. The application name.
|
|
* @property {number} progress Required. The numerical progress of the application, from 1 to 100.
|
|
* @property {string} state Required. The application state.
|
|
* @property {string} trackingUrl 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.
|
|
*/
|
|
export = Dataproc;
|