Google Git
Sign in
flutter / third_party / googleapis.dart / dc994e8897b15ca55d8082a22e87105030891bf4 / . / generated / googleapis / lib / dataproc / v1.dart
blob: e372a9970efff5cfd7515bae550b8ad3805dbdd8 [file] [log] [blame]
// This is a generated file (see the discoveryapis_generator project).
// ignore_for_file: camel_case_types
// ignore_for_file: comment_references
// ignore_for_file: file_names
// ignore_for_file: library_names
// ignore_for_file: lines_longer_than_80_chars
// ignore_for_file: non_constant_identifier_names
// ignore_for_file: prefer_expression_function_bodies
// ignore_for_file: prefer_final_locals
// ignore_for_file: prefer_interpolation_to_compose_strings
// ignore_for_file: unnecessary_brace_in_string_interps
// ignore_for_file: unnecessary_cast
// ignore_for_file: unnecessary_lambdas
// ignore_for_file: unnecessary_parenthesis
// ignore_for_file: unnecessary_string_interpolations
/// Cloud Dataproc API - v1
///
/// Manages Hadoop-based clusters and jobs on Google Cloud Platform.
///
/// For more information, see <https://cloud.google.com/dataproc/>
///
/// Create an instance of [DataprocApi] to access these resources:
///
/// - [ProjectsResource]
/// - [ProjectsLocationsResource]
/// - [ProjectsLocationsAutoscalingPoliciesResource]
/// - [ProjectsLocationsWorkflowTemplatesResource]
/// - [ProjectsRegionsResource]
/// - [ProjectsRegionsAutoscalingPoliciesResource]
/// - [ProjectsRegionsClustersResource]
/// - [ProjectsRegionsJobsResource]
/// - [ProjectsRegionsOperationsResource]
/// - [ProjectsRegionsWorkflowTemplatesResource]
library dataproc.v1;
import 'dart:async' as async;
import 'dart:convert' as convert;
import 'dart:core' as core;
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;
import '../src/user_agent.dart';
export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
show ApiRequestError, DetailedApiRequestError;
/// Manages Hadoop-based clusters and jobs on Google Cloud Platform.
class DataprocApi {
/// View and manage your data across Google Cloud Platform services
static const cloudPlatformScope =
'https://www.googleapis.com/auth/cloud-platform';
final commons.ApiRequester _requester;
ProjectsResource get projects => ProjectsResource(_requester);
DataprocApi(http.Client client,
{core.String rootUrl = 'https://dataproc.googleapis.com/',
core.String servicePath = ''})
: _requester =
commons.ApiRequester(client, rootUrl, servicePath, userAgent);
}
class ProjectsResource {
final commons.ApiRequester _requester;
ProjectsLocationsResource get locations =>
ProjectsLocationsResource(_requester);
ProjectsRegionsResource get regions => ProjectsRegionsResource(_requester);
ProjectsResource(commons.ApiRequester client) : _requester = client;
}
class ProjectsLocationsResource {
final commons.ApiRequester _requester;
ProjectsLocationsAutoscalingPoliciesResource get autoscalingPolicies =>
ProjectsLocationsAutoscalingPoliciesResource(_requester);
ProjectsLocationsWorkflowTemplatesResource get workflowTemplates =>
ProjectsLocationsWorkflowTemplatesResource(_requester);
ProjectsLocationsResource(commons.ApiRequester client) : _requester = client;
}
class ProjectsLocationsAutoscalingPoliciesResource {
final commons.ApiRequester _requester;
ProjectsLocationsAutoscalingPoliciesResource(commons.ApiRequester client)
: _requester = client;
/// Creates new autoscaling policy.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The "resource name" of the region or location, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.autoscalingPolicies.create, the resource name of the
/// region has the following format: projects/{project_id}/regions/{region}
/// For projects.locations.autoscalingPolicies.create, the resource name of
/// the location has the following format:
/// projects/{project_id}/locations/{location}
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [AutoscalingPolicy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<AutoscalingPolicy> create(
AutoscalingPolicy request,
core.String parent, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (parent == null) {
throw core.ArgumentError('Parameter parent is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/autoscalingPolicies';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return AutoscalingPolicy.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Deletes an autoscaling policy.
///
/// It is an error to delete an autoscaling policy that is in use by one or
/// more clusters.
///
/// Request parameters:
///
/// [name] - Required. The "resource name" of the autoscaling policy, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.autoscalingPolicies.delete, the resource name of the
/// policy has the following format:
/// projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For
/// projects.locations.autoscalingPolicies.delete, the resource name of the
/// policy has the following format:
/// projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> delete(
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'DELETE',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Empty.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Retrieves autoscaling policy.
///
/// Request parameters:
///
/// [name] - Required. The "resource name" of the autoscaling policy, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.autoscalingPolicies.get, the resource name of the policy
/// has the following format:
/// projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For
/// projects.locations.autoscalingPolicies.get, the resource name of the
/// policy has the following format:
/// projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [AutoscalingPolicy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<AutoscalingPolicy> get(
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return AutoscalingPolicy.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Gets the access control policy for a resource.
///
/// Returns an empty policy if the resource exists and does not have a policy
/// set.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> getIamPolicy(
GetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':getIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Lists autoscaling policies in the project.
///
/// Request parameters:
///
/// [parent] - Required. The "resource name" of the region or location, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.autoscalingPolicies.list, the resource name of the region
/// has the following format: projects/{project_id}/regions/{region} For
/// projects.locations.autoscalingPolicies.list, the resource name of the
/// location has the following format:
/// projects/{project_id}/locations/{location}
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [pageSize] - Optional. The maximum number of results to return in each
/// response. Must be less than or equal to 1000. Defaults to 100.
///
/// [pageToken] - Optional. The page token, returned by a previous call, to
/// request the next page of results.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListAutoscalingPoliciesResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListAutoscalingPoliciesResponse> list(
core.String parent, {
core.int pageSize,
core.String pageToken,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (parent == null) {
throw core.ArgumentError('Parameter parent is required.');
}
if (pageSize != null) {
_queryParams['pageSize'] = ['${pageSize}'];
}
if (pageToken != null) {
_queryParams['pageToken'] = [pageToken];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/autoscalingPolicies';
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return ListAutoscalingPoliciesResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Sets the access control policy on the specified resource.
///
/// Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and
/// PERMISSION_DENIED errors.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// specified. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> setIamPolicy(
SetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':setIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// 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.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy detail is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [TestIamPermissionsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<TestIamPermissionsResponse> testIamPermissions(
TestIamPermissionsRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':testIamPermissions';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return TestIamPermissionsResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Updates (replaces) autoscaling policy.Disabled check for update_mask,
/// because all updates will be full replacements.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Output only. The "resource name" of the autoscaling policy, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.autoscalingPolicies, the resource name of the policy has
/// the following format:
/// projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For
/// projects.locations.autoscalingPolicies, the resource name of the policy
/// has the following format:
/// projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [AutoscalingPolicy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<AutoscalingPolicy> update(
AutoscalingPolicy request,
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'PUT',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return AutoscalingPolicy.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
}
class ProjectsLocationsWorkflowTemplatesResource {
final commons.ApiRequester _requester;
ProjectsLocationsWorkflowTemplatesResource(commons.ApiRequester client)
: _requester = client;
/// Creates new workflow template.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The resource name of the region or location, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates,create, the resource name of the region
/// has the following format: projects/{project_id}/regions/{region} For
/// projects.locations.workflowTemplates.create, the resource name of the
/// location has the following format:
/// projects/{project_id}/locations/{location}
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [WorkflowTemplate].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<WorkflowTemplate> create(
WorkflowTemplate request,
core.String parent, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (parent == null) {
throw core.ArgumentError('Parameter parent is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/workflowTemplates';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return WorkflowTemplate.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Deletes a workflow template.
///
/// It does not cancel in-progress workflows.
///
/// Request parameters:
///
/// [name] - Required. The resource name of the workflow template, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates.delete, the resource name of the
/// template has the following format:
/// projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
/// projects.locations.workflowTemplates.instantiate, the resource name of the
/// template has the following format:
/// projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [version] - Optional. The version of workflow template to delete. If
/// specified, will only delete the template if the current server version
/// matches specified version.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> delete(
core.String name, {
core.int version,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if (version != null) {
_queryParams['version'] = ['${version}'];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'DELETE',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Empty.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Retrieves the latest workflow template.Can retrieve previously
/// instantiated template by specifying optional version parameter.
///
/// Request parameters:
///
/// [name] - Required. The resource name of the workflow template, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates.get, the resource name of the template
/// has the following format:
/// projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
/// projects.locations.workflowTemplates.get, the resource name of the
/// template has the following format:
/// projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [version] - Optional. The version of workflow template to retrieve. Only
/// previously instantiated versions can be retrieved.If unspecified,
/// retrieves the current version.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [WorkflowTemplate].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<WorkflowTemplate> get(
core.String name, {
core.int version,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if (version != null) {
_queryParams['version'] = ['${version}'];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return WorkflowTemplate.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Gets the access control policy for a resource.
///
/// Returns an empty policy if the resource exists and does not have a policy
/// set.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> getIamPolicy(
GetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':getIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Instantiates a template and begins execution.The returned Operation can be
/// used to track execution of workflow by polling operations.get.
///
/// The Operation will complete when entire workflow is finished.The running
/// workflow can be aborted via operations.cancel. This will cause any
/// inflight jobs to be cancelled and workflow-owned clusters to be
/// deleted.The Operation.metadata will be WorkflowMetadata
/// (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata).
/// Also see Using WorkflowMetadata
/// (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On
/// successful completion, Operation.response will be Empty.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The resource name of the workflow template, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates.instantiate, the resource name of the
/// template has the following format:
/// projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
/// projects.locations.workflowTemplates.instantiate, the resource name of the
/// template has the following format:
/// projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> instantiate(
InstantiateWorkflowTemplateRequest request,
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url =
'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':instantiate';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Instantiates a template and begins execution.This method is equivalent to
/// executing the sequence CreateWorkflowTemplate,
/// InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation
/// can be used to track execution of workflow by polling operations.get.
///
/// The Operation will complete when entire workflow is finished.The running
/// workflow can be aborted via operations.cancel. This will cause any
/// inflight jobs to be cancelled and workflow-owned clusters to be
/// deleted.The Operation.metadata will be WorkflowMetadata
/// (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata).
/// Also see Using WorkflowMetadata
/// (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On
/// successful completion, Operation.response will be Empty.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The resource name of the region or location, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates,instantiateinline, the resource name of
/// the region has the following format:
/// projects/{project_id}/regions/{region} For
/// projects.locations.workflowTemplates.instantiateinline, the resource name
/// of the location has the following format:
/// projects/{project_id}/locations/{location}
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [requestId] - Optional. A tag that prevents multiple concurrent workflow
/// instances with the same tag from running. This mitigates risk of
/// concurrent instances started due to retries.It is recommended to always
/// set this value to a UUID
/// (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must
/// contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and
/// hyphens (-). The maximum length is 40 characters.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> instantiateInline(
WorkflowTemplate request,
core.String parent, {
core.String requestId,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (parent == null) {
throw core.ArgumentError('Parameter parent is required.');
}
if (requestId != null) {
_queryParams['requestId'] = [requestId];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/workflowTemplates:instantiateInline';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Lists workflows that match the specified filter in the request.
///
/// Request parameters:
///
/// [parent] - Required. The resource name of the region or location, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates,list, the resource name of the region
/// has the following format: projects/{project_id}/regions/{region} For
/// projects.locations.workflowTemplates.list, the resource name of the
/// location has the following format:
/// projects/{project_id}/locations/{location}
/// Value must have pattern `^projects/\[^/\]+/locations/\[^/\]+$`.
///
/// [pageSize] - Optional. The maximum number of results to return in each
/// response.
///
/// [pageToken] - Optional. The page token, returned by a previous call, to
/// request the next page of results.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListWorkflowTemplatesResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListWorkflowTemplatesResponse> list(
core.String parent, {
core.int pageSize,
core.String pageToken,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (parent == null) {
throw core.ArgumentError('Parameter parent is required.');
}
if (pageSize != null) {
_queryParams['pageSize'] = ['${pageSize}'];
}
if (pageToken != null) {
_queryParams['pageToken'] = [pageToken];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/workflowTemplates';
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return ListWorkflowTemplatesResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Sets the access control policy on the specified resource.
///
/// Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and
/// PERMISSION_DENIED errors.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// specified. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> setIamPolicy(
SetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':setIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// 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.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy detail is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [TestIamPermissionsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<TestIamPermissionsResponse> testIamPermissions(
TestIamPermissionsRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':testIamPermissions';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return TestIamPermissionsResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Updates (replaces) workflow template.
///
/// The updated template must contain version that matches the current server
/// version.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Output only. The resource name of the workflow template, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates, the resource name of the template has
/// the following format:
/// projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
/// projects.locations.workflowTemplates, the resource name of the template
/// has the following format:
/// projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
/// Value must have pattern
/// `^projects/\[^/\]+/locations/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [WorkflowTemplate].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<WorkflowTemplate> update(
WorkflowTemplate request,
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'PUT',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return WorkflowTemplate.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
}
class ProjectsRegionsResource {
final commons.ApiRequester _requester;
ProjectsRegionsAutoscalingPoliciesResource get autoscalingPolicies =>
ProjectsRegionsAutoscalingPoliciesResource(_requester);
ProjectsRegionsClustersResource get clusters =>
ProjectsRegionsClustersResource(_requester);
ProjectsRegionsJobsResource get jobs =>
ProjectsRegionsJobsResource(_requester);
ProjectsRegionsOperationsResource get operations =>
ProjectsRegionsOperationsResource(_requester);
ProjectsRegionsWorkflowTemplatesResource get workflowTemplates =>
ProjectsRegionsWorkflowTemplatesResource(_requester);
ProjectsRegionsResource(commons.ApiRequester client) : _requester = client;
}
class ProjectsRegionsAutoscalingPoliciesResource {
final commons.ApiRequester _requester;
ProjectsRegionsAutoscalingPoliciesResource(commons.ApiRequester client)
: _requester = client;
/// Creates new autoscaling policy.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The "resource name" of the region or location, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.autoscalingPolicies.create, the resource name of the
/// region has the following format: projects/{project_id}/regions/{region}
/// For projects.locations.autoscalingPolicies.create, the resource name of
/// the location has the following format:
/// projects/{project_id}/locations/{location}
/// Value must have pattern `^projects/\[^/\]+/regions/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [AutoscalingPolicy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<AutoscalingPolicy> create(
AutoscalingPolicy request,
core.String parent, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (parent == null) {
throw core.ArgumentError('Parameter parent is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/autoscalingPolicies';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return AutoscalingPolicy.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Deletes an autoscaling policy.
///
/// It is an error to delete an autoscaling policy that is in use by one or
/// more clusters.
///
/// Request parameters:
///
/// [name] - Required. The "resource name" of the autoscaling policy, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.autoscalingPolicies.delete, the resource name of the
/// policy has the following format:
/// projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For
/// projects.locations.autoscalingPolicies.delete, the resource name of the
/// policy has the following format:
/// projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> delete(
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'DELETE',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Empty.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Retrieves autoscaling policy.
///
/// Request parameters:
///
/// [name] - Required. The "resource name" of the autoscaling policy, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.autoscalingPolicies.get, the resource name of the policy
/// has the following format:
/// projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For
/// projects.locations.autoscalingPolicies.get, the resource name of the
/// policy has the following format:
/// projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [AutoscalingPolicy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<AutoscalingPolicy> get(
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return AutoscalingPolicy.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Gets the access control policy for a resource.
///
/// Returns an empty policy if the resource exists and does not have a policy
/// set.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> getIamPolicy(
GetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':getIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Lists autoscaling policies in the project.
///
/// Request parameters:
///
/// [parent] - Required. The "resource name" of the region or location, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.autoscalingPolicies.list, the resource name of the region
/// has the following format: projects/{project_id}/regions/{region} For
/// projects.locations.autoscalingPolicies.list, the resource name of the
/// location has the following format:
/// projects/{project_id}/locations/{location}
/// Value must have pattern `^projects/\[^/\]+/regions/\[^/\]+$`.
///
/// [pageSize] - Optional. The maximum number of results to return in each
/// response. Must be less than or equal to 1000. Defaults to 100.
///
/// [pageToken] - Optional. The page token, returned by a previous call, to
/// request the next page of results.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListAutoscalingPoliciesResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListAutoscalingPoliciesResponse> list(
core.String parent, {
core.int pageSize,
core.String pageToken,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (parent == null) {
throw core.ArgumentError('Parameter parent is required.');
}
if (pageSize != null) {
_queryParams['pageSize'] = ['${pageSize}'];
}
if (pageToken != null) {
_queryParams['pageToken'] = [pageToken];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/autoscalingPolicies';
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return ListAutoscalingPoliciesResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Sets the access control policy on the specified resource.
///
/// Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and
/// PERMISSION_DENIED errors.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// specified. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> setIamPolicy(
SetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':setIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// 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.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy detail is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [TestIamPermissionsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<TestIamPermissionsResponse> testIamPermissions(
TestIamPermissionsRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':testIamPermissions';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return TestIamPermissionsResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Updates (replaces) autoscaling policy.Disabled check for update_mask,
/// because all updates will be full replacements.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Output only. The "resource name" of the autoscaling policy, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.autoscalingPolicies, the resource name of the policy has
/// the following format:
/// projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For
/// projects.locations.autoscalingPolicies, the resource name of the policy
/// has the following format:
/// projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/autoscalingPolicies/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [AutoscalingPolicy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<AutoscalingPolicy> update(
AutoscalingPolicy request,
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'PUT',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return AutoscalingPolicy.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
}
class ProjectsRegionsClustersResource {
final commons.ApiRequester _requester;
ProjectsRegionsClustersResource(commons.ApiRequester client)
: _requester = client;
/// Creates a cluster in a project.
///
/// The returned Operation.metadata will be ClusterOperationMetadata
/// (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the cluster belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [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.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> create(
Cluster request,
core.String projectId,
core.String region, {
core.String requestId,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (requestId != null) {
_queryParams['requestId'] = [requestId];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/clusters';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Deletes a cluster in a project.
///
/// The returned Operation.metadata will be ClusterOperationMetadata
/// (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the cluster belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [clusterName] - Required. The cluster name.
///
/// [clusterUuid] - Optional. Specifying the cluster_uuid means the RPC should
/// fail (with error NOT_FOUND) if cluster with specified UUID does not exist.
///
/// [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.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> delete(
core.String projectId,
core.String region,
core.String clusterName, {
core.String clusterUuid,
core.String requestId,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (clusterName == null) {
throw core.ArgumentError('Parameter clusterName is required.');
}
if (clusterUuid != null) {
_queryParams['clusterUuid'] = [clusterUuid];
}
if (requestId != null) {
_queryParams['requestId'] = [requestId];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/clusters/' +
commons.Escaper.ecapeVariable('$clusterName');
final _response = await _requester.request(
_url,
'DELETE',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Gets cluster diagnostic information.
///
/// The returned Operation.metadata will be ClusterOperationMetadata
/// (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
/// After the operation completes, Operation.response contains
/// DiagnoseClusterResults
/// (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the cluster belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [clusterName] - Required. The cluster name.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> diagnose(
DiagnoseClusterRequest request,
core.String projectId,
core.String region,
core.String clusterName, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (clusterName == null) {
throw core.ArgumentError('Parameter clusterName is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/clusters/' +
commons.Escaper.ecapeVariable('$clusterName') +
':diagnose';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Gets the resource representation for a cluster in a project.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the cluster belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [clusterName] - Required. The cluster name.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Cluster].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Cluster> get(
core.String projectId,
core.String region,
core.String clusterName, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (clusterName == null) {
throw core.ArgumentError('Parameter clusterName is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/clusters/' +
commons.Escaper.ecapeVariable('$clusterName');
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Cluster.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Gets the access control policy for a resource.
///
/// Returns an empty policy if the resource exists and does not have a policy
/// set.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/clusters/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> getIamPolicy(
GetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':getIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Inject encrypted credentials into all of the VMs in a cluster.The target
/// cluster must be a personal auth cluster assigned to the user who is
/// issuing the RPC.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [project] - Required. The ID of the Google Cloud Platform project the
/// cluster belongs to, of the form projects/.
/// Value must have pattern `^projects/\[^/\]+$`.
///
/// [region] - Required. The region containing the cluster, of the form
/// regions/.
/// Value must have pattern `^regions/\[^/\]+$`.
///
/// [cluster] - Required. The cluster, in the form clusters/.
/// Value must have pattern `^clusters/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> injectCredentials(
InjectCredentialsRequest request,
core.String project,
core.String region,
core.String cluster, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (project == null) {
throw core.ArgumentError('Parameter project is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (cluster == null) {
throw core.ArgumentError('Parameter cluster is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$project') +
'/' +
commons.Escaper.ecapeVariableReserved('$region') +
'/' +
commons.Escaper.ecapeVariableReserved('$cluster') +
':injectCredentials';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Lists all regions/{region}/clusters in a project alphabetically.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the cluster belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [filter] - Optional. A filter constraining the clusters to list. Filters
/// are case-sensitive and have the following syntax:field = value AND field =
/// value ...where field is one of status.state, clusterName, or
/// labels.\[KEY\], and \[KEY\] is a label key. value can be * to match all
/// values. status.state can be one of the following: ACTIVE, INACTIVE,
/// CREATING, RUNNING, ERROR, DELETING, 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 = *
///
/// [pageSize] - Optional. The standard List page size.
///
/// [pageToken] - Optional. The standard List page token.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListClustersResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListClustersResponse> list(
core.String projectId,
core.String region, {
core.String filter,
core.int pageSize,
core.String pageToken,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (filter != null) {
_queryParams['filter'] = [filter];
}
if (pageSize != null) {
_queryParams['pageSize'] = ['${pageSize}'];
}
if (pageToken != null) {
_queryParams['pageToken'] = [pageToken];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/clusters';
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return ListClustersResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Updates a cluster in a project.
///
/// The returned Operation.metadata will be ClusterOperationMetadata
/// (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project the
/// cluster belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [clusterName] - Required. The cluster name.
///
/// [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. (see JSON
/// representation of Duration
/// (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only
/// supported on Dataproc image versions 1.2 and higher.
///
/// [requestId] - Optional. A unique id used to identify the request. If the
/// server receives two UpdateClusterRequest requests with the same id, then
/// the second request will be ignored and the first
/// google.longrunning.Operation created and stored in the backend is
/// returned.It is recommended to always set this value to a UUID
/// (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must
/// contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and
/// hyphens (-). The maximum length is 40 characters.
///
/// [updateMask] - Required. Specifies the path, relative to Cluster, of the
/// field to update. For example, to change the number of workers in a cluster
/// to 5, the update_mask parameter would be specified as
/// config.worker_config.num_instances, and the PATCH request body would
/// specify the new value, as follows: { "config":{ "workerConfig":{
/// "numInstances":"5" } } } Similarly, to change the number of preemptible
/// workers in a cluster to 5, the update_mask parameter would be
/// config.secondary_worker_config.num_instances, and the PATCH request body
/// would be set as follows: { "config":{ "secondaryWorkerConfig":{
/// "numInstances":"5" } } } *Note:* Currently, only the following fields can
/// be updated: *Mask* *Purpose* *labels* Update labels
/// *config.worker_config.num_instances* Resize primary worker group
/// *config.secondary_worker_config.num_instances* Resize secondary worker
/// group config.autoscaling_config.policy_uri Use, stop using, or change
/// autoscaling policies
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> patch(
Cluster request,
core.String projectId,
core.String region,
core.String clusterName, {
core.String gracefulDecommissionTimeout,
core.String requestId,
core.String updateMask,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (clusterName == null) {
throw core.ArgumentError('Parameter clusterName is required.');
}
if (gracefulDecommissionTimeout != null) {
_queryParams['gracefulDecommissionTimeout'] = [
gracefulDecommissionTimeout
];
}
if (requestId != null) {
_queryParams['requestId'] = [requestId];
}
if (updateMask != null) {
_queryParams['updateMask'] = [updateMask];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/clusters/' +
commons.Escaper.ecapeVariable('$clusterName');
final _response = await _requester.request(
_url,
'PATCH',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Sets the access control policy on the specified resource.
///
/// Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and
/// PERMISSION_DENIED errors.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// specified. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/clusters/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> setIamPolicy(
SetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':setIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// 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.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy detail is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/clusters/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [TestIamPermissionsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<TestIamPermissionsResponse> testIamPermissions(
TestIamPermissionsRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':testIamPermissions';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return TestIamPermissionsResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
}
class ProjectsRegionsJobsResource {
final commons.ApiRequester _requester;
ProjectsRegionsJobsResource(commons.ApiRequester client)
: _requester = client;
/// Starts a job cancellation request.
///
/// To access the job resource after cancellation, call
/// regions/{region}/jobs.list
/// (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list)
/// or regions/{region}/jobs.get
/// (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the job belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [jobId] - Required. The job ID.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Job].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Job> cancel(
CancelJobRequest request,
core.String projectId,
core.String region,
core.String jobId, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (jobId == null) {
throw core.ArgumentError('Parameter jobId is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/jobs/' +
commons.Escaper.ecapeVariable('$jobId') +
':cancel';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Job.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Deletes the job from the project.
///
/// If the job is active, the delete fails, and the response returns
/// FAILED_PRECONDITION.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the job belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [jobId] - Required. The job ID.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> delete(
core.String projectId,
core.String region,
core.String jobId, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (jobId == null) {
throw core.ArgumentError('Parameter jobId is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/jobs/' +
commons.Escaper.ecapeVariable('$jobId');
final _response = await _requester.request(
_url,
'DELETE',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Empty.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Gets the resource representation for a job in a project.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the job belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [jobId] - Required. The job ID.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Job].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Job> get(
core.String projectId,
core.String region,
core.String jobId, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (jobId == null) {
throw core.ArgumentError('Parameter jobId is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/jobs/' +
commons.Escaper.ecapeVariable('$jobId');
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Job.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Gets the access control policy for a resource.
///
/// Returns an empty policy if the resource exists and does not have a policy
/// set.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern `^projects/\[^/\]+/regions/\[^/\]+/jobs/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> getIamPolicy(
GetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':getIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Lists regions/{region}/jobs in a project.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the job belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [clusterName] - Optional. If set, the returned jobs list includes only
/// jobs that were submitted to the named cluster.
///
/// [filter] - Optional. A filter constraining the jobs to list. Filters are
/// case-sensitive and have the following syntax:field = value AND field =
/// value ...where field is status.state or labels.\[KEY\], and \[KEY\] is a
/// label key. value can be * to match all values. status.state can be either
/// ACTIVE or NON_ACTIVE. Only the logical AND operator is supported;
/// space-separated items are treated as having an implicit AND
/// operator.Example filter:status.state = ACTIVE AND labels.env = staging AND
/// labels.starred = *
///
/// [jobStateMatcher] - Optional. Specifies enumerated categories of jobs to
/// list. (default = match ALL jobs).If filter is provided, jobStateMatcher
/// will be ignored.
/// Possible string values are:
/// - "ALL" : Match all jobs, regardless of state.
/// - "ACTIVE" : Only match jobs in non-terminal states: PENDING, RUNNING, or
/// CANCEL_PENDING.
/// - "NON_ACTIVE" : Only match jobs in terminal states: CANCELLED, DONE, or
/// ERROR.
///
/// [pageSize] - Optional. The number of results to return in each response.
///
/// [pageToken] - Optional. The page token, returned by a previous call, to
/// request the next page of results.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListJobsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListJobsResponse> list(
core.String projectId,
core.String region, {
core.String clusterName,
core.String filter,
core.String jobStateMatcher,
core.int pageSize,
core.String pageToken,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (clusterName != null) {
_queryParams['clusterName'] = [clusterName];
}
if (filter != null) {
_queryParams['filter'] = [filter];
}
if (jobStateMatcher != null) {
_queryParams['jobStateMatcher'] = [jobStateMatcher];
}
if (pageSize != null) {
_queryParams['pageSize'] = ['${pageSize}'];
}
if (pageToken != null) {
_queryParams['pageToken'] = [pageToken];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/jobs';
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return ListJobsResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Updates a job in a project.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the job belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [jobId] - Required. The job ID.
///
/// [updateMask] - Required. Specifies the path, relative to Job, of the field
/// to update. For example, to update the labels of a Job the update_mask
/// parameter would be specified as labels, and the PATCH request body would
/// specify the new value. *Note:* Currently, labels is the only field that
/// can be updated.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Job].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Job> patch(
Job request,
core.String projectId,
core.String region,
core.String jobId, {
core.String updateMask,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if (jobId == null) {
throw core.ArgumentError('Parameter jobId is required.');
}
if (updateMask != null) {
_queryParams['updateMask'] = [updateMask];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/jobs/' +
commons.Escaper.ecapeVariable('$jobId');
final _response = await _requester.request(
_url,
'PATCH',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Job.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Sets the access control policy on the specified resource.
///
/// Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and
/// PERMISSION_DENIED errors.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// specified. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern `^projects/\[^/\]+/regions/\[^/\]+/jobs/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> setIamPolicy(
SetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':setIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Submits a job to a cluster.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the job belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Job].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Job> submit(
SubmitJobRequest request,
core.String projectId,
core.String region, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/jobs:submit';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Job.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Submits job to a cluster.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [projectId] - Required. The ID of the Google Cloud Platform project that
/// the job belongs to.
///
/// [region] - Required. The Dataproc region in which to handle the request.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> submitAsOperation(
SubmitJobRequest request,
core.String projectId,
core.String region, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (projectId == null) {
throw core.ArgumentError('Parameter projectId is required.');
}
if (region == null) {
throw core.ArgumentError('Parameter region is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/projects/' +
commons.Escaper.ecapeVariable('$projectId') +
'/regions/' +
commons.Escaper.ecapeVariable('$region') +
'/jobs:submitAsOperation';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// 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.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy detail is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern `^projects/\[^/\]+/regions/\[^/\]+/jobs/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [TestIamPermissionsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<TestIamPermissionsResponse> testIamPermissions(
TestIamPermissionsRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':testIamPermissions';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return TestIamPermissionsResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
}
class ProjectsRegionsOperationsResource {
final commons.ApiRequester _requester;
ProjectsRegionsOperationsResource(commons.ApiRequester client)
: _requester = client;
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource to be cancelled.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/operations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> cancel(
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':cancel';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Empty.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource to be deleted.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/operations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> delete(
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'DELETE',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Empty.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// 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.
///
/// Request parameters:
///
/// [name] - The name of the operation resource.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/operations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> get(
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Gets the access control policy for a resource.
///
/// Returns an empty policy if the resource exists and does not have a policy
/// set.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/operations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> getIamPolicy(
GetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':getIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// 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 / * /operations. To
/// override the binding, API services can add a binding such as
/// "/v1/{name=users / * }/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.
///
/// Request parameters:
///
/// [name] - The name of the operation's parent resource.
/// Value must have pattern `^projects/\[^/\]+/regions/\[^/\]+/operations$`.
///
/// [filter] - The standard list filter.
///
/// [pageSize] - The standard list page size.
///
/// [pageToken] - The standard list page token.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListOperationsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListOperationsResponse> list(
core.String name, {
core.String filter,
core.int pageSize,
core.String pageToken,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if (filter != null) {
_queryParams['filter'] = [filter];
}
if (pageSize != null) {
_queryParams['pageSize'] = ['${pageSize}'];
}
if (pageToken != null) {
_queryParams['pageToken'] = [pageToken];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return ListOperationsResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Sets the access control policy on the specified resource.
///
/// Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and
/// PERMISSION_DENIED errors.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// specified. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/operations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> setIamPolicy(
SetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':setIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// 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.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy detail is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/operations/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [TestIamPermissionsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<TestIamPermissionsResponse> testIamPermissions(
TestIamPermissionsRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':testIamPermissions';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return TestIamPermissionsResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
}
class ProjectsRegionsWorkflowTemplatesResource {
final commons.ApiRequester _requester;
ProjectsRegionsWorkflowTemplatesResource(commons.ApiRequester client)
: _requester = client;
/// Creates new workflow template.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The resource name of the region or location, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates,create, the resource name of the region
/// has the following format: projects/{project_id}/regions/{region} For
/// projects.locations.workflowTemplates.create, the resource name of the
/// location has the following format:
/// projects/{project_id}/locations/{location}
/// Value must have pattern `^projects/\[^/\]+/regions/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [WorkflowTemplate].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<WorkflowTemplate> create(
WorkflowTemplate request,
core.String parent, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (parent == null) {
throw core.ArgumentError('Parameter parent is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/workflowTemplates';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return WorkflowTemplate.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Deletes a workflow template.
///
/// It does not cancel in-progress workflows.
///
/// Request parameters:
///
/// [name] - Required. The resource name of the workflow template, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates.delete, the resource name of the
/// template has the following format:
/// projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
/// projects.locations.workflowTemplates.instantiate, the resource name of the
/// template has the following format:
/// projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [version] - Optional. The version of workflow template to delete. If
/// specified, will only delete the template if the current server version
/// matches specified version.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> delete(
core.String name, {
core.int version,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if (version != null) {
_queryParams['version'] = ['${version}'];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'DELETE',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Empty.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Retrieves the latest workflow template.Can retrieve previously
/// instantiated template by specifying optional version parameter.
///
/// Request parameters:
///
/// [name] - Required. The resource name of the workflow template, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates.get, the resource name of the template
/// has the following format:
/// projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
/// projects.locations.workflowTemplates.get, the resource name of the
/// template has the following format:
/// projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [version] - Optional. The version of workflow template to retrieve. Only
/// previously instantiated versions can be retrieved.If unspecified,
/// retrieves the current version.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [WorkflowTemplate].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<WorkflowTemplate> get(
core.String name, {
core.int version,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if (version != null) {
_queryParams['version'] = ['${version}'];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return WorkflowTemplate.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Gets the access control policy for a resource.
///
/// Returns an empty policy if the resource exists and does not have a policy
/// set.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> getIamPolicy(
GetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':getIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Instantiates a template and begins execution.The returned Operation can be
/// used to track execution of workflow by polling operations.get.
///
/// The Operation will complete when entire workflow is finished.The running
/// workflow can be aborted via operations.cancel. This will cause any
/// inflight jobs to be cancelled and workflow-owned clusters to be
/// deleted.The Operation.metadata will be WorkflowMetadata
/// (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata).
/// Also see Using WorkflowMetadata
/// (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On
/// successful completion, Operation.response will be Empty.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required. The resource name of the workflow template, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates.instantiate, the resource name of the
/// template has the following format:
/// projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
/// projects.locations.workflowTemplates.instantiate, the resource name of the
/// template has the following format:
/// projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> instantiate(
InstantiateWorkflowTemplateRequest request,
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url =
'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':instantiate';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Instantiates a template and begins execution.This method is equivalent to
/// executing the sequence CreateWorkflowTemplate,
/// InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation
/// can be used to track execution of workflow by polling operations.get.
///
/// The Operation will complete when entire workflow is finished.The running
/// workflow can be aborted via operations.cancel. This will cause any
/// inflight jobs to be cancelled and workflow-owned clusters to be
/// deleted.The Operation.metadata will be WorkflowMetadata
/// (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata).
/// Also see Using WorkflowMetadata
/// (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On
/// successful completion, Operation.response will be Empty.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required. The resource name of the region or location, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates,instantiateinline, the resource name of
/// the region has the following format:
/// projects/{project_id}/regions/{region} For
/// projects.locations.workflowTemplates.instantiateinline, the resource name
/// of the location has the following format:
/// projects/{project_id}/locations/{location}
/// Value must have pattern `^projects/\[^/\]+/regions/\[^/\]+$`.
///
/// [requestId] - Optional. A tag that prevents multiple concurrent workflow
/// instances with the same tag from running. This mitigates risk of
/// concurrent instances started due to retries.It is recommended to always
/// set this value to a UUID
/// (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must
/// contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and
/// hyphens (-). The maximum length is 40 characters.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Operation].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Operation> instantiateInline(
WorkflowTemplate request,
core.String parent, {
core.String requestId,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (parent == null) {
throw core.ArgumentError('Parameter parent is required.');
}
if (requestId != null) {
_queryParams['requestId'] = [requestId];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/workflowTemplates:instantiateInline';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// Lists workflows that match the specified filter in the request.
///
/// Request parameters:
///
/// [parent] - Required. The resource name of the region or location, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates,list, the resource name of the region
/// has the following format: projects/{project_id}/regions/{region} For
/// projects.locations.workflowTemplates.list, the resource name of the
/// location has the following format:
/// projects/{project_id}/locations/{location}
/// Value must have pattern `^projects/\[^/\]+/regions/\[^/\]+$`.
///
/// [pageSize] - Optional. The maximum number of results to return in each
/// response.
///
/// [pageToken] - Optional. The page token, returned by a previous call, to
/// request the next page of results.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListWorkflowTemplatesResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListWorkflowTemplatesResponse> list(
core.String parent, {
core.int pageSize,
core.String pageToken,
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (parent == null) {
throw core.ArgumentError('Parameter parent is required.');
}
if (pageSize != null) {
_queryParams['pageSize'] = ['${pageSize}'];
}
if (pageToken != null) {
_queryParams['pageToken'] = [pageToken];
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/workflowTemplates';
final _response = await _requester.request(
_url,
'GET',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return ListWorkflowTemplatesResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Sets the access control policy on the specified resource.
///
/// Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and
/// PERMISSION_DENIED errors.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// specified. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> setIamPolicy(
SetIamPolicyRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':setIamPolicy';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return Policy.fromJson(_response as core.Map<core.String, core.dynamic>);
}
/// 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.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy detail is being
/// requested. See the operation documentation for the appropriate value for
/// this field.
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [TestIamPermissionsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<TestIamPermissionsResponse> testIamPermissions(
TestIamPermissionsRequest request,
core.String resource, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (resource == null) {
throw core.ArgumentError('Parameter resource is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':testIamPermissions';
final _response = await _requester.request(
_url,
'POST',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return TestIamPermissionsResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
/// Updates (replaces) workflow template.
///
/// The updated template must contain version that matches the current server
/// version.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Output only. The resource name of the workflow template, as
/// described in https://cloud.google.com/apis/design/resource_names. For
/// projects.regions.workflowTemplates, the resource name of the template has
/// the following format:
/// projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
/// projects.locations.workflowTemplates, the resource name of the template
/// has the following format:
/// projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
/// Value must have pattern
/// `^projects/\[^/\]+/regions/\[^/\]+/workflowTemplates/\[^/\]+$`.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [WorkflowTemplate].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<WorkflowTemplate> update(
WorkflowTemplate request,
core.String name, {
core.String $fields,
}) async {
core.String _url;
final _queryParams = <core.String, core.List<core.String>>{};
commons.Media _uploadMedia;
commons.UploadOptions _uploadOptions;
var _downloadOptions = commons.DownloadOptions.Metadata;
core.String _body;
if (request != null) {
_body = convert.json.encode(request.toJson());
}
if (name == null) {
throw core.ArgumentError('Parameter name is required.');
}
if ($fields != null) {
_queryParams['fields'] = [$fields];
}
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
final _response = await _requester.request(
_url,
'PUT',
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions,
);
return WorkflowTemplate.fromJson(
_response as core.Map<core.String, core.dynamic>);
}
}
/// Specifies the type and number of accelerator cards attached to the instances
/// of an instance.
///
/// See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
class AcceleratorConfig {
/// The number of the accelerator cards of this type exposed to this instance.
core.int acceleratorCount;
/// Full URL, partial URI, or short name of the accelerator type resource to
/// expose to this instance.
///
/// See Compute Engine AcceleratorTypes
/// (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
/// https://www.googleapis.com/compute/beta/projects/\[project_id\]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
/// projects/\[project_id\]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
/// nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto
/// Zone Placement
/// (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
/// feature, you must use the short name of the accelerator type resource, for
/// example, nvidia-tesla-k80.
core.String acceleratorTypeUri;
AcceleratorConfig();
AcceleratorConfig.fromJson(core.Map _json) {
if (_json.containsKey('acceleratorCount')) {
acceleratorCount = _json['acceleratorCount'] as core.int;
}
if (_json.containsKey('acceleratorTypeUri')) {
acceleratorTypeUri = _json['acceleratorTypeUri'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (acceleratorCount != null) {
_json['acceleratorCount'] = acceleratorCount;
}
if (acceleratorTypeUri != null) {
_json['acceleratorTypeUri'] = acceleratorTypeUri;
}
return _json;
}
}
/// Autoscaling Policy config associated with the cluster.
class AutoscalingConfig {
/// The autoscaling policy used by the cluster.Only resource names including
/// projectid and location (region) are valid.
///
/// Examples:
/// https://www.googleapis.com/compute/v1/projects/\[project_id\]/locations/\[dataproc_region\]/autoscalingPolicies/\[policy_id\]
/// projects/\[project_id\]/locations/\[dataproc_region\]/autoscalingPolicies/\[policy_id\]Note
/// that the policy must be in the same project and Dataproc region.
///
/// Optional.
core.String policyUri;
AutoscalingConfig();
AutoscalingConfig.fromJson(core.Map _json) {
if (_json.containsKey('policyUri')) {
policyUri = _json['policyUri'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (policyUri != null) {
_json['policyUri'] = policyUri;
}
return _json;
}
}
/// Describes an autoscaling policy for Dataproc cluster autoscaler.
class AutoscalingPolicy {
BasicAutoscalingAlgorithm basicAlgorithm;
/// The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9),
/// underscores (_), and hyphens (-).
///
/// Cannot begin or end with underscore or hyphen. Must consist of between 3
/// and 50 characters.
///
/// Required.
core.String id;
/// The "resource name" of the autoscaling policy, as described in
/// https://cloud.google.com/apis/design/resource_names.
///
/// For projects.regions.autoscalingPolicies, the resource name of the policy
/// has the following format:
/// projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For
/// projects.locations.autoscalingPolicies, the resource name of the policy
/// has the following format:
/// projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
///
/// Output only.
core.String name;
/// Describes how the autoscaler will operate for secondary workers.
///
/// Optional.
InstanceGroupAutoscalingPolicyConfig secondaryWorkerConfig;
/// Describes how the autoscaler will operate for primary workers.
///
/// Required.
InstanceGroupAutoscalingPolicyConfig workerConfig;
AutoscalingPolicy();
AutoscalingPolicy.fromJson(core.Map _json) {
if (_json.containsKey('basicAlgorithm')) {
basicAlgorithm = BasicAutoscalingAlgorithm.fromJson(
_json['basicAlgorithm'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('id')) {
id = _json['id'] as core.String;
}
if (_json.containsKey('name')) {
name = _json['name'] as core.String;
}
if (_json.containsKey('secondaryWorkerConfig')) {
secondaryWorkerConfig = InstanceGroupAutoscalingPolicyConfig.fromJson(
_json['secondaryWorkerConfig']
as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('workerConfig')) {
workerConfig = InstanceGroupAutoscalingPolicyConfig.fromJson(
_json['workerConfig'] as core.Map<core.String, core.dynamic>);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (basicAlgorithm != null) {
_json['basicAlgorithm'] = basicAlgorithm.toJson();
}
if (id != null) {
_json['id'] = id;
}
if (name != null) {
_json['name'] = name;
}
if (secondaryWorkerConfig != null) {
_json['secondaryWorkerConfig'] = secondaryWorkerConfig.toJson();
}
if (workerConfig != null) {
_json['workerConfig'] = workerConfig.toJson();
}
return _json;
}
}
/// Basic algorithm for autoscaling.
class BasicAutoscalingAlgorithm {
/// Duration between scaling events.
///
/// A scaling period starts after the update operation from the previous event
/// has completed.Bounds: 2m, 1d. Default: 2m.
///
/// Optional.
core.String cooldownPeriod;
/// YARN autoscaling configuration.
///
/// Required.
BasicYarnAutoscalingConfig yarnConfig;
BasicAutoscalingAlgorithm();
BasicAutoscalingAlgorithm.fromJson(core.Map _json) {
if (_json.containsKey('cooldownPeriod')) {
cooldownPeriod = _json['cooldownPeriod'] as core.String;
}
if (_json.containsKey('yarnConfig')) {
yarnConfig = BasicYarnAutoscalingConfig.fromJson(
_json['yarnConfig'] as core.Map<core.String, core.dynamic>);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (cooldownPeriod != null) {
_json['cooldownPeriod'] = cooldownPeriod;
}
if (yarnConfig != null) {
_json['yarnConfig'] = yarnConfig.toJson();
}
return _json;
}
}
/// Basic autoscaling configurations for YARN.
class BasicYarnAutoscalingConfig {
/// Timeout for YARN graceful decommissioning of Node Managers.
///
/// Specifies the duration to wait for jobs to complete before forcefully
/// removing workers (and potentially interrupting jobs). Only applicable to
/// downscaling operations.Bounds: 0s, 1d.
///
/// Required.
core.String gracefulDecommissionTimeout;
/// Fraction of average YARN pending memory in the last cooldown period for
/// which to remove workers.
///
/// A scale-down factor of 1 will result in scaling down so that there is no
/// available memory remaining after the update (more aggressive scaling). A
/// scale-down factor of 0 disables removing workers, which can be beneficial
/// for autoscaling a single job. See How autoscaling works
/// (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
/// for more information.Bounds: 0.0, 1.0.
///
/// Required.
core.double scaleDownFactor;
/// Minimum scale-down threshold as a fraction of total cluster size before
/// scaling occurs.
///
/// For example, in a 20-worker cluster, a threshold of 0.1 means the
/// autoscaler must recommend at least a 2 worker scale-down for the cluster
/// to scale. A threshold of 0 means the autoscaler will scale down on any
/// recommended change.Bounds: 0.0, 1.0. Default: 0.0.
///
/// Optional.
core.double scaleDownMinWorkerFraction;
/// Fraction of average YARN pending memory in the last cooldown period for
/// which to add workers.
///
/// A scale-up factor of 1.0 will result in scaling up so that there is no
/// pending memory remaining after the update (more aggressive scaling). A
/// scale-up factor closer to 0 will result in a smaller magnitude of scaling
/// up (less aggressive scaling). See How autoscaling works
/// (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works)
/// for more information.Bounds: 0.0, 1.0.
///
/// Required.
core.double scaleUpFactor;
/// Minimum scale-up threshold as a fraction of total cluster size before
/// scaling occurs.
///
/// For example, in a 20-worker cluster, a threshold of 0.1 means the
/// autoscaler must recommend at least a 2-worker scale-up for the cluster to
/// scale. A threshold of 0 means the autoscaler will scale up on any
/// recommended change.Bounds: 0.0, 1.0. Default: 0.0.
///
/// Optional.
core.double scaleUpMinWorkerFraction;
BasicYarnAutoscalingConfig();
BasicYarnAutoscalingConfig.fromJson(core.Map _json) {
if (_json.containsKey('gracefulDecommissionTimeout')) {
gracefulDecommissionTimeout =
_json['gracefulDecommissionTimeout'] as core.String;
}
if (_json.containsKey('scaleDownFactor')) {
scaleDownFactor = (_json['scaleDownFactor'] as core.num).toDouble();
}
if (_json.containsKey('scaleDownMinWorkerFraction')) {
scaleDownMinWorkerFraction =
(_json['scaleDownMinWorkerFraction'] as core.num).toDouble();
}
if (_json.containsKey('scaleUpFactor')) {
scaleUpFactor = (_json['scaleUpFactor'] as core.num).toDouble();
}
if (_json.containsKey('scaleUpMinWorkerFraction')) {
scaleUpMinWorkerFraction =
(_json['scaleUpMinWorkerFraction'] as core.num).toDouble();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (gracefulDecommissionTimeout != null) {
_json['gracefulDecommissionTimeout'] = gracefulDecommissionTimeout;
}
if (scaleDownFactor != null) {
_json['scaleDownFactor'] = scaleDownFactor;
}
if (scaleDownMinWorkerFraction != null) {
_json['scaleDownMinWorkerFraction'] = scaleDownMinWorkerFraction;
}
if (scaleUpFactor != null) {
_json['scaleUpFactor'] = scaleUpFactor;
}
if (scaleUpMinWorkerFraction != null) {
_json['scaleUpMinWorkerFraction'] = scaleUpMinWorkerFraction;
}
return _json;
}
}
/// Associates members with a role.
class Binding {
/// The condition that is associated with this binding.If the condition
/// evaluates to true, then this binding applies to the current request.If the
/// condition evaluates to false, then this binding does not apply to the
/// current request.
///
/// However, a different role binding might grant the same role to one or more
/// of the members in this binding.To learn which resources support conditions
/// in their IAM policies, see the IAM documentation
/// (https://cloud.google.com/iam/help/conditions/resource-policies).
Expr condition;
/// 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@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.
/// deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique
/// identifier) representing a user that has been recently deleted. For
/// example, alice@example.com?uid=123456789012345678901. If the user is
/// recovered, this value reverts to user:{emailid} and the recovered user
/// retains the role in the binding.
/// deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus
/// unique identifier) representing a service account that has been recently
/// deleted. For example,
/// my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the
/// service account is undeleted, this value reverts to
/// serviceAccount:{emailid} and the undeleted service account retains the
/// role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email
/// address (plus unique identifier) representing a Google group that has been
/// recently deleted. For example,
/// admins@example.com?uid=123456789012345678901. If the group is recovered,
/// this value reverts to group:{emailid} and the recovered group retains the
/// role in the binding. domain:{domain}: The G Suite domain (primary) that
/// represents all the users of that domain. For example, google.com or
/// example.com.
core.List<core.String> members;
/// Role that is assigned to members.
///
/// For example, roles/viewer, roles/editor, or roles/owner.
core.String role;
Binding();
Binding.fromJson(core.Map _json) {
if (_json.containsKey('condition')) {
condition = Expr.fromJson(
_json['condition'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('members')) {
members = (_json['members'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('role')) {
role = _json['role'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (condition != null) {
_json['condition'] = condition.toJson();
}
if (members != null) {
_json['members'] = members;
}
if (role != null) {
_json['role'] = role;
}
return _json;
}
}
/// A request to cancel a job.
class CancelJobRequest {
CancelJobRequest();
CancelJobRequest.fromJson(
// ignore: avoid_unused_constructor_parameters
core.Map _json);
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
return _json;
}
}
/// Describes the identifying information, config, and status of a cluster of
/// Compute Engine instances.
class Cluster {
/// The cluster name.
///
/// Cluster names within a project must be unique. Names of deleted clusters
/// can be reused.
///
/// Required.
core.String clusterName;
/// A cluster UUID (Unique Universal Identifier).
///
/// Dataproc generates this value when it creates the cluster.
///
/// Output only.
core.String clusterUuid;
/// The cluster config.
///
/// Note that Dataproc may set default values, and values may change when
/// clusters are updated.
///
/// Required.
ClusterConfig config;
/// 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.
///
/// Optional.
core.Map<core.String, core.String> labels;
/// 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.
///
/// Output only.
ClusterMetrics metrics;
/// The Google Cloud Platform project ID that the cluster belongs to.
///
/// Required.
core.String projectId;
/// Cluster status.
///
/// Output only.
ClusterStatus status;
/// The previous cluster status.
///
/// Output only.
core.List<ClusterStatus> statusHistory;
Cluster();
Cluster.fromJson(core.Map _json) {
if (_json.containsKey('clusterName')) {
clusterName = _json['clusterName'] as core.String;
}
if (_json.containsKey('clusterUuid')) {
clusterUuid = _json['clusterUuid'] as core.String;
}
if (_json.containsKey('config')) {
config = ClusterConfig.fromJson(
_json['config'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('labels')) {
labels =
(_json['labels'] as core.Map).cast<core.String, core.String>().map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('metrics')) {
metrics = ClusterMetrics.fromJson(
_json['metrics'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('projectId')) {
projectId = _json['projectId'] as core.String;
}
if (_json.containsKey('status')) {
status = ClusterStatus.fromJson(
_json['status'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('statusHistory')) {
statusHistory = (_json['statusHistory'] as core.List)
.map<ClusterStatus>((value) => ClusterStatus.fromJson(
value as core.Map<core.String, core.dynamic>))
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (clusterName != null) {
_json['clusterName'] = clusterName;
}
if (clusterUuid != null) {
_json['clusterUuid'] = clusterUuid;
}
if (config != null) {
_json['config'] = config.toJson();
}
if (labels != null) {
_json['labels'] = labels;
}
if (metrics != null) {
_json['metrics'] = metrics.toJson();
}
if (projectId != null) {
_json['projectId'] = projectId;
}
if (status != null) {
_json['status'] = status.toJson();
}
if (statusHistory != null) {
_json['statusHistory'] =
statusHistory.map((value) => value.toJson()).toList();
}
return _json;
}
}
/// The cluster config.
class ClusterConfig {
/// Autoscaling config for the policy associated with the cluster.
///
/// Cluster does not autoscale if this field is unset.
///
/// Optional.
AutoscalingConfig autoscalingConfig;
/// A Cloud Storage bucket used to stage job dependencies, config files, and
/// job driver console output.
///
/// If you do not specify a staging bucket, Cloud Dataproc will determine a
/// Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket
/// according to the Compute Engine zone where your cluster is deployed, and
/// then create and manage this project-level, per-location bucket (see
/// Dataproc staging bucket
/// (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
/// This field requires a Cloud Storage bucket name, not a URI to a Cloud
/// Storage bucket.
///
/// Optional.
core.String configBucket;
/// Encryption settings for the cluster.
///
/// Optional.
EncryptionConfig encryptionConfig;
/// Port/endpoint configuration for this cluster
///
/// Optional.
EndpointConfig endpointConfig;
/// The shared Compute Engine config settings for all instances in a cluster.
///
/// Optional.
GceClusterConfig gceClusterConfig;
/// 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
///
/// Optional.
core.List<NodeInitializationAction> initializationActions;
/// Lifecycle setting for the cluster.
///
/// Optional.
LifecycleConfig lifecycleConfig;
/// The Compute Engine config settings for the master instance in a cluster.
///
/// Optional.
InstanceGroupConfig masterConfig;
/// The Compute Engine config settings for additional worker instances in a
/// cluster.
///
/// Optional.
InstanceGroupConfig secondaryWorkerConfig;
/// Security settings for the cluster.
///
/// Optional.
SecurityConfig securityConfig;
/// The config settings for software inside the cluster.
///
/// Optional.
SoftwareConfig softwareConfig;
/// A Cloud Storage bucket used to store ephemeral cluster and jobs data, such
/// as Spark and MapReduce history files.
///
/// If you do not specify a temp bucket, Dataproc will determine a Cloud
/// Storage location (US, ASIA, or EU) for your cluster's temp bucket
/// according to the Compute Engine zone where your cluster is deployed, and
/// then create and manage this project-level, per-location bucket. The
/// default bucket has a TTL of 90 days, but you can use any TTL (or none) if
/// you specify a bucket. This field requires a Cloud Storage bucket name, not
/// a URI to a Cloud Storage bucket.
///
/// Optional.
core.String tempBucket;
/// The Compute Engine config settings for worker instances in a cluster.
///
/// Optional.
InstanceGroupConfig workerConfig;
ClusterConfig();
ClusterConfig.fromJson(core.Map _json) {
if (_json.containsKey('autoscalingConfig')) {
autoscalingConfig = AutoscalingConfig.fromJson(
_json['autoscalingConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('configBucket')) {
configBucket = _json['configBucket'] as core.String;
}
if (_json.containsKey('encryptionConfig')) {
encryptionConfig = EncryptionConfig.fromJson(
_json['encryptionConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('endpointConfig')) {
endpointConfig = EndpointConfig.fromJson(
_json['endpointConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('gceClusterConfig')) {
gceClusterConfig = GceClusterConfig.fromJson(
_json['gceClusterConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('initializationActions')) {
initializationActions = (_json['initializationActions'] as core.List)
.map<NodeInitializationAction>((value) =>
NodeInitializationAction.fromJson(
value as core.Map<core.String, core.dynamic>))
.toList();
}
if (_json.containsKey('lifecycleConfig')) {
lifecycleConfig = LifecycleConfig.fromJson(
_json['lifecycleConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('masterConfig')) {
masterConfig = InstanceGroupConfig.fromJson(
_json['masterConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('secondaryWorkerConfig')) {
secondaryWorkerConfig = InstanceGroupConfig.fromJson(
_json['secondaryWorkerConfig']
as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('securityConfig')) {
securityConfig = SecurityConfig.fromJson(
_json['securityConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('softwareConfig')) {
softwareConfig = SoftwareConfig.fromJson(
_json['softwareConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('tempBucket')) {
tempBucket = _json['tempBucket'] as core.String;
}
if (_json.containsKey('workerConfig')) {
workerConfig = InstanceGroupConfig.fromJson(
_json['workerConfig'] as core.Map<core.String, core.dynamic>);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (autoscalingConfig != null) {
_json['autoscalingConfig'] = autoscalingConfig.toJson();
}
if (configBucket != null) {
_json['configBucket'] = configBucket;
}
if (encryptionConfig != null) {
_json['encryptionConfig'] = encryptionConfig.toJson();
}
if (endpointConfig != null) {
_json['endpointConfig'] = endpointConfig.toJson();
}
if (gceClusterConfig != null) {
_json['gceClusterConfig'] = gceClusterConfig.toJson();
}
if (initializationActions != null) {
_json['initializationActions'] =
initializationActions.map((value) => value.toJson()).toList();
}
if (lifecycleConfig != null) {
_json['lifecycleConfig'] = lifecycleConfig.toJson();
}
if (masterConfig != null) {
_json['masterConfig'] = masterConfig.toJson();
}
if (secondaryWorkerConfig != null) {
_json['secondaryWorkerConfig'] = secondaryWorkerConfig.toJson();
}
if (securityConfig != null) {
_json['securityConfig'] = securityConfig.toJson();
}
if (softwareConfig != null) {
_json['softwareConfig'] = softwareConfig.toJson();
}
if (tempBucket != null) {
_json['tempBucket'] = tempBucket;
}
if (workerConfig != null) {
_json['workerConfig'] = workerConfig.toJson();
}
return _json;
}
}
/// 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.
class ClusterMetrics {
/// The HDFS metrics.
core.Map<core.String, core.String> hdfsMetrics;
/// The YARN metrics.
core.Map<core.String, core.String> yarnMetrics;
ClusterMetrics();
ClusterMetrics.fromJson(core.Map _json) {
if (_json.containsKey('hdfsMetrics')) {
hdfsMetrics = (_json['hdfsMetrics'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('yarnMetrics')) {
yarnMetrics = (_json['yarnMetrics'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (hdfsMetrics != null) {
_json['hdfsMetrics'] = hdfsMetrics;
}
if (yarnMetrics != null) {
_json['yarnMetrics'] = yarnMetrics;
}
return _json;
}
}
/// The cluster operation triggered by a workflow.
class ClusterOperation {
/// Indicates the operation is done.
///
/// Output only.
core.bool done;
/// Error, if operation failed.
///
/// Output only.
core.String error;
/// The id of the cluster operation.
///
/// Output only.
core.String operationId;
ClusterOperation();
ClusterOperation.fromJson(core.Map _json) {
if (_json.containsKey('done')) {
done = _json['done'] as core.bool;
}
if (_json.containsKey('error')) {
error = _json['error'] as core.String;
}
if (_json.containsKey('operationId')) {
operationId = _json['operationId'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (done != null) {
_json['done'] = done;
}
if (error != null) {
_json['error'] = error;
}
if (operationId != null) {
_json['operationId'] = operationId;
}
return _json;
}
}
/// Metadata describing the operation.
class ClusterOperationMetadata {
/// Name of the cluster for the operation.
///
/// Output only.
core.String clusterName;
/// Cluster UUID for the operation.
///
/// Output only.
core.String clusterUuid;
/// Short description of operation.
///
/// Output only.
core.String description;
/// Labels associated with the operation
///
/// Output only.
core.Map<core.String, core.String> labels;
/// The operation type.
///
/// Output only.
core.String operationType;
/// Current operation status.
///
/// Output only.
ClusterOperationStatus status;
/// The previous operation status.
///
/// Output only.
core.List<ClusterOperationStatus> statusHistory;
/// Errors encountered during operation execution.
///
/// Output only.
core.List<core.String> warnings;
ClusterOperationMetadata();
ClusterOperationMetadata.fromJson(core.Map _json) {
if (_json.containsKey('clusterName')) {
clusterName = _json['clusterName'] as core.String;
}
if (_json.containsKey('clusterUuid')) {
clusterUuid = _json['clusterUuid'] as core.String;
}
if (_json.containsKey('description')) {
description = _json['description'] as core.String;
}
if (_json.containsKey('labels')) {
labels =
(_json['labels'] as core.Map).cast<core.String, core.String>().map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('operationType')) {
operationType = _json['operationType'] as core.String;
}
if (_json.containsKey('status')) {
status = ClusterOperationStatus.fromJson(
_json['status'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('statusHistory')) {
statusHistory = (_json['statusHistory'] as core.List)
.map<ClusterOperationStatus>((value) =>
ClusterOperationStatus.fromJson(
value as core.Map<core.String, core.dynamic>))
.toList();
}
if (_json.containsKey('warnings')) {
warnings = (_json['warnings'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (clusterName != null) {
_json['clusterName'] = clusterName;
}
if (clusterUuid != null) {
_json['clusterUuid'] = clusterUuid;
}
if (description != null) {
_json['description'] = description;
}
if (labels != null) {
_json['labels'] = labels;
}
if (operationType != null) {
_json['operationType'] = operationType;
}
if (status != null) {
_json['status'] = status.toJson();
}
if (statusHistory != null) {
_json['statusHistory'] =
statusHistory.map((value) => value.toJson()).toList();
}
if (warnings != null) {
_json['warnings'] = warnings;
}
return _json;
}
}
/// The status of the operation.
class ClusterOperationStatus {
/// A message containing any operation metadata details.
///
/// Output only.
core.String details;
/// A message containing the detailed operation state.
///
/// Output only.
core.String innerState;
/// A message containing the operation state.
///
/// Output only.
/// Possible string values are:
/// - "UNKNOWN" : Unused.
/// - "PENDING" : The operation has been created.
/// - "RUNNING" : The operation is running.
/// - "DONE" : The operation is done; either cancelled or completed.
core.String state;
/// The time this state was entered.
///
/// Output only.
core.String stateStartTime;
ClusterOperationStatus();
ClusterOperationStatus.fromJson(core.Map _json) {
if (_json.containsKey('details')) {
details = _json['details'] as core.String;
}
if (_json.containsKey('innerState')) {
innerState = _json['innerState'] as core.String;
}
if (_json.containsKey('state')) {
state = _json['state'] as core.String;
}
if (_json.containsKey('stateStartTime')) {
stateStartTime = _json['stateStartTime'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (details != null) {
_json['details'] = details;
}
if (innerState != null) {
_json['innerState'] = innerState;
}
if (state != null) {
_json['state'] = state;
}
if (stateStartTime != null) {
_json['stateStartTime'] = stateStartTime;
}
return _json;
}
}
/// A selector that chooses target cluster for jobs based on metadata.
class ClusterSelector {
/// The cluster labels.
///
/// Cluster must have all labels to match.
///
/// Required.
core.Map<core.String, core.String> clusterLabels;
/// The zone where workflow process executes.
///
/// This parameter does not affect the selection of the cluster.If
/// unspecified, the zone of the first cluster matching the selector is used.
///
/// Optional.
core.String zone;
ClusterSelector();
ClusterSelector.fromJson(core.Map _json) {
if (_json.containsKey('clusterLabels')) {
clusterLabels = (_json['clusterLabels'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('zone')) {
zone = _json['zone'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (clusterLabels != null) {
_json['clusterLabels'] = clusterLabels;
}
if (zone != null) {
_json['zone'] = zone;
}
return _json;
}
}
/// The status of a cluster and its instances.
class ClusterStatus {
/// Details of cluster's state.
///
/// Optional. Output only.
core.String detail;
/// The cluster's state.
///
/// Output only.
/// Possible string values are:
/// - "UNKNOWN" : The cluster state is unknown.
/// - "CREATING" : The cluster is being created and set up. It is not ready
/// for use.
/// - "RUNNING" : The cluster is currently running and healthy. It is ready
/// for use.
/// - "ERROR" : The cluster encountered an error. It is not ready for use.
/// - "DELETING" : The cluster is being deleted. It cannot be used.
/// - "UPDATING" : The cluster is being updated. It continues to accept and
/// process jobs.
core.String state;
/// Time when this state was entered (see JSON representation of Timestamp
/// (https://developers.google.com/protocol-buffers/docs/proto3#json)).
///
/// Output only.
core.String stateStartTime;
/// Additional state information that includes status reported by the agent.
///
/// Output only.
/// Possible string values are:
/// - "UNSPECIFIED" : The cluster substate is unknown.
/// - "UNHEALTHY" : The cluster is known to be in an unhealthy state (for
/// example, critical daemons are not running or HDFS capacity is
/// exhausted).Applies to RUNNING state.
/// - "STALE_STATUS" : The agent-reported status is out of date (may occur if
/// Dataproc loses communication with Agent).Applies to RUNNING state.
core.String substate;
ClusterStatus();
ClusterStatus.fromJson(core.Map _json) {
if (_json.containsKey('detail')) {
detail = _json['detail'] as core.String;
}
if (_json.containsKey('state')) {
state = _json['state'] as core.String;
}
if (_json.containsKey('stateStartTime')) {
stateStartTime = _json['stateStartTime'] as core.String;
}
if (_json.containsKey('substate')) {
substate = _json['substate'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (detail != null) {
_json['detail'] = detail;
}
if (state != null) {
_json['state'] = state;
}
if (stateStartTime != null) {
_json['stateStartTime'] = stateStartTime;
}
if (substate != null) {
_json['substate'] = substate;
}
return _json;
}
}
/// A request to collect cluster diagnostic information.
class DiagnoseClusterRequest {
DiagnoseClusterRequest();
DiagnoseClusterRequest.fromJson(
// ignore: avoid_unused_constructor_parameters
core.Map _json);
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
return _json;
}
}
/// The location of diagnostic output.
class DiagnoseClusterResults {
/// The Cloud Storage URI of the diagnostic output.
///
/// The output report is a plain text file with a summary of collected
/// diagnostics.
///
/// Output only.
core.String outputUri;
DiagnoseClusterResults();
DiagnoseClusterResults.fromJson(core.Map _json) {
if (_json.containsKey('outputUri')) {
outputUri = _json['outputUri'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (outputUri != null) {
_json['outputUri'] = outputUri;
}
return _json;
}
}
/// Specifies the config of disk options for a group of VM instances.
class DiskConfig {
/// Size in GB of the boot disk (default is 500GB).
///
/// Optional.
core.int bootDiskSizeGb;
/// Type of the boot disk (default is "pd-standard").
///
/// Valid values: "pd-balanced" (Persistent Disk Balanced Solid State Drive),
/// "pd-ssd" (Persistent Disk Solid State Drive), or "pd-standard" (Persistent
/// Disk Hard Disk Drive). See Disk types
/// (https://cloud.google.com/compute/docs/disks#disk-types).
///
/// Optional.
core.String bootDiskType;
/// 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.
///
/// Optional.
core.int numLocalSsds;
DiskConfig();
DiskConfig.fromJson(core.Map _json) {
if (_json.containsKey('bootDiskSizeGb')) {
bootDiskSizeGb = _json['bootDiskSizeGb'] as core.int;
}
if (_json.containsKey('bootDiskType')) {
bootDiskType = _json['bootDiskType'] as core.String;
}
if (_json.containsKey('numLocalSsds')) {
numLocalSsds = _json['numLocalSsds'] as core.int;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (bootDiskSizeGb != null) {
_json['bootDiskSizeGb'] = bootDiskSizeGb;
}
if (bootDiskType != null) {
_json['bootDiskType'] = bootDiskType;
}
if (numLocalSsds != null) {
_json['numLocalSsds'] = numLocalSsds;
}
return _json;
}
}
/// 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 {}.
class Empty {
Empty();
Empty.fromJson(
// ignore: avoid_unused_constructor_parameters
core.Map _json);
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
return _json;
}
}
/// Encryption settings for the cluster.
class EncryptionConfig {
/// The Cloud KMS key name to use for PD disk encryption for all instances in
/// the cluster.
///
/// Optional.
core.String gcePdKmsKeyName;
EncryptionConfig();
EncryptionConfig.fromJson(core.Map _json) {
if (_json.containsKey('gcePdKmsKeyName')) {
gcePdKmsKeyName = _json['gcePdKmsKeyName'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (gcePdKmsKeyName != null) {
_json['gcePdKmsKeyName'] = gcePdKmsKeyName;
}
return _json;
}
}
/// Endpoint config for this cluster
class EndpointConfig {
/// If true, enable http access to specific ports on the cluster from external
/// sources.
///
/// Defaults to false.
///
/// Optional.
core.bool enableHttpPortAccess;
/// The map of port descriptions to URLs.
///
/// Will only be populated if enable_http_port_access is true.
///
/// Output only.
core.Map<core.String, core.String> httpPorts;
EndpointConfig();
EndpointConfig.fromJson(core.Map _json) {
if (_json.containsKey('enableHttpPortAccess')) {
enableHttpPortAccess = _json['enableHttpPortAccess'] as core.bool;
}
if (_json.containsKey('httpPorts')) {
httpPorts =
(_json['httpPorts'] as core.Map).cast<core.String, core.String>().map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (enableHttpPortAccess != null) {
_json['enableHttpPortAccess'] = enableHttpPortAccess;
}
if (httpPorts != null) {
_json['httpPorts'] = httpPorts;
}
return _json;
}
}
/// Represents a textual expression in the Common Expression Language (CEL)
/// syntax.
///
/// CEL is a C-like expression language. The syntax and semantics of CEL are
/// documented at https://github.com/google/cel-spec.Example (Comparison):
/// title: "Summary size limit" description: "Determines if a summary is less
/// than 100 chars" expression: "document.summary.size() < 100" Example
/// (Equality): title: "Requestor is owner" description: "Determines if
/// requestor is the document owner" expression: "document.owner ==
/// request.auth.claims.email" Example (Logic): title: "Public documents"
/// description: "Determine whether the document should be publicly visible"
/// expression: "document.type != 'private' && document.type != 'internal'"
/// Example (Data Manipulation): title: "Notification string" description:
/// "Create a notification string with a timestamp." expression: "'New message
/// received at ' + string(document.create_time)" The exact variables and
/// functions that may be referenced within an expression are determined by the
/// service that evaluates it. See the service documentation for additional
/// information.
class Expr {
/// Description of the expression.
///
/// This is a longer text which describes the expression, e.g. when hovered
/// over it in a UI.
///
/// Optional.
core.String description;
/// Textual representation of an expression in Common Expression Language
/// syntax.
core.String expression;
/// String indicating the location of the expression for error reporting, e.g.
/// a file name and a position in the file.
///
/// Optional.
core.String location;
/// Title for the expression, i.e. a short string describing its purpose.
///
/// This can be used e.g. in UIs which allow to enter the expression.
///
/// Optional.
core.String title;
Expr();
Expr.fromJson(core.Map _json) {
if (_json.containsKey('description')) {
description = _json['description'] as core.String;
}
if (_json.containsKey('expression')) {
expression = _json['expression'] as core.String;
}
if (_json.containsKey('location')) {
location = _json['location'] as core.String;
}
if (_json.containsKey('title')) {
title = _json['title'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (description != null) {
_json['description'] = description;
}
if (expression != null) {
_json['expression'] = expression;
}
if (location != null) {
_json['location'] = location;
}
if (title != null) {
_json['title'] = title;
}
return _json;
}
}
/// Common config settings for resources of Compute Engine cluster instances,
/// applicable to all instances in the cluster.
class GceClusterConfig {
/// 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.
///
/// Optional.
core.bool internalIpOnly;
/// 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)).
core.Map<core.String, core.String> metadata;
/// 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
/// (https://cloud.google.com/compute/docs/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
///
/// Optional.
core.String networkUri;
/// Node Group Affinity for sole-tenant clusters.
///
/// Optional.
NodeGroupAffinity nodeGroupAffinity;
/// The type of IPv6 access for a cluster.
///
/// Optional.
/// Possible string values are:
/// - "PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED" : If unspecified, Compute
/// Engine default behavior will apply, which is the same as
/// INHERIT_FROM_SUBNETWORK.
/// - "INHERIT_FROM_SUBNETWORK" : Private access to and from Google Services
/// configuration inherited from the subnetwork configuration. This is the
/// default Compute Engine behavior.
/// - "OUTBOUND" : Enables outbound private IPv6 access to Google Services
/// from the Dataproc cluster.
/// - "BIDIRECTIONAL" : Enables bidirectional private IPv6 access between
/// Google Services and the Dataproc cluster.
core.String privateIpv6GoogleAccess;
/// Reservation Affinity for consuming Zonal reservation.
///
/// Optional.
ReservationAffinity reservationAffinity;
/// The Dataproc service account
/// (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc)
/// (also see VM Data Plane identity
/// (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity))
/// used by Dataproc cluster VM instances to access Google Cloud Platform
/// services.If not specified, the Compute Engine default service account
/// (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
/// is used.
///
/// Optional.
core.String serviceAccount;
/// 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
///
/// Optional.
core.List<core.String> serviceAccountScopes;
/// Shielded Instance Config for clusters using Compute Engine Shielded VMs
/// (https://cloud.google.com/security/shielded-cloud/shielded-vm).
///
/// Optional.
ShieldedInstanceConfig shieldedInstanceConfig;
/// 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/subnetworks/sub0
/// projects/\[project_id\]/regions/us-east1/subnetworks/sub0 sub0
///
/// Optional.
core.String subnetworkUri;
/// The Compute Engine tags to add to all instances (see Tagging instances
/// (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
core.List<core.String> tags;
/// 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 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
///
/// Optional.
core.String zoneUri;
GceClusterConfig();
GceClusterConfig.fromJson(core.Map _json) {
if (_json.containsKey('internalIpOnly')) {
internalIpOnly = _json['internalIpOnly'] as core.bool;
}
if (_json.containsKey('metadata')) {
metadata =
(_json['metadata'] as core.Map).cast<core.String, core.String>().map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('networkUri')) {
networkUri = _json['networkUri'] as core.String;
}
if (_json.containsKey('nodeGroupAffinity')) {
nodeGroupAffinity = NodeGroupAffinity.fromJson(
_json['nodeGroupAffinity'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('privateIpv6GoogleAccess')) {
privateIpv6GoogleAccess = _json['privateIpv6GoogleAccess'] as core.String;
}
if (_json.containsKey('reservationAffinity')) {
reservationAffinity = ReservationAffinity.fromJson(
_json['reservationAffinity'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('serviceAccount')) {
serviceAccount = _json['serviceAccount'] as core.String;
}
if (_json.containsKey('serviceAccountScopes')) {
serviceAccountScopes = (_json['serviceAccountScopes'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('shieldedInstanceConfig')) {
shieldedInstanceConfig = ShieldedInstanceConfig.fromJson(
_json['shieldedInstanceConfig']
as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('subnetworkUri')) {
subnetworkUri = _json['subnetworkUri'] as core.String;
}
if (_json.containsKey('tags')) {
tags = (_json['tags'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('zoneUri')) {
zoneUri = _json['zoneUri'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (internalIpOnly != null) {
_json['internalIpOnly'] = internalIpOnly;
}
if (metadata != null) {
_json['metadata'] = metadata;
}
if (networkUri != null) {
_json['networkUri'] = networkUri;
}
if (nodeGroupAffinity != null) {
_json['nodeGroupAffinity'] = nodeGroupAffinity.toJson();
}
if (privateIpv6GoogleAccess != null) {
_json['privateIpv6GoogleAccess'] = privateIpv6GoogleAccess;
}
if (reservationAffinity != null) {
_json['reservationAffinity'] = reservationAffinity.toJson();
}
if (serviceAccount != null) {
_json['serviceAccount'] = serviceAccount;
}
if (serviceAccountScopes != null) {
_json['serviceAccountScopes'] = serviceAccountScopes;
}
if (shieldedInstanceConfig != null) {
_json['shieldedInstanceConfig'] = shieldedInstanceConfig.toJson();
}
if (subnetworkUri != null) {
_json['subnetworkUri'] = subnetworkUri;
}
if (tags != null) {
_json['tags'] = tags;
}
if (zoneUri != null) {
_json['zoneUri'] = zoneUri;
}
return _json;
}
}
/// Request message for GetIamPolicy method.
class GetIamPolicyRequest {
/// OPTIONAL: A GetPolicyOptions object for specifying options to
/// GetIamPolicy.
GetPolicyOptions options;
GetIamPolicyRequest();
GetIamPolicyRequest.fromJson(core.Map _json) {
if (_json.containsKey('options')) {
options = GetPolicyOptions.fromJson(
_json['options'] as core.Map<core.String, core.dynamic>);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (options != null) {
_json['options'] = options.toJson();
}
return _json;
}
}
/// Encapsulates settings provided to GetIamPolicy.
class GetPolicyOptions {
/// The policy format version to be returned.Valid values are 0, 1, and 3.
///
/// Requests specifying an invalid value will be rejected.Requests for
/// policies with any conditional bindings must specify version 3. Policies
/// without any conditional bindings may specify any valid value or leave the
/// field unset.To learn which resources support conditions in their IAM
/// policies, see the IAM documentation
/// (https://cloud.google.com/iam/help/conditions/resource-policies).
///
/// Optional.
core.int requestedPolicyVersion;
GetPolicyOptions();
GetPolicyOptions.fromJson(core.Map _json) {
if (_json.containsKey('requestedPolicyVersion')) {
requestedPolicyVersion = _json['requestedPolicyVersion'] as core.int;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (requestedPolicyVersion != null) {
_json['requestedPolicyVersion'] = requestedPolicyVersion;
}
return _json;
}
}
/// A 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).
class HadoopJob {
/// 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.
///
/// Optional.
core.List<core.String> archiveUris;
/// 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.
///
/// Optional.
core.List<core.String> args;
/// 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.
///
/// Optional.
core.List<core.String> fileUris;
/// Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
///
/// Optional.
core.List<core.String> jarFileUris;
/// The runtime log config for job execution.
///
/// Optional.
LoggingConfig 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.
core.String mainClass;
/// 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'
core.String mainJarFileUri;
/// A mapping of property names to values, used to configure Hadoop.
///
/// Properties that conflict with values set by the Dataproc API may be
/// overwritten. Can include properties set in /etc/hadoop/conf / * -site and
/// classes in user code.
///
/// Optional.
core.Map<core.String, core.String> properties;
HadoopJob();
HadoopJob.fromJson(core.Map _json) {
if (_json.containsKey('archiveUris')) {
archiveUris = (_json['archiveUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('args')) {
args = (_json['args'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('fileUris')) {
fileUris = (_json['fileUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('jarFileUris')) {
jarFileUris = (_json['jarFileUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('loggingConfig')) {
loggingConfig = LoggingConfig.fromJson(
_json['loggingConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('mainClass')) {
mainClass = _json['mainClass'] as core.String;
}
if (_json.containsKey('mainJarFileUri')) {
mainJarFileUri = _json['mainJarFileUri'] as core.String;
}
if (_json.containsKey('properties')) {
properties = (_json['properties'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (archiveUris != null) {
_json['archiveUris'] = archiveUris;
}
if (args != null) {
_json['args'] = args;
}
if (fileUris != null) {
_json['fileUris'] = fileUris;
}
if (jarFileUris != null) {
_json['jarFileUris'] = jarFileUris;
}
if (loggingConfig != null) {
_json['loggingConfig'] = loggingConfig.toJson();
}
if (mainClass != null) {
_json['mainClass'] = mainClass;
}
if (mainJarFileUri != null) {
_json['mainJarFileUri'] = mainJarFileUri;
}
if (properties != null) {
_json['properties'] = properties;
}
return _json;
}
}
/// A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on
/// YARN.
class HiveJob {
/// 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.
///
/// Optional.
core.bool continueOnFailure;
/// 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.
///
/// Optional.
core.List<core.String> jarFileUris;
/// A mapping of property names and values, used to configure Hive.
///
/// Properties that conflict with values set by the 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.
///
/// Optional.
core.Map<core.String, core.String> properties;
/// The HCFS URI of the script that contains Hive queries.
core.String queryFileUri;
/// A list of queries.
QueryList queryList;
/// Mapping of query variable names to values (equivalent to the Hive command:
/// SET name="value";).
///
/// Optional.
core.Map<core.String, core.String> scriptVariables;
HiveJob();
HiveJob.fromJson(core.Map _json) {
if (_json.containsKey('continueOnFailure')) {
continueOnFailure = _json['continueOnFailure'] as core.bool;
}
if (_json.containsKey('jarFileUris')) {
jarFileUris = (_json['jarFileUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('properties')) {
properties = (_json['properties'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('queryFileUri')) {
queryFileUri = _json['queryFileUri'] as core.String;
}
if (_json.containsKey('queryList')) {
queryList = QueryList.fromJson(
_json['queryList'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('scriptVariables')) {
scriptVariables = (_json['scriptVariables'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (continueOnFailure != null) {
_json['continueOnFailure'] = continueOnFailure;
}
if (jarFileUris != null) {
_json['jarFileUris'] = jarFileUris;
}
if (properties != null) {
_json['properties'] = properties;
}
if (queryFileUri != null) {
_json['queryFileUri'] = queryFileUri;
}
if (queryList != null) {
_json['queryList'] = queryList.toJson();
}
if (scriptVariables != null) {
_json['scriptVariables'] = scriptVariables;
}
return _json;
}
}
/// A request to inject credentials into a cluster.
class InjectCredentialsRequest {
/// The cluster UUID.
///
/// Required.
core.String clusterUuid;
/// The encrypted credentials being injected in to the cluster.The client is
/// responsible for encrypting the credentials in a way that is supported by
/// the cluster.A wrapped value is used here so that the actual contents of
/// the encrypted credentials are not written to audit logs.
///
/// Required.
core.String credentialsCiphertext;
InjectCredentialsRequest();
InjectCredentialsRequest.fromJson(core.Map _json) {
if (_json.containsKey('clusterUuid')) {
clusterUuid = _json['clusterUuid'] as core.String;
}
if (_json.containsKey('credentialsCiphertext')) {
credentialsCiphertext = _json['credentialsCiphertext'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (clusterUuid != null) {
_json['clusterUuid'] = clusterUuid;
}
if (credentialsCiphertext != null) {
_json['credentialsCiphertext'] = credentialsCiphertext;
}
return _json;
}
}
/// Configuration for the size bounds of an instance group, including its
/// proportional size to other groups.
class InstanceGroupAutoscalingPolicyConfig {
/// Maximum number of instances for this group.
///
/// Required for primary workers. Note that by default, clusters will not use
/// secondary workers. Required for secondary workers if the minimum secondary
/// instances is set.Primary workers - Bounds: \[min_instances, ). Secondary
/// workers - Bounds: \[min_instances, ). Default: 0.
///
/// Required.
core.int maxInstances;
/// Minimum number of instances for this group.Primary workers - Bounds: 2,
/// max_instances.
///
/// Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
///
/// Optional.
core.int minInstances;
/// Weight for the instance group, which is used to determine the fraction of
/// total workers in the cluster from this instance group.
///
/// For example, if primary workers have weight 2, and secondary workers have
/// weight 1, the cluster will have approximately 2 primary workers for each
/// secondary worker.The cluster may not reach the specified balance if
/// constrained by min/max bounds or other autoscaling settings. For example,
/// if max_instances for secondary workers is 0, then only primary workers
/// will be added. The cluster can also be out of balance when created.If
/// weight is not set on any instance group, the cluster will default to equal
/// weight for all groups: the cluster will attempt to maintain an equal
/// number of workers in each group within the configured size bounds for each
/// group. If weight is set for one group only, the cluster will default to
/// zero weight on the unset group. For example if weight is set only on
/// primary workers, the cluster will use primary workers only and no
/// secondary workers.
///
/// Optional.
core.int weight;
InstanceGroupAutoscalingPolicyConfig();
InstanceGroupAutoscalingPolicyConfig.fromJson(core.Map _json) {
if (_json.containsKey('maxInstances')) {
maxInstances = _json['maxInstances'] as core.int;
}
if (_json.containsKey('minInstances')) {
minInstances = _json['minInstances'] as core.int;
}
if (_json.containsKey('weight')) {
weight = _json['weight'] as core.int;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (maxInstances != null) {
_json['maxInstances'] = maxInstances;
}
if (minInstances != null) {
_json['minInstances'] = minInstances;
}
if (weight != null) {
_json['weight'] = weight;
}
return _json;
}
}
/// The config settings for Compute Engine resources in an instance group, such
/// as a master or worker group.
class InstanceGroupConfig {
/// The Compute Engine accelerator configuration for these instances.
///
/// Optional.
core.List<AcceleratorConfig> accelerators;
/// Disk option config settings.
///
/// Optional.
DiskConfig diskConfig;
/// The Compute Engine image resource used for cluster instances.The URI can
/// represent an image or image family.Image examples:
/// https://www.googleapis.com/compute/beta/projects/\[project_id\]/global/images/\[image-id\]
/// projects/\[project_id\]/global/images/\[image-id\] image-idImage family
/// examples.
///
/// Dataproc will use the most recent image from the family:
/// https://www.googleapis.com/compute/beta/projects/\[project_id\]/global/images/family/\[custom-image-family-name\]
/// projects/\[project_id\]/global/images/family/\[custom-image-family-name\]If
/// the URI is unspecified, it will be inferred from
/// SoftwareConfig.image_version or the system default.
///
/// Optional.
core.String imageUri;
/// The list of instance names.
///
/// Dataproc derives the names from cluster_name, num_instances, and the
/// instance group.
///
/// Output only.
core.List<core.String> instanceNames;
/// List of references to Compute Engine instances.
///
/// Output only.
core.List<InstanceReference> instanceReferences;
/// Specifies that this instance group contains preemptible instances.
///
/// Output only.
core.bool isPreemptible;
/// 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 Dataproc Auto Zone
/// Placement
/// (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
/// feature, you must use the short name of the machine type resource, for
/// example, n1-standard-2.
///
/// Optional.
core.String machineTypeUri;
/// The config for Compute Engine Instance Group Manager that manages this
/// group.
///
/// This is only used for preemptible instance groups.
///
/// Output only.
ManagedGroupConfig managedGroupConfig;
/// Specifies the minimum cpu platform for the Instance Group.
///
/// See Dataproc -> Minimum CPU Platform
/// (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
///
/// Optional.
core.String minCpuPlatform;
/// The number of VM instances in the instance group.
///
/// For master instance groups, must be set to 1.
///
/// Optional.
core.int numInstances;
/// Specifies the preemptibility of the instance group.The default value for
/// master and worker groups is NON_PREEMPTIBLE.
///
/// This default cannot be changed.The default value for secondary instances
/// is PREEMPTIBLE.
///
/// Optional.
/// Possible string values are:
/// - "PREEMPTIBILITY_UNSPECIFIED" : Preemptibility is unspecified, the system
/// will choose the appropriate setting for each instance group.
/// - "NON_PREEMPTIBLE" : Instances are non-preemptible.This option is allowed
/// for all instance groups and is the only valid value for Master and Worker
/// instance groups.
/// - "PREEMPTIBLE" : Instances are preemptible.This option is allowed only
/// for secondary worker groups.
core.String preemptibility;
InstanceGroupConfig();
InstanceGroupConfig.fromJson(core.Map _json) {
if (_json.containsKey('accelerators')) {
accelerators = (_json['accelerators'] as core.List)
.map<AcceleratorConfig>((value) => AcceleratorConfig.fromJson(
value as core.Map<core.String, core.dynamic>))
.toList();
}
if (_json.containsKey('diskConfig')) {
diskConfig = DiskConfig.fromJson(
_json['diskConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('imageUri')) {
imageUri = _json['imageUri'] as core.String;
}
if (_json.containsKey('instanceNames')) {
instanceNames = (_json['instanceNames'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('instanceReferences')) {
instanceReferences = (_json['instanceReferences'] as core.List)
.map<InstanceReference>((value) => InstanceReference.fromJson(
value as core.Map<core.String, core.dynamic>))
.toList();
}
if (_json.containsKey('isPreemptible')) {
isPreemptible = _json['isPreemptible'] as core.bool;
}
if (_json.containsKey('machineTypeUri')) {
machineTypeUri = _json['machineTypeUri'] as core.String;
}
if (_json.containsKey('managedGroupConfig')) {
managedGroupConfig = ManagedGroupConfig.fromJson(
_json['managedGroupConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('minCpuPlatform')) {
minCpuPlatform = _json['minCpuPlatform'] as core.String;
}
if (_json.containsKey('numInstances')) {
numInstances = _json['numInstances'] as core.int;
}
if (_json.containsKey('preemptibility')) {
preemptibility = _json['preemptibility'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (accelerators != null) {
_json['accelerators'] =
accelerators.map((value) => value.toJson()).toList();
}
if (diskConfig != null) {
_json['diskConfig'] = diskConfig.toJson();
}
if (imageUri != null) {
_json['imageUri'] = imageUri;
}
if (instanceNames != null) {
_json['instanceNames'] = instanceNames;
}
if (instanceReferences != null) {
_json['instanceReferences'] =
instanceReferences.map((value) => value.toJson()).toList();
}
if (isPreemptible != null) {
_json['isPreemptible'] = isPreemptible;
}
if (machineTypeUri != null) {
_json['machineTypeUri'] = machineTypeUri;
}
if (managedGroupConfig != null) {
_json['managedGroupConfig'] = managedGroupConfig.toJson();
}
if (minCpuPlatform != null) {
_json['minCpuPlatform'] = minCpuPlatform;
}
if (numInstances != null) {
_json['numInstances'] = numInstances;
}
if (preemptibility != null) {
_json['preemptibility'] = preemptibility;
}
return _json;
}
}
/// A reference to a Compute Engine instance.
class InstanceReference {
/// The unique identifier of the Compute Engine instance.
core.String instanceId;
/// The user-friendly name of the Compute Engine instance.
core.String instanceName;
/// The public key used for sharing data with this instance.
core.String publicKey;
InstanceReference();
InstanceReference.fromJson(core.Map _json) {
if (_json.containsKey('instanceId')) {
instanceId = _json['instanceId'] as core.String;
}
if (_json.containsKey('instanceName')) {
instanceName = _json['instanceName'] as core.String;
}
if (_json.containsKey('publicKey')) {
publicKey = _json['publicKey'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (instanceId != null) {
_json['instanceId'] = instanceId;
}
if (instanceName != null) {
_json['instanceName'] = instanceName;
}
if (publicKey != null) {
_json['publicKey'] = publicKey;
}
return _json;
}
}
/// A request to instantiate a workflow template.
class InstantiateWorkflowTemplateRequest {
/// Map from parameter names to values that should be used for those
/// parameters.
///
/// Values may not exceed 1000 characters.
///
/// Optional.
core.Map<core.String, core.String> parameters;
/// A tag that prevents multiple concurrent workflow instances with the same
/// tag from running.
///
/// This mitigates risk of concurrent instances started due to retries.It is
/// recommended to always set this value to a UUID
/// (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must
/// contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and
/// hyphens (-). The maximum length is 40 characters.
///
/// Optional.
core.String requestId;
/// The version of workflow template to instantiate.
///
/// If specified, the workflow will be instantiated only if the current
/// version of the workflow template has the supplied version.This option
/// cannot be used to instantiate a previous version of workflow template.
///
/// Optional.
core.int version;
InstantiateWorkflowTemplateRequest();
InstantiateWorkflowTemplateRequest.fromJson(core.Map _json) {
if (_json.containsKey('parameters')) {
parameters = (_json['parameters'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('requestId')) {
requestId = _json['requestId'] as core.String;
}
if (_json.containsKey('version')) {
version = _json['version'] as core.int;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (parameters != null) {
_json['parameters'] = parameters;
}
if (requestId != null) {
_json['requestId'] = requestId;
}
if (version != null) {
_json['version'] = version;
}
return _json;
}
}
/// A Dataproc job resource.
class Job {
/// Indicates whether the job is completed.
///
/// If the value is false, the job is still in progress. If true, the job is
/// completed, and status.state field will indicate if it was successful,
/// failed, or cancelled.
///
/// Output only.
core.bool done;
/// 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.
///
/// Output only.
core.String driverControlFilesUri;
/// A URI pointing to the location of the stdout of the job's driver program.
///
/// Output only.
core.String driverOutputResourceUri;
/// Job is a Hadoop job.
///
/// Optional.
HadoopJob hadoopJob;
/// Job is a Hive job.
///
/// Optional.
HiveJob hiveJob;
/// A UUID that uniquely identifies a job within the project over time.
///
/// This is in contrast to a user-settable reference.job_id that may be reused
/// over time.
///
/// Output only.
core.String jobUuid;
/// 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.
///
/// Optional.
core.Map<core.String, core.String> labels;
/// Job is a Pig job.
///
/// Optional.
PigJob pigJob;
/// Job information, including how, when, and where to run the job.
///
/// Required.
JobPlacement placement;
/// Job is a Presto job.
///
/// Optional.
PrestoJob prestoJob;
/// Job is a PySpark job.
///
/// Optional.
PySparkJob pysparkJob;
/// 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 job_id.
///
/// Optional.
JobReference reference;
/// Job scheduling configuration.
///
/// Optional.
JobScheduling scheduling;
/// Job is a Spark job.
///
/// Optional.
SparkJob sparkJob;
/// Job is a SparkR job.
///
/// Optional.
SparkRJob sparkRJob;
/// Job is a SparkSql job.
///
/// Optional.
SparkSqlJob sparkSqlJob;
/// The job status.
///
/// Additional application-specific status information may be contained in the
/// type_job and yarn_applications fields.
///
/// Output only.
JobStatus status;
/// The previous job status.
///
/// Output only.
core.List<JobStatus> statusHistory;
/// 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.
///
/// Output only.
core.List<YarnApplication> yarnApplications;
Job();
Job.fromJson(core.Map _json) {
if (_json.containsKey('done')) {
done = _json['done'] as core.bool;
}
if (_json.containsKey('driverControlFilesUri')) {
driverControlFilesUri = _json['driverControlFilesUri'] as core.String;
}
if (_json.containsKey('driverOutputResourceUri')) {
driverOutputResourceUri = _json['driverOutputResourceUri'] as core.String;
}
if (_json.containsKey('hadoopJob')) {
hadoopJob = HadoopJob.fromJson(
_json['hadoopJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('hiveJob')) {
hiveJob = HiveJob.fromJson(
_json['hiveJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('jobUuid')) {
jobUuid = _json['jobUuid'] as core.String;
}
if (_json.containsKey('labels')) {
labels =
(_json['labels'] as core.Map).cast<core.String, core.String>().map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('pigJob')) {
pigJob = PigJob.fromJson(
_json['pigJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('placement')) {
placement = JobPlacement.fromJson(
_json['placement'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('prestoJob')) {
prestoJob = PrestoJob.fromJson(
_json['prestoJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('pysparkJob')) {
pysparkJob = PySparkJob.fromJson(
_json['pysparkJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('reference')) {
reference = JobReference.fromJson(
_json['reference'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('scheduling')) {
scheduling = JobScheduling.fromJson(
_json['scheduling'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('sparkJob')) {
sparkJob = SparkJob.fromJson(
_json['sparkJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('sparkRJob')) {
sparkRJob = SparkRJob.fromJson(
_json['sparkRJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('sparkSqlJob')) {
sparkSqlJob = SparkSqlJob.fromJson(
_json['sparkSqlJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('status')) {
status = JobStatus.fromJson(
_json['status'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('statusHistory')) {
statusHistory = (_json['statusHistory'] as core.List)
.map<JobStatus>((value) =>
JobStatus.fromJson(value as core.Map<core.String, core.dynamic>))
.toList();
}
if (_json.containsKey('yarnApplications')) {
yarnApplications = (_json['yarnApplications'] as core.List)
.map<YarnApplication>((value) => YarnApplication.fromJson(
value as core.Map<core.String, core.dynamic>))
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (done != null) {
_json['done'] = done;
}
if (driverControlFilesUri != null) {
_json['driverControlFilesUri'] = driverControlFilesUri;
}
if (driverOutputResourceUri != null) {
_json['driverOutputResourceUri'] = driverOutputResourceUri;
}
if (hadoopJob != null) {
_json['hadoopJob'] = hadoopJob.toJson();
}
if (hiveJob != null) {
_json['hiveJob'] = hiveJob.toJson();
}
if (jobUuid != null) {
_json['jobUuid'] = jobUuid;
}
if (labels != null) {
_json['labels'] = labels;
}
if (pigJob != null) {
_json['pigJob'] = pigJob.toJson();
}
if (placement != null) {
_json['placement'] = placement.toJson();
}
if (prestoJob != null) {
_json['prestoJob'] = prestoJob.toJson();
}
if (pysparkJob != null) {
_json['pysparkJob'] = pysparkJob.toJson();
}
if (reference != null) {
_json['reference'] = reference.toJson();
}
if (scheduling != null) {
_json['scheduling'] = scheduling.toJson();
}
if (sparkJob != null) {
_json['sparkJob'] = sparkJob.toJson();
}
if (sparkRJob != null) {
_json['sparkRJob'] = sparkRJob.toJson();
}
if (sparkSqlJob != null) {
_json['sparkSqlJob'] = sparkSqlJob.toJson();
}
if (status != null) {
_json['status'] = status.toJson();
}
if (statusHistory != null) {
_json['statusHistory'] =
statusHistory.map((value) => value.toJson()).toList();
}
if (yarnApplications != null) {
_json['yarnApplications'] =
yarnApplications.map((value) => value.toJson()).toList();
}
return _json;
}
}
/// Job Operation metadata.
class JobMetadata {
/// The job id.
///
/// Output only.
core.String jobId;
/// Operation type.
///
/// Output only.
core.String operationType;
/// Job submission time.
///
/// Output only.
core.String startTime;
/// Most recent job status.
///
/// Output only.
JobStatus status;
JobMetadata();
JobMetadata.fromJson(core.Map _json) {
if (_json.containsKey('jobId')) {
jobId = _json['jobId'] as core.String;
}
if (_json.containsKey('operationType')) {
operationType = _json['operationType'] as core.String;
}
if (_json.containsKey('startTime')) {
startTime = _json['startTime'] as core.String;
}
if (_json.containsKey('status')) {
status = JobStatus.fromJson(
_json['status'] as core.Map<core.String, core.dynamic>);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (jobId != null) {
_json['jobId'] = jobId;
}
if (operationType != null) {
_json['operationType'] = operationType;
}
if (startTime != null) {
_json['startTime'] = startTime;
}
if (status != null) {
_json['status'] = status.toJson();
}
return _json;
}
}
/// Dataproc job config.
class JobPlacement {
/// The name of the cluster where the job will be submitted.
///
/// Required.
core.String clusterName;
/// A cluster UUID generated by the Dataproc service when the job is
/// submitted.
///
/// Output only.
core.String clusterUuid;
JobPlacement();
JobPlacement.fromJson(core.Map _json) {
if (_json.containsKey('clusterName')) {
clusterName = _json['clusterName'] as core.String;
}
if (_json.containsKey('clusterUuid')) {
clusterUuid = _json['clusterUuid'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (clusterName != null) {
_json['clusterName'] = clusterName;
}
if (clusterUuid != null) {
_json['clusterUuid'] = clusterUuid;
}
return _json;
}
}
/// Encapsulates the full scoping used to reference a job.
class JobReference {
/// The job ID, which must be unique within the project.The ID must contain
/// only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-).
///
/// The maximum length is 100 characters.If not specified by the caller, the
/// job ID will be provided by the server.
///
/// Optional.
core.String jobId;
/// The ID of the Google Cloud Platform project that the job belongs to.
///
/// If specified, must match the request project ID.
///
/// Optional.
core.String projectId;
JobReference();
JobReference.fromJson(core.Map _json) {
if (_json.containsKey('jobId')) {
jobId = _json['jobId'] as core.String;
}
if (_json.containsKey('projectId')) {
projectId = _json['projectId'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (jobId != null) {
_json['jobId'] = jobId;
}
if (projectId != null) {
_json['projectId'] = projectId;
}
return _json;
}
}
/// Job scheduling options.
class JobScheduling {
/// Maximum number of times per hour a driver may be restarted as a result of
/// driver exiting 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.
///
/// Optional.
core.int maxFailuresPerHour;
/// Maximum number of times in total a driver may be restarted as a result of
/// driver exiting with non-zero code before job is reported failed.
///
/// Maximum value is 240.
///
/// Optional.
core.int maxFailuresTotal;
JobScheduling();
JobScheduling.fromJson(core.Map _json) {
if (_json.containsKey('maxFailuresPerHour')) {
maxFailuresPerHour = _json['maxFailuresPerHour'] as core.int;
}
if (_json.containsKey('maxFailuresTotal')) {
maxFailuresTotal = _json['maxFailuresTotal'] as core.int;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (maxFailuresPerHour != null) {
_json['maxFailuresPerHour'] = maxFailuresPerHour;
}
if (maxFailuresTotal != null) {
_json['maxFailuresTotal'] = maxFailuresTotal;
}
return _json;
}
}
/// Dataproc job status.
class JobStatus {
/// Job state details, such as an error description if the state is ERROR.
///
/// Optional. Output only.
core.String details;
/// A state message specifying the overall job state.
///
/// Output only.
/// Possible string values are:
/// - "STATE_UNSPECIFIED" : The job state is unknown.
/// - "PENDING" : The job is pending; it has been submitted, but is not yet
/// running.
/// - "SETUP_DONE" : Job has been received by the service and completed
/// initial setup; it will soon be submitted to the cluster.
/// - "RUNNING" : The job is running on the cluster.
/// - "CANCEL_PENDING" : A CancelJob request has been received, but is
/// pending.
/// - "CANCEL_STARTED" : Transient in-flight resources have been canceled, and
/// the request to cancel the running job has been issued to the cluster.
/// - "CANCELLED" : The job cancellation was successful.
/// - "DONE" : The job has completed successfully.
/// - "ERROR" : The job has completed, but encountered an error.
/// - "ATTEMPT_FAILURE" : Job attempt has failed. The detail field contains
/// failure details for this attempt.Applies to restartable jobs only.
core.String state;
/// The time when this state was entered.
///
/// Output only.
core.String stateStartTime;
/// Additional state information, which includes status reported by the agent.
///
/// Output only.
/// Possible string values are:
/// - "UNSPECIFIED" : The job substate is unknown.
/// - "SUBMITTED" : The Job is submitted to the agent.Applies to RUNNING
/// state.
/// - "QUEUED" : The Job has been received and is awaiting execution (it may
/// be waiting for a condition to be met). See the "details" field for the
/// reason for the delay.Applies to RUNNING state.
/// - "STALE_STATUS" : The agent-reported status is out of date, which may be
/// caused by a loss of communication between the agent and Dataproc. If the
/// agent does not send a timely update, the job will fail.Applies to RUNNING
/// state.
core.String substate;
JobStatus();
JobStatus.fromJson(core.Map _json) {
if (_json.containsKey('details')) {
details = _json['details'] as core.String;
}
if (_json.containsKey('state')) {
state = _json['state'] as core.String;
}
if (_json.containsKey('stateStartTime')) {
stateStartTime = _json['stateStartTime'] as core.String;
}
if (_json.containsKey('substate')) {
substate = _json['substate'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (details != null) {
_json['details'] = details;
}
if (state != null) {
_json['state'] = state;
}
if (stateStartTime != null) {
_json['stateStartTime'] = stateStartTime;
}
if (substate != null) {
_json['substate'] = substate;
}
return _json;
}
}
/// Specifies Kerberos related configuration.
class KerberosConfig {
/// The admin server (IP or hostname) for the remote trusted realm in a cross
/// realm trust relationship.
///
/// Optional.
core.String crossRealmTrustAdminServer;
/// The KDC (IP or hostname) for the remote trusted realm in a cross realm
/// trust relationship.
///
/// Optional.
core.String crossRealmTrustKdc;
/// The remote realm the Dataproc on-cluster KDC will trust, should the user
/// enable cross realm trust.
///
/// Optional.
core.String crossRealmTrustRealm;
/// The Cloud Storage URI of a KMS encrypted file containing the shared
/// password between the on-cluster Kerberos realm and the remote trusted
/// realm, in a cross realm trust relationship.
///
/// Optional.
core.String crossRealmTrustSharedPasswordUri;
/// Flag to indicate whether to Kerberize the cluster (default: false).
///
/// Set this field to true to enable Kerberos on a cluster.
///
/// Optional.
core.bool enableKerberos;
/// The Cloud Storage URI of a KMS encrypted file containing the master key of
/// the KDC database.
///
/// Optional.
core.String kdcDbKeyUri;
/// The Cloud Storage URI of a KMS encrypted file containing the password to
/// the user provided key.
///
/// For the self-signed certificate, this password is generated by Dataproc.
///
/// Optional.
core.String keyPasswordUri;
/// The Cloud Storage URI of a KMS encrypted file containing the password to
/// the user provided keystore.
///
/// For the self-signed certificate, this password is generated by Dataproc.
///
/// Optional.
core.String keystorePasswordUri;
/// The Cloud Storage URI of the keystore file used for SSL encryption.
///
/// If not provided, Dataproc will provide a self-signed certificate.
///
/// Optional.
core.String keystoreUri;
/// The uri of the KMS key used to encrypt various sensitive files.
///
/// Optional.
core.String kmsKeyUri;
/// The name of the on-cluster Kerberos realm.
///
/// If not specified, the uppercased domain of hostnames will be the realm.
///
/// Optional.
core.String realm;
/// The Cloud Storage URI of a KMS encrypted file containing the root
/// principal password.
///
/// Optional.
core.String rootPrincipalPasswordUri;
/// The lifetime of the ticket granting ticket, in hours.
///
/// If not specified, or user specifies 0, then default value 10 will be used.
///
/// Optional.
core.int tgtLifetimeHours;
/// The Cloud Storage URI of a KMS encrypted file containing the password to
/// the user provided truststore.
///
/// For the self-signed certificate, this password is generated by Dataproc.
///
/// Optional.
core.String truststorePasswordUri;
/// The Cloud Storage URI of the truststore file used for SSL encryption.
///
/// If not provided, Dataproc will provide a self-signed certificate.
///
/// Optional.
core.String truststoreUri;
KerberosConfig();
KerberosConfig.fromJson(core.Map _json) {
if (_json.containsKey('crossRealmTrustAdminServer')) {
crossRealmTrustAdminServer =
_json['crossRealmTrustAdminServer'] as core.String;
}
if (_json.containsKey('crossRealmTrustKdc')) {
crossRealmTrustKdc = _json['crossRealmTrustKdc'] as core.String;
}
if (_json.containsKey('crossRealmTrustRealm')) {
crossRealmTrustRealm = _json['crossRealmTrustRealm'] as core.String;
}
if (_json.containsKey('crossRealmTrustSharedPasswordUri')) {
crossRealmTrustSharedPasswordUri =
_json['crossRealmTrustSharedPasswordUri'] as core.String;
}
if (_json.containsKey('enableKerberos')) {
enableKerberos = _json['enableKerberos'] as core.bool;
}
if (_json.containsKey('kdcDbKeyUri')) {
kdcDbKeyUri = _json['kdcDbKeyUri'] as core.String;
}
if (_json.containsKey('keyPasswordUri')) {
keyPasswordUri = _json['keyPasswordUri'] as core.String;
}
if (_json.containsKey('keystorePasswordUri')) {
keystorePasswordUri = _json['keystorePasswordUri'] as core.String;
}
if (_json.containsKey('keystoreUri')) {
keystoreUri = _json['keystoreUri'] as core.String;
}
if (_json.containsKey('kmsKeyUri')) {
kmsKeyUri = _json['kmsKeyUri'] as core.String;
}
if (_json.containsKey('realm')) {
realm = _json['realm'] as core.String;
}
if (_json.containsKey('rootPrincipalPasswordUri')) {
rootPrincipalPasswordUri =
_json['rootPrincipalPasswordUri'] as core.String;
}
if (_json.containsKey('tgtLifetimeHours')) {
tgtLifetimeHours = _json['tgtLifetimeHours'] as core.int;
}
if (_json.containsKey('truststorePasswordUri')) {
truststorePasswordUri = _json['truststorePasswordUri'] as core.String;
}
if (_json.containsKey('truststoreUri')) {
truststoreUri = _json['truststoreUri'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (crossRealmTrustAdminServer != null) {
_json['crossRealmTrustAdminServer'] = crossRealmTrustAdminServer;
}
if (crossRealmTrustKdc != null) {
_json['crossRealmTrustKdc'] = crossRealmTrustKdc;
}
if (crossRealmTrustRealm != null) {
_json['crossRealmTrustRealm'] = crossRealmTrustRealm;
}
if (crossRealmTrustSharedPasswordUri != null) {
_json['crossRealmTrustSharedPasswordUri'] =
crossRealmTrustSharedPasswordUri;
}
if (enableKerberos != null) {
_json['enableKerberos'] = enableKerberos;
}
if (kdcDbKeyUri != null) {
_json['kdcDbKeyUri'] = kdcDbKeyUri;
}
if (keyPasswordUri != null) {
_json['keyPasswordUri'] = keyPasswordUri;
}
if (keystorePasswordUri != null) {
_json['keystorePasswordUri'] = keystorePasswordUri;
}
if (keystoreUri != null) {
_json['keystoreUri'] = keystoreUri;
}
if (kmsKeyUri != null) {
_json['kmsKeyUri'] = kmsKeyUri;
}
if (realm != null) {
_json['realm'] = realm;
}
if (rootPrincipalPasswordUri != null) {
_json['rootPrincipalPasswordUri'] = rootPrincipalPasswordUri;
}
if (tgtLifetimeHours != null) {
_json['tgtLifetimeHours'] = tgtLifetimeHours;
}
if (truststorePasswordUri != null) {
_json['truststorePasswordUri'] = truststorePasswordUri;
}
if (truststoreUri != null) {
_json['truststoreUri'] = truststoreUri;
}
return _json;
}
}
/// Specifies the cluster auto-delete schedule configuration.
class LifecycleConfig {
/// The time when cluster will be auto-deleted (see JSON representation of
/// Timestamp
/// (https://developers.google.com/protocol-buffers/docs/proto3#json)).
///
/// Optional.
core.String autoDeleteTime;
/// The lifetime duration of cluster.
///
/// The cluster will be auto-deleted at the end of this period. Minimum value
/// is 10 minutes; maximum value is 14 days (see JSON representation of
/// Duration
/// (https://developers.google.com/protocol-buffers/docs/proto3#json)).
///
/// Optional.
core.String autoDeleteTtl;
/// The duration to keep the cluster alive while idling (when no jobs are
/// running).
///
/// Passing this threshold will cause the cluster to be deleted. Minimum value
/// is 5 minutes; maximum value is 14 days (see JSON representation of
/// Duration
/// (https://developers.google.com/protocol-buffers/docs/proto3#json)).
///
/// Optional.
core.String idleDeleteTtl;
/// The time when cluster became idle (most recent job finished) and became
/// eligible for deletion due to idleness (see JSON representation of
/// Timestamp
/// (https://developers.google.com/protocol-buffers/docs/proto3#json)).
///
/// Output only.
core.String idleStartTime;
LifecycleConfig();
LifecycleConfig.fromJson(core.Map _json) {
if (_json.containsKey('autoDeleteTime')) {
autoDeleteTime = _json['autoDeleteTime'] as core.String;
}
if (_json.containsKey('autoDeleteTtl')) {
autoDeleteTtl = _json['autoDeleteTtl'] as core.String;
}
if (_json.containsKey('idleDeleteTtl')) {
idleDeleteTtl = _json['idleDeleteTtl'] as core.String;
}
if (_json.containsKey('idleStartTime')) {
idleStartTime = _json['idleStartTime'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (autoDeleteTime != null) {
_json['autoDeleteTime'] = autoDeleteTime;
}
if (autoDeleteTtl != null) {
_json['autoDeleteTtl'] = autoDeleteTtl;
}
if (idleDeleteTtl != null) {
_json['idleDeleteTtl'] = idleDeleteTtl;
}
if (idleStartTime != null) {
_json['idleStartTime'] = idleStartTime;
}
return _json;
}
}
/// A response to a request to list autoscaling policies in a project.
class ListAutoscalingPoliciesResponse {
/// This token is included in the response if there are more results to fetch.
///
/// Output only.
core.String nextPageToken;
/// Autoscaling policies list.
///
/// Output only.
core.List<AutoscalingPolicy> policies;
ListAutoscalingPoliciesResponse();
ListAutoscalingPoliciesResponse.fromJson(core.Map _json) {
if (_json.containsKey('nextPageToken')) {
nextPageToken = _json['nextPageToken'] as core.String;
}
if (_json.containsKey('policies')) {
policies = (_json['policies'] as core.List)
.map<AutoscalingPolicy>((value) => AutoscalingPolicy.fromJson(
value as core.Map<core.String, core.dynamic>))
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (nextPageToken != null) {
_json['nextPageToken'] = nextPageToken;
}
if (policies != null) {
_json['policies'] = policies.map((value) => value.toJson()).toList();
}
return _json;
}
}
/// The list of all clusters in a project.
class ListClustersResponse {
/// The clusters in the project.
///
/// Output only.
core.List<Cluster> clusters;
/// 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.
///
/// Output only.
core.String nextPageToken;
ListClustersResponse();
ListClustersResponse.fromJson(core.Map _json) {
if (_json.containsKey('clusters')) {
clusters = (_json['clusters'] as core.List)
.map<Cluster>((value) =>
Cluster.fromJson(value as core.Map<core.String, core.dynamic>))
.toList();
}
if (_json.containsKey('nextPageToken')) {
nextPageToken = _json['nextPageToken'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (clusters != null) {
_json['clusters'] = clusters.map((value) => value.toJson()).toList();
}
if (nextPageToken != null) {
_json['nextPageToken'] = nextPageToken;
}
return _json;
}
}
/// A list of jobs in a project.
class ListJobsResponse {
/// Jobs list.
///
/// Output only.
core.List<Job> jobs;
/// 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 ListJobsRequest.
///
/// Optional.
core.String nextPageToken;
ListJobsResponse();
ListJobsResponse.fromJson(core.Map _json) {
if (_json.containsKey('jobs')) {
jobs = (_json['jobs'] as core.List)
.map<Job>((value) =>
Job.fromJson(value as core.Map<core.String, core.dynamic>))
.toList();
}
if (_json.containsKey('nextPageToken')) {
nextPageToken = _json['nextPageToken'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (jobs != null) {
_json['jobs'] = jobs.map((value) => value.toJson()).toList();
}
if (nextPageToken != null) {
_json['nextPageToken'] = nextPageToken;
}
return _json;
}
}
/// The response message for Operations.ListOperations.
class ListOperationsResponse {
/// The standard List next-page token.
core.String nextPageToken;
/// A list of operations that matches the specified filter in the request.
core.List<Operation> operations;
ListOperationsResponse();
ListOperationsResponse.fromJson(core.Map _json) {
if (_json.containsKey('nextPageToken')) {
nextPageToken = _json['nextPageToken'] as core.String;
}
if (_json.containsKey('operations')) {
operations = (_json['operations'] as core.List)
.map<Operation>((value) =>
Operation.fromJson(value as core.Map<core.String, core.dynamic>))
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (nextPageToken != null) {
_json['nextPageToken'] = nextPageToken;
}
if (operations != null) {
_json['operations'] = operations.map((value) => value.toJson()).toList();
}
return _json;
}
}
/// A response to a request to list workflow templates in a project.
class ListWorkflowTemplatesResponse {
/// 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 ListWorkflowTemplatesRequest.
///
/// Output only.
core.String nextPageToken;
/// WorkflowTemplates list.
///
/// Output only.
core.List<WorkflowTemplate> templates;
ListWorkflowTemplatesResponse();
ListWorkflowTemplatesResponse.fromJson(core.Map _json) {
if (_json.containsKey('nextPageToken')) {
nextPageToken = _json['nextPageToken'] as core.String;
}
if (_json.containsKey('templates')) {
templates = (_json['templates'] as core.List)
.map<WorkflowTemplate>((value) => WorkflowTemplate.fromJson(
value as core.Map<core.String, core.dynamic>))
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (nextPageToken != null) {
_json['nextPageToken'] = nextPageToken;
}
if (templates != null) {
_json['templates'] = templates.map((value) => value.toJson()).toList();
}
return _json;
}
}
/// The runtime logging config of the job.
class 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'
core.Map<core.String, core.String> driverLogLevels;
LoggingConfig();
LoggingConfig.fromJson(core.Map _json) {
if (_json.containsKey('driverLogLevels')) {
driverLogLevels = (_json['driverLogLevels'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (driverLogLevels != null) {
_json['driverLogLevels'] = driverLogLevels;
}
return _json;
}
}
/// Cluster that is managed by the workflow.
class ManagedCluster {
/// The cluster name prefix.
///
/// A unique cluster name will be formed by appending a random suffix.The name
/// must contain only lower-case letters (a-z), numbers (0-9), and hyphens
/// (-). Must begin with a letter. Cannot begin or end with hyphen. Must
/// consist of between 2 and 35 characters.
///
/// Required.
core.String clusterName;
/// The cluster configuration.
///
/// Required.
ClusterConfig config;
/// The labels to associate with this cluster.Label keys must be between 1 and
/// 63 characters long, and must conform to the following PCRE regular
/// expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63
/// characters long, and must conform to the following PCRE regular
/// expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be
/// associated with a given cluster.
///
/// Optional.
core.Map<core.String, core.String> labels;
ManagedCluster();
ManagedCluster.fromJson(core.Map _json) {
if (_json.containsKey('clusterName')) {
clusterName = _json['clusterName'] as core.String;
}
if (_json.containsKey('config')) {
config = ClusterConfig.fromJson(
_json['config'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('labels')) {
labels =
(_json['labels'] as core.Map).cast<core.String, core.String>().map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (clusterName != null) {
_json['clusterName'] = clusterName;
}
if (config != null) {
_json['config'] = config.toJson();
}
if (labels != null) {
_json['labels'] = labels;
}
return _json;
}
}
/// Specifies the resources used to actively manage an instance group.
class ManagedGroupConfig {
/// The name of the Instance Group Manager for this group.
///
/// Output only.
core.String instanceGroupManagerName;
/// The name of the Instance Template used for the Managed Instance Group.
///
/// Output only.
core.String instanceTemplateName;
ManagedGroupConfig();
ManagedGroupConfig.fromJson(core.Map _json) {
if (_json.containsKey('instanceGroupManagerName')) {
instanceGroupManagerName =
_json['instanceGroupManagerName'] as core.String;
}
if (_json.containsKey('instanceTemplateName')) {
instanceTemplateName = _json['instanceTemplateName'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (instanceGroupManagerName != null) {
_json['instanceGroupManagerName'] = instanceGroupManagerName;
}
if (instanceTemplateName != null) {
_json['instanceTemplateName'] = instanceTemplateName;
}
return _json;
}
}
/// Node Group Affinity for clusters using sole-tenant node groups.
class NodeGroupAffinity {
/// The URI of a sole-tenant node group resource
/// (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that
/// the cluster will be created on.A full URL, partial URI, or node group name
/// are valid.
///
/// Examples:
/// https://www.googleapis.com/compute/v1/projects/\[project_id\]/zones/us-central1-a/nodeGroups/node-group-1
/// projects/\[project_id\]/zones/us-central1-a/nodeGroups/node-group-1
/// node-group-1
///
/// Required.
core.String nodeGroupUri;
NodeGroupAffinity();
NodeGroupAffinity.fromJson(core.Map _json) {
if (_json.containsKey('nodeGroupUri')) {
nodeGroupUri = _json['nodeGroupUri'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (nodeGroupUri != null) {
_json['nodeGroupUri'] = nodeGroupUri;
}
return _json;
}
}
/// Specifies an executable to run on a fully configured node and a timeout
/// period for executable completion.
class NodeInitializationAction {
/// Cloud Storage URI of executable file.
///
/// Required.
core.String executableFile;
/// Amount of time executable has to complete.
///
/// Default is 10 minutes (see JSON representation of Duration
/// (https://developers.google.com/protocol-buffers/docs/proto3#json)).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.
///
/// Optional.
core.String executionTimeout;
NodeInitializationAction();
NodeInitializationAction.fromJson(core.Map _json) {
if (_json.containsKey('executableFile')) {
executableFile = _json['executableFile'] as core.String;
}
if (_json.containsKey('executionTimeout')) {
executionTimeout = _json['executionTimeout'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (executableFile != null) {
_json['executableFile'] = executableFile;
}
if (executionTimeout != null) {
_json['executionTimeout'] = executionTimeout;
}
return _json;
}
}
/// This resource represents a long-running operation that is the result of a
/// network API call.
class 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.
core.bool done;
/// The error result of the operation in case of failure or cancellation.
Status error;
/// 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.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> metadata;
/// 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 be a resource name
/// ending with operations/{unique_id}.
core.String name;
/// 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.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> response;
Operation();
Operation.fromJson(core.Map _json) {
if (_json.containsKey('done')) {
done = _json['done'] as core.bool;
}
if (_json.containsKey('error')) {
error = Status.fromJson(
_json['error'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('metadata')) {
metadata =
(_json['metadata'] as core.Map).cast<core.String, core.Object>().map(
(key, item) => core.MapEntry(
key,
item as core.Object,
),
);
}
if (_json.containsKey('name')) {
name = _json['name'] as core.String;
}
if (_json.containsKey('response')) {
response =
(_json['response'] as core.Map).cast<core.String, core.Object>().map(
(key, item) => core.MapEntry(
key,
item as core.Object,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (done != null) {
_json['done'] = done;
}
if (error != null) {
_json['error'] = error.toJson();
}
if (metadata != null) {
_json['metadata'] = metadata;
}
if (name != null) {
_json['name'] = name;
}
if (response != null) {
_json['response'] = response;
}
return _json;
}
}
/// A job executed by the workflow.
class OrderedJob {
/// Job is a Hadoop job.
///
/// Optional.
HadoopJob hadoopJob;
/// Job is a Hive job.
///
/// Optional.
HiveJob hiveJob;
/// The labels to associate with this job.Label keys must be between 1 and 63
/// characters long, and must conform to the following regular expression:
/// \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long,
/// and must conform to the following regular expression:
/// \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a
/// given job.
///
/// Optional.
core.Map<core.String, core.String> labels;
/// Job is a Pig job.
///
/// Optional.
PigJob pigJob;
/// The optional list of prerequisite job step_ids.
///
/// If not specified, the job will start at the beginning of workflow.
///
/// Optional.
core.List<core.String> prerequisiteStepIds;
/// Job is a Presto job.
///
/// Optional.
PrestoJob prestoJob;
/// Job is a PySpark job.
///
/// Optional.
PySparkJob pysparkJob;
/// Job scheduling configuration.
///
/// Optional.
JobScheduling scheduling;
/// Job is a Spark job.
///
/// Optional.
SparkJob sparkJob;
/// Job is a SparkR job.
///
/// Optional.
SparkRJob sparkRJob;
/// Job is a SparkSql job.
///
/// Optional.
SparkSqlJob sparkSqlJob;
/// The step id.
///
/// The id must be unique among all jobs within the template.The step id is
/// used as prefix for job id, as job goog-dataproc-workflow-step-id label,
/// and in prerequisiteStepIds field from other steps.The id must contain only
/// letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-).
/// Cannot begin or end with underscore or hyphen. Must consist of between 3
/// and 50 characters.
///
/// Required.
core.String stepId;
OrderedJob();
OrderedJob.fromJson(core.Map _json) {
if (_json.containsKey('hadoopJob')) {
hadoopJob = HadoopJob.fromJson(
_json['hadoopJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('hiveJob')) {
hiveJob = HiveJob.fromJson(
_json['hiveJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('labels')) {
labels =
(_json['labels'] as core.Map).cast<core.String, core.String>().map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('pigJob')) {
pigJob = PigJob.fromJson(
_json['pigJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('prerequisiteStepIds')) {
prerequisiteStepIds = (_json['prerequisiteStepIds'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('prestoJob')) {
prestoJob = PrestoJob.fromJson(
_json['prestoJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('pysparkJob')) {
pysparkJob = PySparkJob.fromJson(
_json['pysparkJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('scheduling')) {
scheduling = JobScheduling.fromJson(
_json['scheduling'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('sparkJob')) {
sparkJob = SparkJob.fromJson(
_json['sparkJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('sparkRJob')) {
sparkRJob = SparkRJob.fromJson(
_json['sparkRJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('sparkSqlJob')) {
sparkSqlJob = SparkSqlJob.fromJson(
_json['sparkSqlJob'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('stepId')) {
stepId = _json['stepId'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (hadoopJob != null) {
_json['hadoopJob'] = hadoopJob.toJson();
}
if (hiveJob != null) {
_json['hiveJob'] = hiveJob.toJson();
}
if (labels != null) {
_json['labels'] = labels;
}
if (pigJob != null) {
_json['pigJob'] = pigJob.toJson();
}
if (prerequisiteStepIds != null) {
_json['prerequisiteStepIds'] = prerequisiteStepIds;
}
if (prestoJob != null) {
_json['prestoJob'] = prestoJob.toJson();
}
if (pysparkJob != null) {
_json['pysparkJob'] = pysparkJob.toJson();
}
if (scheduling != null) {
_json['scheduling'] = scheduling.toJson();
}
if (sparkJob != null) {
_json['sparkJob'] = sparkJob.toJson();
}
if (sparkRJob != null) {
_json['sparkRJob'] = sparkRJob.toJson();
}
if (sparkSqlJob != null) {
_json['sparkSqlJob'] = sparkSqlJob.toJson();
}
if (stepId != null) {
_json['stepId'] = stepId;
}
return _json;
}
}
/// Configuration for parameter validation.
class ParameterValidation {
/// Validation based on regular expressions.
RegexValidation regex;
/// Validation based on a list of allowed values.
ValueValidation values;
ParameterValidation();
ParameterValidation.fromJson(core.Map _json) {
if (_json.containsKey('regex')) {
regex = RegexValidation.fromJson(
_json['regex'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('values')) {
values = ValueValidation.fromJson(
_json['values'] as core.Map<core.String, core.dynamic>);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (regex != null) {
_json['regex'] = regex.toJson();
}
if (values != null) {
_json['values'] = values.toJson();
}
return _json;
}
}
/// A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on
/// YARN.
class PigJob {
/// 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.
///
/// Optional.
core.bool continueOnFailure;
/// HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and
/// Hadoop MapReduce (MR) tasks.
///
/// Can contain Pig UDFs.
///
/// Optional.
core.List<core.String> jarFileUris;
/// The runtime log config for job execution.
///
/// Optional.
LoggingConfig loggingConfig;
/// A mapping of property names to values, used to configure Pig.
///
/// Properties that conflict with values set by the 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.
///
/// Optional.
core.Map<core.String, core.String> properties;
/// The HCFS URI of the script that contains the Pig queries.
core.String queryFileUri;
/// A list of queries.
QueryList queryList;
/// Mapping of query variable names to values (equivalent to the Pig command:
/// name=\[value\]).
///
/// Optional.
core.Map<core.String, core.String> scriptVariables;
PigJob();
PigJob.fromJson(core.Map _json) {
if (_json.containsKey('continueOnFailure')) {
continueOnFailure = _json['continueOnFailure'] as core.bool;
}
if (_json.containsKey('jarFileUris')) {
jarFileUris = (_json['jarFileUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('loggingConfig')) {
loggingConfig = LoggingConfig.fromJson(
_json['loggingConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('properties')) {
properties = (_json['properties'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('queryFileUri')) {
queryFileUri = _json['queryFileUri'] as core.String;
}
if (_json.containsKey('queryList')) {
queryList = QueryList.fromJson(
_json['queryList'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('scriptVariables')) {
scriptVariables = (_json['scriptVariables'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (continueOnFailure != null) {
_json['continueOnFailure'] = continueOnFailure;
}
if (jarFileUris != null) {
_json['jarFileUris'] = jarFileUris;
}
if (loggingConfig != null) {
_json['loggingConfig'] = loggingConfig.toJson();
}
if (properties != null) {
_json['properties'] = properties;
}
if (queryFileUri != null) {
_json['queryFileUri'] = queryFileUri;
}
if (queryList != null) {
_json['queryList'] = queryList.toJson();
}
if (scriptVariables != null) {
_json['scriptVariables'] = scriptVariables;
}
return _json;
}
}
/// An Identity and Access Management (IAM) policy, which specifies access
/// controls for Google Cloud resources.A Policy is a collection of bindings.
///
/// A binding binds one or more members to a single role. Members can be user
/// accounts, service accounts, Google groups, and domains (such as G Suite). A
/// role is a named list of permissions; each role can be an IAM predefined role
/// or a user-created custom role.For some types of Google Cloud resources, a
/// binding can also specify a condition, which is a logical expression that
/// allows access to a resource only if the expression evaluates to true. A
/// condition can add constraints based on attributes of the request, the
/// resource, or both. To learn which resources support conditions in their IAM
/// policies, see the IAM documentation
/// (https://cloud.google.com/iam/help/conditions/resource-policies).JSON
/// example: { "bindings": \[ { "role":
/// "roles/resourcemanager.organizationAdmin", "members": \[
/// "user:mike@example.com", "group:admins@example.com", "domain:google.com",
/// "serviceAccount:my-project-id@appspot.gserviceaccount.com" \] }, { "role":
/// "roles/resourcemanager.organizationViewer", "members": \[
/// "user:eve@example.com" \], "condition": { "title": "expirable access",
/// "description": "Does not grant access after Sep 2020", "expression":
/// "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } \], "etag":
/// "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: -
/// user:mike@example.com - group:admins@example.com - domain:google.com -
/// serviceAccount:my-project-id@appspot.gserviceaccount.com role:
/// roles/resourcemanager.organizationAdmin - members: - user:eve@example.com
/// role: roles/resourcemanager.organizationViewer condition: title: expirable
/// access description: Does not grant access after Sep 2020 expression:
/// request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= -
/// version: 3 For a description of IAM and its features, see the IAM
/// documentation (https://cloud.google.com/iam/docs/).
class Policy {
/// Associates a list of members to a role.
///
/// Optionally, may specify a condition that determines how and when the
/// bindings are applied. Each of the bindings must contain at least one
/// member.
core.List<Binding> bindings;
/// 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.Important: If you use IAM Conditions, you must include the etag
/// field whenever you call setIamPolicy. If you omit this field, then IAM
/// allows you to overwrite a version 3 policy with a version 1 policy, and
/// all of the conditions in the version 3 policy are lost.
core.String etag;
core.List<core.int> get etagAsBytes => convert.base64.decode(etag);
set etagAsBytes(core.List<core.int> _bytes) {
etag =
convert.base64.encode(_bytes).replaceAll('/', '_').replaceAll('+', '-');
}
/// Specifies the format of the policy.Valid values are 0, 1, and 3.
///
/// Requests that specify an invalid value are rejected.Any operation that
/// affects conditional role bindings must specify version 3. This requirement
/// applies to the following operations: Getting a policy that includes a
/// conditional role binding Adding a conditional role binding to a policy
/// Changing a conditional role binding in a policy Removing any role binding,
/// with or without a condition, from a policy that includes
/// conditionsImportant: If you use IAM Conditions, you must include the etag
/// field whenever you call setIamPolicy. If you omit this field, then IAM
/// allows you to overwrite a version 3 policy with a version 1 policy, and
/// all of the conditions in the version 3 policy are lost.If a policy does
/// not include any conditions, operations on that policy may specify any
/// valid version or leave the field unset.To learn which resources support
/// conditions in their IAM policies, see the IAM documentation
/// (https://cloud.google.com/iam/help/conditions/resource-policies).
core.int version;
Policy();
Policy.fromJson(core.Map _json) {
if (_json.containsKey('bindings')) {
bindings = (_json['bindings'] as core.List)
.map<Binding>((value) =>
Binding.fromJson(value as core.Map<core.String, core.dynamic>))
.toList();
}
if (_json.containsKey('etag')) {
etag = _json['etag'] as core.String;
}
if (_json.containsKey('version')) {
version = _json['version'] as core.int;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (bindings != null) {
_json['bindings'] = bindings.map((value) => value.toJson()).toList();
}
if (etag != null) {
_json['etag'] = etag;
}
if (version != null) {
_json['version'] = version;
}
return _json;
}
}
/// A Dataproc job for running Presto (https://prestosql.io/) queries.
///
/// IMPORTANT: The Dataproc Presto Optional Component
/// (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be
/// enabled when the cluster is created to submit a Presto job to the cluster.
class PrestoJob {
/// Presto client tags to attach to this query
///
/// Optional.
core.List<core.String> clientTags;
/// 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.
///
/// Optional.
core.bool continueOnFailure;
/// The runtime log config for job execution.
///
/// Optional.
LoggingConfig loggingConfig;
/// The format in which query output will be displayed.
///
/// See the Presto documentation for supported output formats
///
/// Optional.
core.String outputFormat;
/// A mapping of property names to values.
///
/// Used to set Presto session properties
/// (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to
/// using the --session flag in the Presto CLI
///
/// Optional.
core.Map<core.String, core.String> properties;
/// The HCFS URI of the script that contains SQL queries.
core.String queryFileUri;
/// A list of queries.
QueryList queryList;
PrestoJob();
PrestoJob.fromJson(core.Map _json) {
if (_json.containsKey('clientTags')) {
clientTags = (_json['clientTags'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('continueOnFailure')) {
continueOnFailure = _json['continueOnFailure'] as core.bool;
}
if (_json.containsKey('loggingConfig')) {
loggingConfig = LoggingConfig.fromJson(
_json['loggingConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('outputFormat')) {
outputFormat = _json['outputFormat'] as core.String;
}
if (_json.containsKey('properties')) {
properties = (_json['properties'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('queryFileUri')) {
queryFileUri = _json['queryFileUri'] as core.String;
}
if (_json.containsKey('queryList')) {
queryList = QueryList.fromJson(
_json['queryList'] as core.Map<core.String, core.dynamic>);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (clientTags != null) {
_json['clientTags'] = clientTags;
}
if (continueOnFailure != null) {
_json['continueOnFailure'] = continueOnFailure;
}
if (loggingConfig != null) {
_json['loggingConfig'] = loggingConfig.toJson();
}
if (outputFormat != null) {
_json['outputFormat'] = outputFormat;
}
if (properties != null) {
_json['properties'] = properties;
}
if (queryFileUri != null) {
_json['queryFileUri'] = queryFileUri;
}
if (queryList != null) {
_json['queryList'] = queryList.toJson();
}
return _json;
}
}
/// A Dataproc job for running Apache PySpark
/// (https://spark.apache.org/docs/0.9.0/python-programming-guide.html)
/// applications on YARN.
class PySparkJob {
/// HCFS URIs of archives to be extracted into the working directory of each
/// executor.
///
/// Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
///
/// Optional.
core.List<core.String> archiveUris;
/// 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.
///
/// Optional.
core.List<core.String> args;
/// HCFS URIs of files to be placed in the working directory of each executor.
///
/// Useful for naively parallel tasks.
///
/// Optional.
core.List<core.String> fileUris;
/// HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and
/// tasks.
///
/// Optional.
core.List<core.String> jarFileUris;
/// The runtime log config for job execution.
///
/// Optional.
LoggingConfig loggingConfig;
/// The HCFS URI of the main Python file to use as the driver.
///
/// Must be a .py file.
///
/// Required.
core.String mainPythonFileUri;
/// A mapping of property names to values, used to configure PySpark.
///
/// Properties that conflict with values set by the Dataproc API may be
/// overwritten. Can include properties set in
/// /etc/spark/conf/spark-defaults.conf and classes in user code.
///
/// Optional.
core.Map<core.String, core.String> properties;
/// HCFS file URIs of Python files to pass to the PySpark framework.
///
/// Supported file types: .py, .egg, and .zip.
///
/// Optional.
core.List<core.String> pythonFileUris;
PySparkJob();
PySparkJob.fromJson(core.Map _json) {
if (_json.containsKey('archiveUris')) {
archiveUris = (_json['archiveUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('args')) {
args = (_json['args'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('fileUris')) {
fileUris = (_json['fileUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('jarFileUris')) {
jarFileUris = (_json['jarFileUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('loggingConfig')) {
loggingConfig = LoggingConfig.fromJson(
_json['loggingConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('mainPythonFileUri')) {
mainPythonFileUri = _json['mainPythonFileUri'] as core.String;
}
if (_json.containsKey('properties')) {
properties = (_json['properties'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('pythonFileUris')) {
pythonFileUris = (_json['pythonFileUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (archiveUris != null) {
_json['archiveUris'] = archiveUris;
}
if (args != null) {
_json['args'] = args;
}
if (fileUris != null) {
_json['fileUris'] = fileUris;
}
if (jarFileUris != null) {
_json['jarFileUris'] = jarFileUris;
}
if (loggingConfig != null) {
_json['loggingConfig'] = loggingConfig.toJson();
}
if (mainPythonFileUri != null) {
_json['mainPythonFileUri'] = mainPythonFileUri;
}
if (properties != null) {
_json['properties'] = properties;
}
if (pythonFileUris != null) {
_json['pythonFileUris'] = pythonFileUris;
}
return _json;
}
}
/// A list of queries to run on a cluster.
class QueryList {
/// The queries to execute.
///
/// You do not need to end a query expression with a semicolon. Multiple
/// queries can be specified in one string by separating each with a
/// semicolon. Here is an example of a Dataproc API snippet that uses a
/// QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": \[
/// "query1", "query2", "query3;query4", \] } }
///
/// Required.
core.List<core.String> queries;
QueryList();
QueryList.fromJson(core.Map _json) {
if (_json.containsKey('queries')) {
queries = (_json['queries'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (queries != null) {
_json['queries'] = queries;
}
return _json;
}
}
/// Validation based on regular expressions.
class RegexValidation {
/// RE2 regular expressions used to validate the parameter's value.
///
/// The value must match the regex in its entirety (substring matches are not
/// sufficient).
///
/// Required.
core.List<core.String> regexes;
RegexValidation();
RegexValidation.fromJson(core.Map _json) {
if (_json.containsKey('regexes')) {
regexes = (_json['regexes'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (regexes != null) {
_json['regexes'] = regexes;
}
return _json;
}
}
/// Reservation Affinity for consuming Zonal reservation.
class ReservationAffinity {
/// Type of reservation to consume
///
/// Optional.
/// Possible string values are:
/// - "TYPE_UNSPECIFIED"
/// - "NO_RESERVATION" : Do not consume from any allocated capacity.
/// - "ANY_RESERVATION" : Consume any reservation available.
/// - "SPECIFIC_RESERVATION" : Must consume from a specific reservation. Must
/// specify key value fields for specifying the reservations.
core.String consumeReservationType;
/// Corresponds to the label key of reservation resource.
///
/// Optional.
core.String key;
/// Corresponds to the label values of reservation resource.
///
/// Optional.
core.List<core.String> values;
ReservationAffinity();
ReservationAffinity.fromJson(core.Map _json) {
if (_json.containsKey('consumeReservationType')) {
consumeReservationType = _json['consumeReservationType'] as core.String;
}
if (_json.containsKey('key')) {
key = _json['key'] as core.String;
}
if (_json.containsKey('values')) {
values = (_json['values'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (consumeReservationType != null) {
_json['consumeReservationType'] = consumeReservationType;
}
if (key != null) {
_json['key'] = key;
}
if (values != null) {
_json['values'] = values;
}
return _json;
}
}
/// Security related configuration, including Kerberos.
class SecurityConfig {
/// Kerberos related configuration.
KerberosConfig kerberosConfig;
SecurityConfig();
SecurityConfig.fromJson(core.Map _json) {
if (_json.containsKey('kerberosConfig')) {
kerberosConfig = KerberosConfig.fromJson(
_json['kerberosConfig'] as core.Map<core.String, core.dynamic>);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (kerberosConfig != null) {
_json['kerberosConfig'] = kerberosConfig.toJson();
}
return _json;
}
}
/// Request message for SetIamPolicy method.
class SetIamPolicyRequest {
/// REQUIRED: The complete policy to be applied to the resource.
///
/// The size of the policy is limited to a few 10s of KB. An empty policy is a
/// valid policy but certain Cloud Platform services (such as Projects) might
/// reject them.
Policy policy;
SetIamPolicyRequest();
SetIamPolicyRequest.fromJson(core.Map _json) {
if (_json.containsKey('policy')) {
policy = Policy.fromJson(
_json['policy'] as core.Map<core.String, core.dynamic>);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (policy != null) {
_json['policy'] = policy.toJson();
}
return _json;
}
}
/// Shielded Instance Config for clusters using Compute Engine Shielded VMs
/// (https://cloud.google.com/security/shielded-cloud/shielded-vm).
class ShieldedInstanceConfig {
/// Defines whether instances have integrity monitoring enabled.
///
/// Optional.
core.bool enableIntegrityMonitoring;
/// Defines whether instances have Secure Boot enabled.
///
/// Optional.
core.bool enableSecureBoot;
/// Defines whether instances have the vTPM enabled.
///
/// Optional.
core.bool enableVtpm;
ShieldedInstanceConfig();
ShieldedInstanceConfig.fromJson(core.Map _json) {
if (_json.containsKey('enableIntegrityMonitoring')) {
enableIntegrityMonitoring =
_json['enableIntegrityMonitoring'] as core.bool;
}
if (_json.containsKey('enableSecureBoot')) {
enableSecureBoot = _json['enableSecureBoot'] as core.bool;
}
if (_json.containsKey('enableVtpm')) {
enableVtpm = _json['enableVtpm'] as core.bool;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (enableIntegrityMonitoring != null) {
_json['enableIntegrityMonitoring'] = enableIntegrityMonitoring;
}
if (enableSecureBoot != null) {
_json['enableSecureBoot'] = enableSecureBoot;
}
if (enableVtpm != null) {
_json['enableVtpm'] = enableVtpm;
}
return _json;
}
}
/// Specifies the selection and config of software inside the cluster.
class SoftwareConfig {
/// The version of software inside the cluster.
///
/// It must be one of the supported Dataproc Versions
/// (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_dataproc_versions),
/// such as "1.2" (including a subminor version, such as "1.2.29"), or the
/// "preview" version
/// (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions).
/// If unspecified, it defaults to the latest Debian version.
///
/// Optional.
core.String imageVersion;
/// The set of components to activate on the cluster.
///
/// Optional.
core.List<core.String> optionalComponents;
/// The properties to set on daemon config files.Property keys are specified
/// in prefix:property format, for example core:hadoop.tmp.dir.
///
/// 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
/// (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
///
/// Optional.
core.Map<core.String, core.String> properties;
SoftwareConfig();
SoftwareConfig.fromJson(core.Map _json) {
if (_json.containsKey('imageVersion')) {
imageVersion = _json['imageVersion'] as core.String;
}
if (_json.containsKey('optionalComponents')) {
optionalComponents = (_json['optionalComponents'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('properties')) {
properties = (_json['properties'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (imageVersion != null) {
_json['imageVersion'] = imageVersion;
}
if (optionalComponents != null) {
_json['optionalComponents'] = optionalComponents;
}
if (properties != null) {
_json['properties'] = properties;
}
return _json;
}
}
/// A Dataproc job for running Apache Spark (http://spark.apache.org/)
/// applications on YARN.
class SparkJob {
/// HCFS URIs of archives to be extracted into the working directory of each
/// executor.
///
/// Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
///
/// Optional.
core.List<core.String> archiveUris;
/// 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.
///
/// Optional.
core.List<core.String> args;
/// HCFS URIs of files to be placed in the working directory of each executor.
///
/// Useful for naively parallel tasks.
///
/// Optional.
core.List<core.String> fileUris;
/// HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and
/// tasks.
///
/// Optional.
core.List<core.String> jarFileUris;
/// The runtime log config for job execution.
///
/// Optional.
LoggingConfig 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.
core.String mainClass;
/// The HCFS URI of the jar file that contains the main class.
core.String mainJarFileUri;
/// A mapping of property names to values, used to configure Spark.
///
/// Properties that conflict with values set by the Dataproc API may be
/// overwritten. Can include properties set in
/// /etc/spark/conf/spark-defaults.conf and classes in user code.
///
/// Optional.
core.Map<core.String, core.String> properties;
SparkJob();
SparkJob.fromJson(core.Map _json) {
if (_json.containsKey('archiveUris')) {
archiveUris = (_json['archiveUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('args')) {
args = (_json['args'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('fileUris')) {
fileUris = (_json['fileUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('jarFileUris')) {
jarFileUris = (_json['jarFileUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('loggingConfig')) {
loggingConfig = LoggingConfig.fromJson(
_json['loggingConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('mainClass')) {
mainClass = _json['mainClass'] as core.String;
}
if (_json.containsKey('mainJarFileUri')) {
mainJarFileUri = _json['mainJarFileUri'] as core.String;
}
if (_json.containsKey('properties')) {
properties = (_json['properties'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (archiveUris != null) {
_json['archiveUris'] = archiveUris;
}
if (args != null) {
_json['args'] = args;
}
if (fileUris != null) {
_json['fileUris'] = fileUris;
}
if (jarFileUris != null) {
_json['jarFileUris'] = jarFileUris;
}
if (loggingConfig != null) {
_json['loggingConfig'] = loggingConfig.toJson();
}
if (mainClass != null) {
_json['mainClass'] = mainClass;
}
if (mainJarFileUri != null) {
_json['mainJarFileUri'] = mainJarFileUri;
}
if (properties != null) {
_json['properties'] = properties;
}
return _json;
}
}
/// A Dataproc job for running Apache SparkR
/// (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN.
class SparkRJob {
/// HCFS URIs of archives to be extracted into the working directory of each
/// executor.
///
/// Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
///
/// Optional.
core.List<core.String> archiveUris;
/// 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.
///
/// Optional.
core.List<core.String> args;
/// HCFS URIs of files to be placed in the working directory of each executor.
///
/// Useful for naively parallel tasks.
///
/// Optional.
core.List<core.String> fileUris;
/// The runtime log config for job execution.
///
/// Optional.
LoggingConfig loggingConfig;
/// The HCFS URI of the main R file to use as the driver.
///
/// Must be a .R file.
///
/// Required.
core.String mainRFileUri;
/// A mapping of property names to values, used to configure SparkR.
///
/// Properties that conflict with values set by the Dataproc API may be
/// overwritten. Can include properties set in
/// /etc/spark/conf/spark-defaults.conf and classes in user code.
///
/// Optional.
core.Map<core.String, core.String> properties;
SparkRJob();
SparkRJob.fromJson(core.Map _json) {
if (_json.containsKey('archiveUris')) {
archiveUris = (_json['archiveUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('args')) {
args = (_json['args'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('fileUris')) {
fileUris = (_json['fileUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('loggingConfig')) {
loggingConfig = LoggingConfig.fromJson(
_json['loggingConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('mainRFileUri')) {
mainRFileUri = _json['mainRFileUri'] as core.String;
}
if (_json.containsKey('properties')) {
properties = (_json['properties'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (archiveUris != null) {
_json['archiveUris'] = archiveUris;
}
if (args != null) {
_json['args'] = args;
}
if (fileUris != null) {
_json['fileUris'] = fileUris;
}
if (loggingConfig != null) {
_json['loggingConfig'] = loggingConfig.toJson();
}
if (mainRFileUri != null) {
_json['mainRFileUri'] = mainRFileUri;
}
if (properties != null) {
_json['properties'] = properties;
}
return _json;
}
}
/// A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/)
/// queries.
class SparkSqlJob {
/// HCFS URIs of jar files to be added to the Spark CLASSPATH.
///
/// Optional.
core.List<core.String> jarFileUris;
/// The runtime log config for job execution.
///
/// Optional.
LoggingConfig loggingConfig;
/// A mapping of property names to values, used to configure Spark SQL's
/// SparkConf.
///
/// Properties that conflict with values set by the Dataproc API may be
/// overwritten.
///
/// Optional.
core.Map<core.String, core.String> properties;
/// The HCFS URI of the script that contains SQL queries.
core.String queryFileUri;
/// A list of queries.
QueryList queryList;
/// Mapping of query variable names to values (equivalent to the Spark SQL
/// command: SET name="value";).
///
/// Optional.
core.Map<core.String, core.String> scriptVariables;
SparkSqlJob();
SparkSqlJob.fromJson(core.Map _json) {
if (_json.containsKey('jarFileUris')) {
jarFileUris = (_json['jarFileUris'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('loggingConfig')) {
loggingConfig = LoggingConfig.fromJson(
_json['loggingConfig'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('properties')) {
properties = (_json['properties'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('queryFileUri')) {
queryFileUri = _json['queryFileUri'] as core.String;
}
if (_json.containsKey('queryList')) {
queryList = QueryList.fromJson(
_json['queryList'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('scriptVariables')) {
scriptVariables = (_json['scriptVariables'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (jarFileUris != null) {
_json['jarFileUris'] = jarFileUris;
}
if (loggingConfig != null) {
_json['loggingConfig'] = loggingConfig.toJson();
}
if (properties != null) {
_json['properties'] = properties;
}
if (queryFileUri != null) {
_json['queryFileUri'] = queryFileUri;
}
if (queryList != null) {
_json['queryList'] = queryList.toJson();
}
if (scriptVariables != null) {
_json['scriptVariables'] = scriptVariables;
}
return _json;
}
}
/// 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). Each Status message contains
/// three pieces of data: error code, error message, and error details.You can
/// find out more about this error model and how to work with it in the API
/// Design Guide (https://cloud.google.com/apis/design/errors).
class Status {
/// The status code, which should be an enum value of google.rpc.Code.
core.int code;
/// A list of messages that carry the error details.
///
/// There is a common set of message types for APIs to use.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.List<core.Map<core.String, core.Object>> details;
/// 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.
core.String message;
Status();
Status.fromJson(core.Map _json) {
if (_json.containsKey('code')) {
code = _json['code'] as core.int;
}
if (_json.containsKey('details')) {
details = (_json['details'] as core.List)
.map<core.Map<core.String, core.Object>>((value) =>
(value as core.Map).cast<core.String, core.Object>().map(
(key, item) => core.MapEntry(
key,
item as core.Object,
),
))
.toList();
}
if (_json.containsKey('message')) {
message = _json['message'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (code != null) {
_json['code'] = code;
}
if (details != null) {
_json['details'] = details;
}
if (message != null) {
_json['message'] = message;
}
return _json;
}
}
/// A request to submit a job.
class SubmitJobRequest {
/// The job resource.
///
/// Required.
Job job;
/// 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.
///
/// Optional.
core.String requestId;
SubmitJobRequest();
SubmitJobRequest.fromJson(core.Map _json) {
if (_json.containsKey('job')) {
job = Job.fromJson(_json['job'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('requestId')) {
requestId = _json['requestId'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (job != null) {
_json['job'] = job.toJson();
}
if (requestId != null) {
_json['requestId'] = requestId;
}
return _json;
}
}
/// A configurable parameter that replaces one or more fields in the template.
///
/// Parameterizable fields: - Labels - File uris - Job properties - Job
/// arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone
/// (in ClusterSelector)
class TemplateParameter {
/// Brief description of the parameter.
///
/// Must not exceed 1024 characters.
///
/// Optional.
core.String description;
/// Paths to all fields that the parameter replaces.
///
/// A field is allowed to appear in at most one parameter's list of field
/// paths.A field path is similar in syntax to a google.protobuf.FieldMask.
/// For example, a field path that references the zone field of a workflow
/// template's cluster selector would be specified as
/// placement.clusterSelector.zone.Also, field paths can reference fields
/// using the following syntax: Values in maps can be referenced by key:
/// labels'key' placement.clusterSelector.clusterLabels'key'
/// placement.managedCluster.labels'key'
/// placement.clusterSelector.clusterLabels'key' jobs'step-id'.labels'key'
/// Jobs in the jobs list can be referenced by step-id:
/// jobs'step-id'.hadoopJob.mainJarFileUri jobs'step-id'.hiveJob.queryFileUri
/// jobs'step-id'.pySparkJob.mainPythonFileUri
/// jobs'step-id'.hadoopJob.jarFileUris0 jobs'step-id'.hadoopJob.archiveUris0
/// jobs'step-id'.hadoopJob.fileUris0 jobs'step-id'.pySparkJob.pythonFileUris0
/// Items in repeated fields can be referenced by a zero-based index:
/// jobs'step-id'.sparkJob.args0 Other examples:
/// jobs'step-id'.hadoopJob.properties'key' jobs'step-id'.hadoopJob.args0
/// jobs'step-id'.hiveJob.scriptVariables'key'
/// jobs'step-id'.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt
/// may not be possible to parameterize maps and repeated fields in their
/// entirety since only individual map values and individual items in repeated
/// fields can be referenced. For example, the following field paths are
/// invalid: placement.clusterSelector.clusterLabels
/// jobs'step-id'.sparkJob.args
///
/// Required.
core.List<core.String> fields;
/// Parameter name.
///
/// The parameter name is used as the key, and paired with the parameter
/// value, which are passed to the template when the template is instantiated.
/// The name must contain only capital letters (A-Z), numbers (0-9), and
/// underscores (_), and must not start with a number. The maximum length is
/// 40 characters.
///
/// Required.
core.String name;
/// Validation rules to be applied to this parameter's value.
///
/// Optional.
ParameterValidation validation;
TemplateParameter();
TemplateParameter.fromJson(core.Map _json) {
if (_json.containsKey('description')) {
description = _json['description'] as core.String;
}
if (_json.containsKey('fields')) {
fields = (_json['fields'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('name')) {
name = _json['name'] as core.String;
}
if (_json.containsKey('validation')) {
validation = ParameterValidation.fromJson(
_json['validation'] as core.Map<core.String, core.dynamic>);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (description != null) {
_json['description'] = description;
}
if (fields != null) {
_json['fields'] = fields;
}
if (name != null) {
_json['name'] = name;
}
if (validation != null) {
_json['validation'] = validation.toJson();
}
return _json;
}
}
/// Request message for TestIamPermissions method.
class TestIamPermissionsRequest {
/// The set of permissions to check for the resource.
///
/// Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
/// For more information see IAM Overview
/// (https://cloud.google.com/iam/docs/overview#permissions).
core.List<core.String> permissions;
TestIamPermissionsRequest();
TestIamPermissionsRequest.fromJson(core.Map _json) {
if (_json.containsKey('permissions')) {
permissions = (_json['permissions'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (permissions != null) {
_json['permissions'] = permissions;
}
return _json;
}
}
/// Response message for TestIamPermissions method.
class TestIamPermissionsResponse {
/// A subset of TestPermissionsRequest.permissions that the caller is allowed.
core.List<core.String> permissions;
TestIamPermissionsResponse();
TestIamPermissionsResponse.fromJson(core.Map _json) {
if (_json.containsKey('permissions')) {
permissions = (_json['permissions'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (permissions != null) {
_json['permissions'] = permissions;
}
return _json;
}
}
/// Validation based on a list of allowed values.
class ValueValidation {
/// List of allowed values for the parameter.
///
/// Required.
core.List<core.String> values;
ValueValidation();
ValueValidation.fromJson(core.Map _json) {
if (_json.containsKey('values')) {
values = (_json['values'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (values != null) {
_json['values'] = values;
}
return _json;
}
}
/// The workflow graph.
class WorkflowGraph {
/// The workflow nodes.
///
/// Output only.
core.List<WorkflowNode> nodes;
WorkflowGraph();
WorkflowGraph.fromJson(core.Map _json) {
if (_json.containsKey('nodes')) {
nodes = (_json['nodes'] as core.List)
.map<WorkflowNode>((value) => WorkflowNode.fromJson(
value as core.Map<core.String, core.dynamic>))
.toList();
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (nodes != null) {
_json['nodes'] = nodes.map((value) => value.toJson()).toList();
}
return _json;
}
}
/// A Dataproc workflow template resource.
class WorkflowMetadata {
/// The name of the target cluster.
///
/// Output only.
core.String clusterName;
/// The UUID of target cluster.
///
/// Output only.
core.String clusterUuid;
/// The create cluster operation metadata.
///
/// Output only.
ClusterOperation createCluster;
/// DAG end time, only set for workflows with dag_timeout when DAG ends.
///
/// Output only.
core.String dagEndTime;
/// DAG start time, only set for workflows with dag_timeout when DAG begins.
///
/// Output only.
core.String dagStartTime;
/// The timeout duration for the DAG of jobs, expressed in seconds (see JSON
/// representation of duration
/// (https://developers.google.com/protocol-buffers/docs/proto3#json)).
///
/// Output only.
core.String dagTimeout;
/// The delete cluster operation metadata.
///
/// Output only.
ClusterOperation deleteCluster;
/// Workflow end time.
///
/// Output only.
core.String endTime;
/// The workflow graph.
///
/// Output only.
WorkflowGraph graph;
/// Map from parameter names to values that were used for those parameters.
core.Map<core.String, core.String> parameters;
/// Workflow start time.
///
/// Output only.
core.String startTime;
/// The workflow state.
///
/// Output only.
/// Possible string values are:
/// - "UNKNOWN" : Unused.
/// - "PENDING" : The operation has been created.
/// - "RUNNING" : The operation is running.
/// - "DONE" : The operation is done; either cancelled or completed.
core.String state;
/// The resource name of the workflow template as described in
/// https://cloud.google.com/apis/design/resource_names.
///
/// For projects.regions.workflowTemplates, the resource name of the template
/// has the following format:
/// projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
/// projects.locations.workflowTemplates, the resource name of the template
/// has the following format:
/// projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
///
/// Output only.
core.String template;
/// The version of template at the time of workflow instantiation.
///
/// Output only.
core.int version;
WorkflowMetadata();
WorkflowMetadata.fromJson(core.Map _json) {
if (_json.containsKey('clusterName')) {
clusterName = _json['clusterName'] as core.String;
}
if (_json.containsKey('clusterUuid')) {
clusterUuid = _json['clusterUuid'] as core.String;
}
if (_json.containsKey('createCluster')) {
createCluster = ClusterOperation.fromJson(
_json['createCluster'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('dagEndTime')) {
dagEndTime = _json['dagEndTime'] as core.String;
}
if (_json.containsKey('dagStartTime')) {
dagStartTime = _json['dagStartTime'] as core.String;
}
if (_json.containsKey('dagTimeout')) {
dagTimeout = _json['dagTimeout'] as core.String;
}
if (_json.containsKey('deleteCluster')) {
deleteCluster = ClusterOperation.fromJson(
_json['deleteCluster'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('endTime')) {
endTime = _json['endTime'] as core.String;
}
if (_json.containsKey('graph')) {
graph = WorkflowGraph.fromJson(
_json['graph'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('parameters')) {
parameters = (_json['parameters'] as core.Map)
.cast<core.String, core.String>()
.map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('startTime')) {
startTime = _json['startTime'] as core.String;
}
if (_json.containsKey('state')) {
state = _json['state'] as core.String;
}
if (_json.containsKey('template')) {
template = _json['template'] as core.String;
}
if (_json.containsKey('version')) {
version = _json['version'] as core.int;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (clusterName != null) {
_json['clusterName'] = clusterName;
}
if (clusterUuid != null) {
_json['clusterUuid'] = clusterUuid;
}
if (createCluster != null) {
_json['createCluster'] = createCluster.toJson();
}
if (dagEndTime != null) {
_json['dagEndTime'] = dagEndTime;
}
if (dagStartTime != null) {
_json['dagStartTime'] = dagStartTime;
}
if (dagTimeout != null) {
_json['dagTimeout'] = dagTimeout;
}
if (deleteCluster != null) {
_json['deleteCluster'] = deleteCluster.toJson();
}
if (endTime != null) {
_json['endTime'] = endTime;
}
if (graph != null) {
_json['graph'] = graph.toJson();
}
if (parameters != null) {
_json['parameters'] = parameters;
}
if (startTime != null) {
_json['startTime'] = startTime;
}
if (state != null) {
_json['state'] = state;
}
if (template != null) {
_json['template'] = template;
}
if (version != null) {
_json['version'] = version;
}
return _json;
}
}
/// The workflow node.
class WorkflowNode {
/// The error detail.
///
/// Output only.
core.String error;
/// The job id; populated after the node enters RUNNING state.
///
/// Output only.
core.String jobId;
/// Node's prerequisite nodes.
///
/// Output only.
core.List<core.String> prerequisiteStepIds;
/// The node state.
///
/// Output only.
/// Possible string values are:
/// - "NODE_STATE_UNSPECIFIED" : State is unspecified.
/// - "BLOCKED" : The node is awaiting prerequisite node to finish.
/// - "RUNNABLE" : The node is runnable but not running.
/// - "RUNNING" : The node is running.
/// - "COMPLETED" : The node completed successfully.
/// - "FAILED" : The node failed. A node can be marked FAILED because its
/// ancestor or peer failed.
core.String state;
/// The name of the node.
///
/// Output only.
core.String stepId;
WorkflowNode();
WorkflowNode.fromJson(core.Map _json) {
if (_json.containsKey('error')) {
error = _json['error'] as core.String;
}
if (_json.containsKey('jobId')) {
jobId = _json['jobId'] as core.String;
}
if (_json.containsKey('prerequisiteStepIds')) {
prerequisiteStepIds = (_json['prerequisiteStepIds'] as core.List)
.map<core.String>((value) => value as core.String)
.toList();
}
if (_json.containsKey('state')) {
state = _json['state'] as core.String;
}
if (_json.containsKey('stepId')) {
stepId = _json['stepId'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (error != null) {
_json['error'] = error;
}
if (jobId != null) {
_json['jobId'] = jobId;
}
if (prerequisiteStepIds != null) {
_json['prerequisiteStepIds'] = prerequisiteStepIds;
}
if (state != null) {
_json['state'] = state;
}
if (stepId != null) {
_json['stepId'] = stepId;
}
return _json;
}
}
/// A Dataproc workflow template resource.
class WorkflowTemplate {
/// The time template was created.
///
/// Output only.
core.String createTime;
/// Timeout duration for the DAG of jobs, expressed in seconds (see JSON
/// representation of duration
/// (https://developers.google.com/protocol-buffers/docs/proto3#json)).
///
/// The timeout duration must be from 10 minutes ("600s") to 24 hours
/// ("86400s"). The timer begins when the first job is submitted. If the
/// workflow is running at the end of the timeout period, any remaining jobs
/// are cancelled, the workflow is ended, and if the workflow was running on a
/// managed cluster, the cluster is deleted.
///
/// Optional.
core.String dagTimeout;
core.String id;
/// The Directed Acyclic Graph of Jobs to submit.
///
/// Required.
core.List<OrderedJob> jobs;
/// The labels to associate with this template.
///
/// These labels will be propagated to all jobs and clusters created by the
/// workflow instance.Label keys must contain 1 to 63 characters, and must
/// conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values
/// may be empty, but, if present, must contain 1 to 63 characters, and must
/// conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32
/// labels can be associated with a template.
///
/// Optional.
core.Map<core.String, core.String> labels;
/// The resource name of the workflow template, as described in
/// https://cloud.google.com/apis/design/resource_names.
///
/// For projects.regions.workflowTemplates, the resource name of the template
/// has the following format:
/// projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
/// projects.locations.workflowTemplates, the resource name of the template
/// has the following format:
/// projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
///
/// Output only.
core.String name;
/// Template parameters whose values are substituted into the template.
///
/// Values for parameters must be provided when the template is instantiated.
///
/// Optional.
core.List<TemplateParameter> parameters;
/// WorkflowTemplate scheduling information.
///
/// Required.
WorkflowTemplatePlacement placement;
/// The time template was last updated.
///
/// Output only.
core.String updateTime;
/// Used to perform a consistent read-modify-write.This field should be left
/// blank for a CreateWorkflowTemplate request.
///
/// It is required for an UpdateWorkflowTemplate request, and must match the
/// current server version. A typical update template flow would fetch the
/// current template with a GetWorkflowTemplate request, which will return the
/// current template with the version field filled in with the current server
/// version. The user updates other fields in the template, then returns it as
/// part of the UpdateWorkflowTemplate request.
///
/// Optional.
core.int version;
WorkflowTemplate();
WorkflowTemplate.fromJson(core.Map _json) {
if (_json.containsKey('createTime')) {
createTime = _json['createTime'] as core.String;
}
if (_json.containsKey('dagTimeout')) {
dagTimeout = _json['dagTimeout'] as core.String;
}
if (_json.containsKey('id')) {
id = _json['id'] as core.String;
}
if (_json.containsKey('jobs')) {
jobs = (_json['jobs'] as core.List)
.map<OrderedJob>((value) =>
OrderedJob.fromJson(value as core.Map<core.String, core.dynamic>))
.toList();
}
if (_json.containsKey('labels')) {
labels =
(_json['labels'] as core.Map).cast<core.String, core.String>().map(
(key, item) => core.MapEntry(
key,
item as core.String,
),
);
}
if (_json.containsKey('name')) {
name = _json['name'] as core.String;
}
if (_json.containsKey('parameters')) {
parameters = (_json['parameters'] as core.List)
.map<TemplateParameter>((value) => TemplateParameter.fromJson(
value as core.Map<core.String, core.dynamic>))
.toList();
}
if (_json.containsKey('placement')) {
placement = WorkflowTemplatePlacement.fromJson(
_json['placement'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('updateTime')) {
updateTime = _json['updateTime'] as core.String;
}
if (_json.containsKey('version')) {
version = _json['version'] as core.int;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (createTime != null) {
_json['createTime'] = createTime;
}
if (dagTimeout != null) {
_json['dagTimeout'] = dagTimeout;
}
if (id != null) {
_json['id'] = id;
}
if (jobs != null) {
_json['jobs'] = jobs.map((value) => value.toJson()).toList();
}
if (labels != null) {
_json['labels'] = labels;
}
if (name != null) {
_json['name'] = name;
}
if (parameters != null) {
_json['parameters'] = parameters.map((value) => value.toJson()).toList();
}
if (placement != null) {
_json['placement'] = placement.toJson();
}
if (updateTime != null) {
_json['updateTime'] = updateTime;
}
if (version != null) {
_json['version'] = version;
}
return _json;
}
}
/// Specifies workflow execution target.Either managed_cluster or
/// cluster_selector is required.
class WorkflowTemplatePlacement {
/// A selector that chooses target cluster for jobs based on metadata.The
/// selector is evaluated at the time each job is submitted.
///
/// Optional.
ClusterSelector clusterSelector;
/// A cluster that is managed by the workflow.
ManagedCluster managedCluster;
WorkflowTemplatePlacement();
WorkflowTemplatePlacement.fromJson(core.Map _json) {
if (_json.containsKey('clusterSelector')) {
clusterSelector = ClusterSelector.fromJson(
_json['clusterSelector'] as core.Map<core.String, core.dynamic>);
}
if (_json.containsKey('managedCluster')) {
managedCluster = ManagedCluster.fromJson(
_json['managedCluster'] as core.Map<core.String, core.dynamic>);
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (clusterSelector != null) {
_json['clusterSelector'] = clusterSelector.toJson();
}
if (managedCluster != null) {
_json['managedCluster'] = managedCluster.toJson();
}
return _json;
}
}
/// A YARN application created by a job.
///
/// Application information is a subset of
/// org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature:
/// This report is available for testing purposes only. It may be changed before
/// final release.
class YarnApplication {
/// The application name.
///
/// Required.
core.String name;
/// The numerical progress of the application, from 1 to 100.
///
/// Required.
core.double progress;
/// The application state.
///
/// Required.
/// Possible string values are:
/// - "STATE_UNSPECIFIED" : Status is unspecified.
/// - "NEW" : Status is NEW.
/// - "NEW_SAVING" : Status is NEW_SAVING.
/// - "SUBMITTED" : Status is SUBMITTED.
/// - "ACCEPTED" : Status is ACCEPTED.
/// - "RUNNING" : Status is RUNNING.
/// - "FINISHED" : Status is FINISHED.
/// - "FAILED" : Status is FAILED.
/// - "KILLED" : Status is KILLED.
core.String state;
/// 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.
///
/// Optional.
core.String trackingUrl;
YarnApplication();
YarnApplication.fromJson(core.Map _json) {
if (_json.containsKey('name')) {
name = _json['name'] as core.String;
}
if (_json.containsKey('progress')) {
progress = (_json['progress'] as core.num).toDouble();
}
if (_json.containsKey('state')) {
state = _json['state'] as core.String;
}
if (_json.containsKey('trackingUrl')) {
trackingUrl = _json['trackingUrl'] as core.String;
}
}
core.Map<core.String, core.Object> toJson() {
final _json = <core.String, core.Object>{};
if (name != null) {
_json['name'] = name;
}
if (progress != null) {
_json['progress'] = progress;
}
if (state != null) {
_json['state'] = state;
}
if (trackingUrl != null) {
_json['trackingUrl'] = trackingUrl;
}
return _json;
}
}