Class: Google::Apis::DataprocV1beta2::DataprocService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/dataproc_v1beta2/service.rb

Overview

Cloud Dataproc API

Manages Hadoop-based clusters and jobs on Google Cloud Platform.

Examples:

require 'google/apis/dataproc_v1beta2'

Dataproc = Google::Apis::DataprocV1beta2 # Alias the module
service = Dataproc::DataprocService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ DataprocService

Returns a new instance of DataprocService



45
46
47
48
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 45

def initialize
  super('https://dataproc.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#cancel_job(project_id, region, job_id, cancel_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Job

Starts a job cancellation request. To access the job resource after cancellation, call regions/region/jobs.list or regions/region/jobs.get.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project that the job belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • job_id (String) —

    Required. The job ID.

  • cancel_job_request_object (Google::Apis::DataprocV1beta2::CancelJobRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1485

def cancel_job(project_id, region, job_id, cancel_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel', options)
  command.request_representation = Google::Apis::DataprocV1beta2::CancelJobRequest::Representation
  command.request_object = cancel_job_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Job::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Job
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.params['jobId'] = job_id unless job_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_region_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Empty

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.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1848
1849
1850
1851
1852
1853
1854
1855
1856
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1848

def cancel_project_region_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+name}:cancel', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_autoscaling_policy(parent, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::AutoscalingPolicy

Creates new autoscaling policy.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region, as described in https://cloud. google.com/apis/design/resource_names of the form projects/project_id/ regions/region.

  • autoscaling_policy_object (Google::Apis::DataprocV1beta2::AutoscalingPolicy) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



73
74
75
76
77
78
79
80
81
82
83
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 73

def create_project_location_autoscaling_policy(parent, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+parent}/autoscalingPolicies', options)
  command.request_representation = Google::Apis::DataprocV1beta2::AutoscalingPolicy::Representation
  command.request_object = autoscaling_policy_object
  command.response_representation = Google::Apis::DataprocV1beta2::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::AutoscalingPolicy
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_workflow_template(parent, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::WorkflowTemplate

Creates new workflow template.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region, as described in https://cloud. google.com/apis/design/resource_names of the form projects/project_id/ regions/region

  • workflow_template_object (Google::Apis::DataprocV1beta2::WorkflowTemplate) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



359
360
361
362
363
364
365
366
367
368
369
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 359

def create_project_location_workflow_template(parent, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+parent}/workflowTemplates', options)
  command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_region_autoscaling_policy(parent, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::AutoscalingPolicy

Creates new autoscaling policy.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region, as described in https://cloud. google.com/apis/design/resource_names of the form projects/project_id/ regions/region.

  • autoscaling_policy_object (Google::Apis::DataprocV1beta2::AutoscalingPolicy) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



747
748
749
750
751
752
753
754
755
756
757
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 747

def create_project_region_autoscaling_policy(parent, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+parent}/autoscalingPolicies', options)
  command.request_representation = Google::Apis::DataprocV1beta2::AutoscalingPolicy::Representation
  command.request_object = autoscaling_policy_object
  command.response_representation = Google::Apis::DataprocV1beta2::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::AutoscalingPolicy
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_region_cluster(project_id, region, cluster_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Operation

Creates a cluster in a project.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project that the cluster belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • cluster_object (Google::Apis::DataprocV1beta2::Cluster) (defaults to: nil)
  • request_id (String) —

    Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID ( https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (- ). The maximum length is 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1042

def create_project_region_cluster(project_id, region, cluster_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/projects/{projectId}/regions/{region}/clusters', options)
  command.request_representation = Google::Apis::DataprocV1beta2::Cluster::Representation
  command.request_object = cluster_object
  command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_region_workflow_template(parent, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::WorkflowTemplate

Creates new workflow template.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region, as described in https://cloud. google.com/apis/design/resource_names of the form projects/project_id/ regions/region

  • workflow_template_object (Google::Apis::DataprocV1beta2::WorkflowTemplate) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2101

def create_project_region_workflow_template(parent, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+parent}/workflowTemplates', options)
  command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Empty

Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.

Parameters:

  • name (String) —

    Required. The "resource name" of the autoscaling policy, as described in https: //cloud.google.com/apis/design/resource_names of the form projects/project_id /regions/region/autoscalingPolicies/policy_id.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



108
109
110
111
112
113
114
115
116
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 108

def delete_project_location_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Empty

Deletes a workflow template. It does not cancel in-progress workflows.

Parameters:

  • name (String) —

    Required. The "resource name" of the workflow template, as described in https:/ /cloud.google.com/apis/design/resource_names of the form projects/project_id/ regions/region/workflowTemplates/template_id

  • version (Fixnum) —

    Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



396
397
398
399
400
401
402
403
404
405
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 396

def delete_project_location_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Empty
  command.params['name'] = name unless name.nil?
  command.query['version'] = version unless version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_region_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Empty

Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.

Parameters:

  • name (String) —

    Required. The "resource name" of the autoscaling policy, as described in https: //cloud.google.com/apis/design/resource_names of the form projects/project_id /regions/region/autoscalingPolicies/policy_id.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



782
783
784
785
786
787
788
789
790
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 782

def delete_project_region_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_region_cluster(project_id, region, cluster_name, cluster_uuid: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Operation

Deletes a cluster in a project.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project that the cluster belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • cluster_name (String) —

    Required. The cluster name.

  • cluster_uuid (String) —

    Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.

  • request_id (String) —

    Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID ( https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (- ). The maximum length is 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1092

def delete_project_region_cluster(project_id, region, cluster_name, cluster_uuid: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.params['clusterName'] = cluster_name unless cluster_name.nil?
  command.query['clusterUuid'] = cluster_uuid unless cluster_uuid.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_region_job(project_id, region, job_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Empty

Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project that the job belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • job_id (String) —

    Required. The job ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1524

def delete_project_region_job(project_id, region, job_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Empty
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.params['jobId'] = job_id unless job_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_region_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Empty

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.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1881
1882
1883
1884
1885
1886
1887
1888
1889
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1881

def delete_project_region_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_region_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Empty

Deletes a workflow template. It does not cancel in-progress workflows.

Parameters:

  • name (String) —

    Required. The "resource name" of the workflow template, as described in https:/ /cloud.google.com/apis/design/resource_names of the form projects/project_id/ regions/region/workflowTemplates/template_id

  • version (Fixnum) —

    Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2138

def delete_project_region_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Empty::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Empty
  command.params['name'] = name unless name.nil?
  command.query['version'] = version unless version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#diagnose_cluster(project_id, region, cluster_name, diagnose_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Operation

Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project that the cluster belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • cluster_name (String) —

    Required. The cluster name.

  • diagnose_cluster_request_object (Google::Apis::DataprocV1beta2::DiagnoseClusterRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1133

def diagnose_cluster(project_id, region, cluster_name, diagnose_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose', options)
  command.request_representation = Google::Apis::DataprocV1beta2::DiagnoseClusterRequest::Representation
  command.request_object = diagnose_cluster_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.params['clusterName'] = cluster_name unless cluster_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_autoscaling_policy_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) —

    Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



850
851
852
853
854
855
856
857
858
859
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 850

def get_autoscaling_policy_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::AutoscalingPolicy

Retrieves autoscaling policy.

Parameters:

  • name (String) —

    Required. The "resource name" of the autoscaling policy, as described in https: //cloud.google.com/apis/design/resource_names of the form projects/project_id /regions/region/autoscalingPolicies/policy_id.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



140
141
142
143
144
145
146
147
148
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 140

def get_project_location_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::AutoscalingPolicy
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_autoscaling_policy_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) —

    Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



176
177
178
179
180
181
182
183
184
185
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 176

def get_project_location_autoscaling_policy_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::WorkflowTemplate

Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.

Parameters:

  • name (String) —

    Required. The "resource name" of the workflow template, as described in https:/ /cloud.google.com/apis/design/resource_names of the form projects/project_id/ regions/region/workflowTemplates/template_id

  • version (Fixnum) —

    Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



434
435
436
437
438
439
440
441
442
443
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 434

def get_project_location_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate
  command.params['name'] = name unless name.nil?
  command.query['version'] = version unless version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_workflow_template_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) —

    Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



471
472
473
474
475
476
477
478
479
480
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 471

def get_project_location_workflow_template_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_region_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::AutoscalingPolicy

Retrieves autoscaling policy.

Parameters:

  • name (String) —

    Required. The "resource name" of the autoscaling policy, as described in https: //cloud.google.com/apis/design/resource_names of the form projects/project_id /regions/region/autoscalingPolicies/policy_id.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



814
815
816
817
818
819
820
821
822
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 814

def get_project_region_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::AutoscalingPolicy
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_region_cluster(project_id, region, cluster_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Cluster

Gets the resource representation for a cluster in a project.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project that the cluster belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • cluster_name (String) —

    Required. The cluster name.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1172

def get_project_region_cluster(project_id, region, cluster_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Cluster::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Cluster
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.params['clusterName'] = cluster_name unless cluster_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_region_cluster_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) —

    Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1210

def get_project_region_cluster_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_region_job(project_id, region, job_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Job

Gets the resource representation for a job in a project.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project that the job belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • job_id (String) —

    Required. The job ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1560

def get_project_region_job(project_id, region, job_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Job::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Job
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.params['jobId'] = job_id unless job_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_region_job_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) —

    Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1598

def get_project_region_job_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_region_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Operation

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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1912
1913
1914
1915
1916
1917
1918
1919
1920
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1912

def get_project_region_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_region_operation_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) —

    Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1948

def get_project_region_operation_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_region_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::WorkflowTemplate

Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.

Parameters:

  • name (String) —

    Required. The "resource name" of the workflow template, as described in https:/ /cloud.google.com/apis/design/resource_names of the form projects/project_id/ regions/region/workflowTemplates/template_id

  • version (Fixnum) —

    Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2176

def get_project_region_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate
  command.params['name'] = name unless name.nil?
  command.query['version'] = version unless version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_region_workflow_template_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) —

    Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2213

def get_project_region_workflow_template_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#instantiate_project_location_workflow_template(name, instantiate_workflow_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Operation

Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

Parameters:

  • name (String) —

    Required. The "resource name" of the workflow template, as described in https:/ /cloud.google.com/apis/design/resource_names of the form projects/project_id/ regions/region/workflowTemplates/template_id

  • instantiate_workflow_template_request_object (Google::Apis::DataprocV1beta2::InstantiateWorkflowTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



511
512
513
514
515
516
517
518
519
520
521
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 511

def instantiate_project_location_workflow_template(name, instantiate_workflow_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+name}:instantiate', options)
  command.request_representation = Google::Apis::DataprocV1beta2::InstantiateWorkflowTemplateRequest::Representation
  command.request_object = instantiate_workflow_template_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#instantiate_project_location_workflow_template_inline(parent, workflow_template_object = nil, instance_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Operation

Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

Parameters:

  • parent (String) —

    Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/ project_id/regions/region

  • workflow_template_object (Google::Apis::DataprocV1beta2::WorkflowTemplate) (defaults to: nil)
  • instance_id (String) —

    Deprecated. Please use request_id field instead.

  • request_id (String) —

    Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en. wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 562

def instantiate_project_location_workflow_template_inline(parent, workflow_template_object = nil, instance_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+parent}/workflowTemplates:instantiateInline', options)
  command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['instanceId'] = instance_id unless instance_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#instantiate_project_region_workflow_template(name, instantiate_workflow_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Operation

Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

Parameters:

  • name (String) —

    Required. The "resource name" of the workflow template, as described in https:/ /cloud.google.com/apis/design/resource_names of the form projects/project_id/ regions/region/workflowTemplates/template_id

  • instantiate_workflow_template_request_object (Google::Apis::DataprocV1beta2::InstantiateWorkflowTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2253

def instantiate_project_region_workflow_template(name, instantiate_workflow_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+name}:instantiate', options)
  command.request_representation = Google::Apis::DataprocV1beta2::InstantiateWorkflowTemplateRequest::Representation
  command.request_object = instantiate_workflow_template_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#instantiate_project_region_workflow_template_inline(parent, workflow_template_object = nil, instance_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Operation

Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

Parameters:

  • parent (String) —

    Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/ project_id/regions/region

  • workflow_template_object (Google::Apis::DataprocV1beta2::WorkflowTemplate) (defaults to: nil)
  • instance_id (String) —

    Deprecated. Please use request_id field instead.

  • request_id (String) —

    Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en. wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2304

def instantiate_project_region_workflow_template_inline(parent, workflow_template_object = nil, instance_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+parent}/workflowTemplates:instantiateInline', options)
  command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['instanceId'] = instance_id unless instance_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_autoscaling_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::ListAutoscalingPoliciesResponse

Lists autoscaling policies in the project.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region, as described in https://cloud. google.com/apis/design/resource_names of the form projects/project_id/ regions/region

  • page_size (Fixnum) —

    Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100.

  • page_token (String) —

    Optional. The page token, returned by a previous call, to request the next page of results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



215
216
217
218
219
220
221
222
223
224
225
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 215

def list_project_location_autoscaling_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+parent}/autoscalingPolicies', options)
  command.response_representation = Google::Apis::DataprocV1beta2::ListAutoscalingPoliciesResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::ListAutoscalingPoliciesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_workflow_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse

Lists workflows that match the specified filter in the request.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region, as described in https://cloud. google.com/apis/design/resource_names of the form projects/project_id/ regions/region

  • page_size (Fixnum) —

    Optional. The maximum number of results to return in each response.

  • page_token (String) —

    Optional. The page token, returned by a previous call, to request the next page of results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



603
604
605
606
607
608
609
610
611
612
613
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 603

def list_project_location_workflow_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+parent}/workflowTemplates', options)
  command.response_representation = Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_region_autoscaling_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::ListAutoscalingPoliciesResponse

Lists autoscaling policies in the project.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region, as described in https://cloud. google.com/apis/design/resource_names of the form projects/project_id/ regions/region

  • page_size (Fixnum) —

    Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100.

  • page_token (String) —

    Optional. The page token, returned by a previous call, to request the next page of results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



889
890
891
892
893
894
895
896
897
898
899
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 889

def list_project_region_autoscaling_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+parent}/autoscalingPolicies', options)
  command.response_representation = Google::Apis::DataprocV1beta2::ListAutoscalingPoliciesResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::ListAutoscalingPoliciesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_region_clusters(project_id, region, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::ListClustersResponse

Lists all regions/region/clusters in a project.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project that the cluster belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • filter (String) —

    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 = *

  • page_size (Fixnum) —

    Optional. The standard List page size.

  • page_token (String) —

    Optional. The standard List page token.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1260

def list_project_region_clusters(project_id, region, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/projects/{projectId}/regions/{region}/clusters', options)
  command.response_representation = Google::Apis::DataprocV1beta2::ListClustersResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::ListClustersResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_region_jobs(project_id, region, cluster_name: nil, filter: nil, job_state_matcher: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::ListJobsResponse

Lists regions/region/jobs in a project.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project that the job belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • cluster_name (String) —

    Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

  • filter (String) —

    Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *

  • job_state_matcher (String) —

    Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.

  • page_size (Fixnum) —

    Optional. The number of results to return in each response.

  • page_token (String) —

    Optional. The page token, returned by a previous call, to request the next page of results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1650

def list_project_region_jobs(project_id, region, cluster_name: nil, filter: nil, job_state_matcher: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/projects/{projectId}/regions/{region}/jobs', options)
  command.response_representation = Google::Apis::DataprocV1beta2::ListJobsResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::ListJobsResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.query['clusterName'] = cluster_name unless cluster_name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['jobStateMatcher'] = job_state_matcher unless job_state_matcher.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_region_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::ListOperationsResponse

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.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) —

    The standard list filter.

  • page_size (Fixnum) —

    The standard list page size.

  • page_token (String) —

    The standard list page token.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1992

def list_project_region_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1beta2::ListOperationsResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_region_workflow_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse

Lists workflows that match the specified filter in the request.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region, as described in https://cloud. google.com/apis/design/resource_names of the form projects/project_id/ regions/region

  • page_size (Fixnum) —

    Optional. The maximum number of results to return in each response.

  • page_token (String) —

    Optional. The page token, returned by a previous call, to request the next page of results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2345

def list_project_region_workflow_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+parent}/workflowTemplates', options)
  command.response_representation = Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::ListWorkflowTemplatesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_region_cluster(project_id, region, cluster_name, cluster_object = nil, graceful_decommission_timeout: nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Operation

Updates a cluster in a project.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project the cluster belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • cluster_name (String) —

    Required. The cluster name.

  • cluster_object (Google::Apis::DataprocV1beta2::Cluster) (defaults to: nil)
  • graceful_decommission_timeout (String) —

    Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. Only supported on Dataproc image versions 1.2 and higher.

  • request_id (String) —

    Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID ( https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (- ). The maximum length is 40 characters.

  • update_mask (String) —

    Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: "config": "workerConfig": "numInstances":"5" Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: "config": "secondaryWorkerConfig": "numInstances":"5" Note: currently only the following fields can be updated:

    MaskPurpose
    labelsUpdates labels
    config.worker_config.num_instancesResize primary worker group
    config.secondary_worker_config.num_instancesResize secondary worker group
    config.lifecycle_config.auto_delete_ttlReset MAX TTL duration
    config.lifecycle_config.auto_delete_timeUpdate MAX TTL deletion timestamp
    config.lifecycle_config.idle_delete_ttlUpdate Idle TTL duration
    config.autoscaling_config.policy_uriUse, stop using, or change autoscaling policies
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1369

def patch_project_region_cluster(project_id, region, cluster_name, cluster_object = nil, graceful_decommission_timeout: nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}', options)
  command.request_representation = Google::Apis::DataprocV1beta2::Cluster::Representation
  command.request_object = cluster_object
  command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.params['clusterName'] = cluster_name unless cluster_name.nil?
  command.query['gracefulDecommissionTimeout'] = graceful_decommission_timeout unless graceful_decommission_timeout.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_region_job(project_id, region, job_id, job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Job

Updates a job in a project.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project that the job belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • job_id (String) —

    Required. The job ID.

  • job_object (Google::Apis::DataprocV1beta2::Job) (defaults to: nil)
  • update_mask (String) —

    Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. Note: Currently, labels is the only field that can be updated.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1697

def patch_project_region_job(project_id, region, job_id, job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}', options)
  command.request_representation = Google::Apis::DataprocV1beta2::Job::Representation
  command.request_object = job_object
  command.response_representation = Google::Apis::DataprocV1beta2::Job::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Job
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.params['jobId'] = job_id unless job_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_cluster_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::DataprocV1beta2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1409

def set_cluster_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1beta2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_job_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::DataprocV1beta2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1735

def set_job_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1beta2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_operation_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::DataprocV1beta2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2028

def set_operation_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1beta2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_autoscaling_policy_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::DataprocV1beta2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



250
251
252
253
254
255
256
257
258
259
260
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 250

def set_project_location_autoscaling_policy_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1beta2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_workflow_template_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::DataprocV1beta2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



638
639
640
641
642
643
644
645
646
647
648
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 638

def set_project_location_workflow_template_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1beta2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_region_autoscaling_policy_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::DataprocV1beta2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



924
925
926
927
928
929
930
931
932
933
934
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 924

def set_project_region_autoscaling_policy_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1beta2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_region_workflow_template_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::DataprocV1beta2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2380

def set_project_region_workflow_template_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1beta2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Policy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#submit_job(project_id, region, submit_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::Job

Submits a job to a cluster.

Parameters:

  • project_id (String) —

    Required. The ID of the Google Cloud Platform project that the job belongs to.

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • submit_job_request_object (Google::Apis::DataprocV1beta2::SubmitJobRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1770

def submit_job(project_id, region, submit_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/projects/{projectId}/regions/{region}/jobs:submit', options)
  command.request_representation = Google::Apis::DataprocV1beta2::SubmitJobRequest::Representation
  command.request_object = submit_job_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::Job::Representation
  command.response_class = Google::Apis::DataprocV1beta2::Job
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::TestIamPermissionsResponse

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.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::DataprocV1beta2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1447

def test_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_job_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::TestIamPermissionsResponse

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.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::DataprocV1beta2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 1809

def test_job_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_operation_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::TestIamPermissionsResponse

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.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::DataprocV1beta2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2066

def test_operation_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_location_autoscaling_policy_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::TestIamPermissionsResponse

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.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::DataprocV1beta2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



288
289
290
291
292
293
294
295
296
297
298
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 288

def test_project_location_autoscaling_policy_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_location_workflow_template_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::TestIamPermissionsResponse

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.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::DataprocV1beta2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



676
677
678
679
680
681
682
683
684
685
686
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 676

def test_project_location_workflow_template_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_region_autoscaling_policy_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::TestIamPermissionsResponse

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.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::DataprocV1beta2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



962
963
964
965
966
967
968
969
970
971
972
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 962

def test_project_region_autoscaling_policy_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_region_workflow_template_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::TestIamPermissionsResponse

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.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::DataprocV1beta2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2418

def test_project_region_workflow_template_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1beta2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_autoscaling_policy(name, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::AutoscalingPolicy

Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.

Parameters:

  • name (String) —

    Output only. The "resource name" of the policy, as described in https://cloud. google.com/apis/design/resource_names of the form projects/project_id/ regions/region/autoscalingPolicies/policy_id.

  • autoscaling_policy_object (Google::Apis::DataprocV1beta2::AutoscalingPolicy) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



324
325
326
327
328
329
330
331
332
333
334
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 324

def update_project_location_autoscaling_policy(name, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta2/{+name}', options)
  command.request_representation = Google::Apis::DataprocV1beta2::AutoscalingPolicy::Representation
  command.request_object = autoscaling_policy_object
  command.response_representation = Google::Apis::DataprocV1beta2::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::AutoscalingPolicy
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_workflow_template(name, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::WorkflowTemplate

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

Parameters:

  • name (String) —

    Output only. The "resource name" of the template, as described in https:// cloud.google.com/apis/design/resource_names of the form projects/project_id/ regions/region/workflowTemplates/template_id

  • workflow_template_object (Google::Apis::DataprocV1beta2::WorkflowTemplate) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



712
713
714
715
716
717
718
719
720
721
722
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 712

def update_project_location_workflow_template(name, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta2/{+name}', options)
  command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_region_autoscaling_policy(name, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::AutoscalingPolicy

Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.

Parameters:

  • name (String) —

    Output only. The "resource name" of the policy, as described in https://cloud. google.com/apis/design/resource_names of the form projects/project_id/ regions/region/autoscalingPolicies/policy_id.

  • autoscaling_policy_object (Google::Apis::DataprocV1beta2::AutoscalingPolicy) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 998

def update_project_region_autoscaling_policy(name, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta2/{+name}', options)
  command.request_representation = Google::Apis::DataprocV1beta2::AutoscalingPolicy::Representation
  command.request_object = autoscaling_policy_object
  command.response_representation = Google::Apis::DataprocV1beta2::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1beta2::AutoscalingPolicy
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_region_workflow_template(name, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1beta2::WorkflowTemplate

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

Parameters:

  • name (String) —

    Output only. The "resource name" of the template, as described in https:// cloud.google.com/apis/design/resource_names of the form projects/project_id/ regions/region/workflowTemplates/template_id

  • workflow_template_object (Google::Apis::DataprocV1beta2::WorkflowTemplate) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
 
# File 'generated/google/apis/dataproc_v1beta2/service.rb', line 2454

def update_project_region_workflow_template(name, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta2/{+name}', options)
  command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1beta2::WorkflowTemplate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end