Class: Google::Apis::DataprocV1::DataprocService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/dataproc_v1/service.rb

Overview

Cloud Dataproc API

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

Examples:

require 'google/apis/dataproc_v1'

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

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://dataproc.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DataprocService

Returns a new instance of DataprocService.



47
48
49
50
51
52
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-dataproc_v1',
        client_version: Google::Apis::DataprocV1::GEM_VERSION)
  @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.



40
41
42
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 40

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.



45
46
47
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#access_project_location_batch_spark_application(name, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSparkApplicationResponse

Obtain high level information corresponding to a single Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



589
590
591
592
593
594
595
596
597
598
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 589

def access_project_location_batch_spark_application(name, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:access', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSparkApplicationResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSparkApplicationResponse
  command.params['name'] = name unless name.nil?
  command.query['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

#access_project_location_batch_spark_application_environment_info(name, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSparkApplicationEnvironmentInfoResponse

Obtain environment details for a Spark Application

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



624
625
626
627
628
629
630
631
632
633
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 624

def access_project_location_batch_spark_application_environment_info(name, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessEnvironmentInfo', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSparkApplicationEnvironmentInfoResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSparkApplicationEnvironmentInfoResponse
  command.params['name'] = name unless name.nil?
  command.query['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

#access_project_location_batch_spark_application_job(name, job_id: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSparkApplicationJobResponse

Obtain data corresponding to a spark job for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • job_id (Fixnum) (defaults to: nil) —

    Required. Job ID to fetch data for.

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 661

def access_project_location_batch_spark_application_job(name, job_id: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessJob', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSparkApplicationJobResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSparkApplicationJobResponse
  command.params['name'] = name unless name.nil?
  command.query['jobId'] = job_id unless job_id.nil?
  command.query['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

#access_project_location_batch_spark_application_sql_plan(name, execution_id: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSparkApplicationSqlSparkPlanGraphResponse

Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • execution_id (Fixnum) (defaults to: nil) —

    Required. Execution ID

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 700

def access_project_location_batch_spark_application_sql_plan(name, execution_id: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessSqlPlan', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSparkApplicationSqlSparkPlanGraphResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSparkApplicationSqlSparkPlanGraphResponse
  command.params['name'] = name unless name.nil?
  command.query['executionId'] = execution_id unless execution_id.nil?
  command.query['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

#access_project_location_batch_spark_application_sql_query(name, details: nil, execution_id: nil, parent: nil, plan_description: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSparkApplicationSqlQueryResponse

Obtain data corresponding to a particular SQL Query for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • details (Boolean) (defaults to: nil) —

    Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

  • execution_id (Fixnum) (defaults to: nil) —

    Required. Execution ID

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • plan_description (Boolean) (defaults to: nil) —

    Optional. Enables/ disables physical plan description on demand

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 743

def access_project_location_batch_spark_application_sql_query(name, details: nil, execution_id: nil, parent: nil, plan_description: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessSqlQuery', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSparkApplicationSqlQueryResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSparkApplicationSqlQueryResponse
  command.params['name'] = name unless name.nil?
  command.query['details'] = details unless details.nil?
  command.query['executionId'] = execution_id unless execution_id.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['planDescription'] = plan_description unless plan_description.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#access_project_location_batch_spark_application_stage_attempt(name, parent: nil, stage_attempt_id: nil, stage_id: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSparkApplicationStageAttemptResponse

Obtain data corresponding to a spark stage attempt for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • stage_attempt_id (Fixnum) (defaults to: nil) —

    Required. Stage Attempt ID

  • stage_id (Fixnum) (defaults to: nil) —

    Required. Stage ID

  • summary_metrics_mask (String) (defaults to: nil) —

    Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 790

def access_project_location_batch_spark_application_stage_attempt(name, parent: nil, stage_attempt_id: nil, stage_id: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessStageAttempt', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSparkApplicationStageAttemptResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSparkApplicationStageAttemptResponse
  command.params['name'] = name unless name.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageAttemptId'] = stage_attempt_id unless stage_attempt_id.nil?
  command.query['stageId'] = stage_id unless stage_id.nil?
  command.query['summaryMetricsMask'] = summary_metrics_mask unless summary_metrics_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

#access_project_location_batch_spark_application_stage_rdd_graph(name, parent: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSparkApplicationStageRddOperationGraphResponse

Obtain RDD operation graph for a Spark Application Stage. Limits the number of clusters returned as part of the graph to 10000.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • stage_id (Fixnum) (defaults to: nil) —

    Required. Stage ID

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 831

def access_project_location_batch_spark_application_stage_rdd_graph(name, parent: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessStageRddGraph', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSparkApplicationStageRddOperationGraphResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSparkApplicationStageRddOperationGraphResponse
  command.params['name'] = name unless name.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageId'] = stage_id unless stage_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

#access_project_location_session_spark_application(name, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSessionSparkApplicationResponse

Obtain high level information corresponding to a single Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1989

def access_project_location_session_spark_application(name, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:access', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSessionSparkApplicationResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSessionSparkApplicationResponse
  command.params['name'] = name unless name.nil?
  command.query['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

#access_project_location_session_spark_application_environment_info(name, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSessionSparkApplicationEnvironmentInfoResponse

Obtain environment details for a Spark Application

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2024

def access_project_location_session_spark_application_environment_info(name, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessEnvironmentInfo', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSessionSparkApplicationEnvironmentInfoResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSessionSparkApplicationEnvironmentInfoResponse
  command.params['name'] = name unless name.nil?
  command.query['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

#access_project_location_session_spark_application_job(name, job_id: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSessionSparkApplicationJobResponse

Obtain data corresponding to a spark job for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • job_id (Fixnum) (defaults to: nil) —

    Required. Job ID to fetch data for.

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2061

def access_project_location_session_spark_application_job(name, job_id: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessJob', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSessionSparkApplicationJobResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSessionSparkApplicationJobResponse
  command.params['name'] = name unless name.nil?
  command.query['jobId'] = job_id unless job_id.nil?
  command.query['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

#access_project_location_session_spark_application_sql_plan(name, execution_id: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSessionSparkApplicationSqlSparkPlanGraphResponse

Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • execution_id (Fixnum) (defaults to: nil) —

    Required. Execution ID

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2100

def access_project_location_session_spark_application_sql_plan(name, execution_id: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessSqlPlan', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSessionSparkApplicationSqlSparkPlanGraphResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSessionSparkApplicationSqlSparkPlanGraphResponse
  command.params['name'] = name unless name.nil?
  command.query['executionId'] = execution_id unless execution_id.nil?
  command.query['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

#access_project_location_session_spark_application_sql_query(name, details: nil, execution_id: nil, parent: nil, plan_description: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSessionSparkApplicationSqlQueryResponse

Obtain data corresponding to a particular SQL Query for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • details (Boolean) (defaults to: nil) —

    Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

  • execution_id (Fixnum) (defaults to: nil) —

    Required. Execution ID

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • plan_description (Boolean) (defaults to: nil) —

    Optional. Enables/ disables physical plan description on demand

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2143

def access_project_location_session_spark_application_sql_query(name, details: nil, execution_id: nil, parent: nil, plan_description: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessSqlQuery', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSessionSparkApplicationSqlQueryResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSessionSparkApplicationSqlQueryResponse
  command.params['name'] = name unless name.nil?
  command.query['details'] = details unless details.nil?
  command.query['executionId'] = execution_id unless execution_id.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['planDescription'] = plan_description unless plan_description.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#access_project_location_session_spark_application_stage_attempt(name, parent: nil, stage_attempt_id: nil, stage_id: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSessionSparkApplicationStageAttemptResponse

Obtain data corresponding to a spark stage attempt for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • stage_attempt_id (Fixnum) (defaults to: nil) —

    Required. Stage Attempt ID

  • stage_id (Fixnum) (defaults to: nil) —

    Required. Stage ID

  • summary_metrics_mask (String) (defaults to: nil) —

    Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2190

def access_project_location_session_spark_application_stage_attempt(name, parent: nil, stage_attempt_id: nil, stage_id: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessStageAttempt', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSessionSparkApplicationStageAttemptResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSessionSparkApplicationStageAttemptResponse
  command.params['name'] = name unless name.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageAttemptId'] = stage_attempt_id unless stage_attempt_id.nil?
  command.query['stageId'] = stage_id unless stage_id.nil?
  command.query['summaryMetricsMask'] = summary_metrics_mask unless summary_metrics_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

#access_project_location_session_spark_application_stage_rdd_graph(name, parent: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AccessSessionSparkApplicationStageRddOperationGraphResponse

Obtain RDD operation graph for a Spark Application Stage. Limits the number of clusters returned as part of the graph to 10000.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • stage_id (Fixnum) (defaults to: nil) —

    Required. Stage ID

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2231

def access_project_location_session_spark_application_stage_rdd_graph(name, parent: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:accessStageRddGraph', options)
  command.response_representation = Google::Apis::DataprocV1::AccessSessionSparkApplicationStageRddOperationGraphResponse::Representation
  command.response_class = Google::Apis::DataprocV1::AccessSessionSparkApplicationStageRddOperationGraphResponse
  command.params['name'] = name unless name.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageId'] = stage_id unless stage_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

#analyze_batch(name, analyze_batch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Analyze a Batch for possible recommendations and insights.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to analyze in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"

  • analyze_batch_request_object (Google::Apis::DataprocV1::AnalyzeBatchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 382

def analyze_batch(name, analyze_batch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:analyze', options)
  command.request_representation = Google::Apis::DataprocV1::AnalyzeBatchRequest::Representation
  command.request_object = analyze_batch_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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

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

Starts a job cancellation request. To access the job resource after cancellation, call regions/region/jobs.list (https://cloud.google.com/ dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/region /jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects. regions.jobs/get).

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • job_id (String) —

    Required. The job ID.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4371

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, 'v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel', options)
  command.request_representation = Google::Apis::DataprocV1::CancelJobRequest::Representation
  command.request_object = cancel_job_request_object
  command.response_representation = Google::Apis::DataprocV1::Job::Representation
  command.response_class = Google::Apis::DataprocV1::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_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4771
4772
4773
4774
4775
4776
4777
4778
4779
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4771

def cancel_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::DataprocV1::Empty::Representation
  command.response_class = Google::Apis::DataprocV1::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

#cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1472
1473
1474
1475
1476
1477
1478
1479
1480
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1472

def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::DataprocV1::Empty::Representation
  command.response_class = Google::Apis::DataprocV1::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_cluster(project_id, region, cluster_object = nil, action_on_failed_primary_workers: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#clusteroperationmetadata).

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • cluster_object (Google::Apis::DataprocV1::Cluster) (defaults to: nil)
  • action_on_failed_primary_workers (String) (defaults to: nil) —

    Optional. Failure action when primary worker creation fails.

  • request_id (String) (defaults to: nil) —

    Optional. A unique ID used to identify the request. If the server receives two CreateClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateClusterRequest)s 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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3623

def create_cluster(project_id, region, cluster_object = nil, action_on_failed_primary_workers: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectId}/regions/{region}/clusters', options)
  command.request_representation = Google::Apis::DataprocV1::Cluster::Representation
  command.request_object = cluster_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::Operation
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['region'] = region unless region.nil?
  command.query['actionOnFailedPrimaryWorkers'] = action_on_failed_primary_workers unless action_on_failed_primary_workers.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_location_autoscaling_policy(parent, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::AutoscalingPolicy

Creates new autoscaling policy.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region or location, as described in https: //cloud.google.com/apis/design/resource_names. For projects.regions. autoscalingPolicies.create, the resource name of the region has the following format: projects/project_id/regions/region For projects.locations. autoscalingPolicies.create, the resource name of the location has the following format: projects/project_id/locations/location

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 80

def create_project_location_autoscaling_policy(parent, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/autoscalingPolicies', options)
  command.request_representation = Google::Apis::DataprocV1::AutoscalingPolicy::Representation
  command.request_object = autoscaling_policy_object
  command.response_representation = Google::Apis::DataprocV1::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1::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_batch(parent, batch_object = nil, batch_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Creates a batch workload that executes asynchronously.

Parameters:

  • parent (String) —

    Required. The parent resource where this batch will be created.

  • batch_object (Google::Apis::DataprocV1::Batch) (defaults to: nil)
  • batch_id (String) (defaults to: nil) —

    Optional. The ID to use for the batch, which will become the final component of the batch's resource name.This value must be 4-63 characters. Valid characters are /[a-z][0-9]-/.

  • request_id (String) (defaults to: nil) —

    Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequest (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateBatchRequest)s with the same request_id, the second request is ignored and the Operation that corresponds to the first Batch created and stored in the backend is returned. Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/ Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 429

def create_project_location_batch(parent, batch_object = nil, batch_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/batches', options)
  command.request_representation = Google::Apis::DataprocV1::Batch::Representation
  command.request_object = batch_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['batchId'] = batch_id unless batch_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

#create_project_location_session(parent, session_object = nil, request_id: nil, session_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Create an interactive session asynchronously.

Parameters:

  • parent (String) —

    Required. The parent resource where this session will be created.

  • session_object (Google::Apis::DataprocV1::Session) (defaults to: nil)
  • request_id (String) (defaults to: nil) —

    Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequests (https://cloud.google.com/dataproc/docs/reference/ rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s with the same ID, the second request is ignored, and the first Session is created and stored in the backend.Recommendation: Set this value to a UUID ( https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (- ). The maximum length is 40 characters.

  • session_id (String) (defaults to: nil) —

    Required. The ID to use for the session, which becomes the final component of the session's resource name.This value must be 4-63 characters. Valid characters are /a-z-/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1797

def create_project_location_session(parent, session_object = nil, request_id: nil, session_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/sessions', options)
  command.request_representation = Google::Apis::DataprocV1::Session::Representation
  command.request_object = session_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['sessionId'] = session_id unless session_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_location_session_template(parent, session_template_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SessionTemplate

Create a session template synchronously.

Parameters:

  • parent (String) —

    Required. The parent resource where this session template will be created.

  • session_template_object (Google::Apis::DataprocV1::SessionTemplate) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1615

def create_project_location_session_template(parent, session_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/sessionTemplates', options)
  command.request_representation = Google::Apis::DataprocV1::SessionTemplate::Representation
  command.request_object = session_template_object
  command.response_representation = Google::Apis::DataprocV1::SessionTemplate::Representation
  command.response_class = Google::Apis::DataprocV1::SessionTemplate
  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::DataprocV1::WorkflowTemplate

Creates new workflow template.

Parameters:

  • parent (String) —

    Required. The resource name of the region or location, as described in https:// cloud.google.com/apis/design/resource_names. For projects.regions. workflowTemplates.create, the resource name of the region has the following format: projects/project_id/regions/region For projects.locations. workflowTemplates.create, the resource name of the location has the following format: projects/project_id/locations/location

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2887

def create_project_location_workflow_template(parent, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/workflowTemplates', options)
  command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::AutoscalingPolicy

Creates new autoscaling policy.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region or location, as described in https: //cloud.google.com/apis/design/resource_names. For projects.regions. autoscalingPolicies.create, the resource name of the region has the following format: projects/project_id/regions/region For projects.locations. autoscalingPolicies.create, the resource name of the location has the following format: projects/project_id/locations/location

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3305

def create_project_region_autoscaling_policy(parent, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/autoscalingPolicies', options)
  command.request_representation = Google::Apis::DataprocV1::AutoscalingPolicy::Representation
  command.request_object = autoscaling_policy_object
  command.response_representation = Google::Apis::DataprocV1::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1::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_node_group(parent, node_group_object = nil, node_group_id: nil, parent_operation_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Creates a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/ rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).

Parameters:

  • parent (String) —

    Required. The parent resource where this node group will be created. Format: projects/project/regions/region/clusters/cluster

  • node_group_object (Google::Apis::DataprocV1::NodeGroup) (defaults to: nil)
  • node_group_id (String) (defaults to: nil) —

    Optional. An optional node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (- ). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.

  • parent_operation_id (String) (defaults to: nil) —

    Optional. operation id of the parent operation sending the create request

  • request_id (String) (defaults to: nil) —

    Optional. A unique ID used to identify the request. If the server receives two CreateNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateNodeGroupRequest) with the same ID, the second request is ignored and the first google.longrunning. Operation created and stored in the backend is returned.Recommendation: 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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4226

def create_project_region_cluster_node_group(parent, node_group_object = nil, node_group_id: nil, parent_operation_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/nodeGroups', options)
  command.request_representation = Google::Apis::DataprocV1::NodeGroup::Representation
  command.request_object = node_group_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['nodeGroupId'] = node_group_id unless node_group_id.nil?
  command.query['parentOperationId'] = parent_operation_id unless parent_operation_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

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

Creates new workflow template.

Parameters:

  • parent (String) —

    Required. The resource name of the region or location, as described in https:// cloud.google.com/apis/design/resource_names. For projects.regions. workflowTemplates.create, the resource name of the region has the following format: projects/project_id/regions/region For projects.locations. workflowTemplates.create, the resource name of the location has the following format: projects/project_id/locations/location

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 5031

def create_project_region_workflow_template(parent, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/workflowTemplates', options)
  command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1::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_cluster(project_id, region, cluster_name, cluster_uuid: nil, graceful_termination_timeout: nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#clusteroperationmetadata).

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • cluster_name (String) —

    Required. The cluster name.

  • cluster_uuid (String) (defaults to: nil) —

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

  • graceful_termination_timeout (String) (defaults to: nil) —

    Optional. The graceful termination timeout for the deletion of the cluster. Indicate the time the request will wait to complete the running jobs on the cluster before its forceful deletion. Default value is 0 indicating that the user has not enabled the graceful termination. Value can be between 60 second and 6 Hours, in case the graceful termination is enabled. (There is no separate flag to check the enabling or disabling of graceful termination, it can be checked by the values in the field).

  • request_id (String) (defaults to: nil) —

    Optional. A unique ID used to identify the request. If the server receives two DeleteClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteClusterRequest)s 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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3686

def delete_cluster(project_id, region, cluster_name, cluster_uuid: nil, graceful_termination_timeout: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/projects/{projectId}/regions/{region}/clusters/{clusterName}', options)
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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['gracefulTerminationTimeout'] = graceful_termination_timeout unless graceful_termination_timeout.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_job(project_id, region, job_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Dataproc region in which to handle the request.

  • job_id (String) —

    Required. The job ID.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4410

def delete_job(project_id, region, job_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/projects/{projectId}/regions/{region}/jobs/{jobId}', options)
  command.response_representation = Google::Apis::DataprocV1::Empty::Representation
  command.response_class = Google::Apis::DataprocV1::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_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4804

def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Empty::Representation
  command.response_class = Google::Apis::DataprocV1::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_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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. For projects.regions. autoscalingPolicies.delete, the resource name of the policy has the following format: projects/project_id/regions/region/autoscalingPolicies/policy_id For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/project_id/locations/location/ autoscalingPolicies/policy_id

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



119
120
121
122
123
124
125
126
127
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 119

def delete_project_location_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Empty::Representation
  command.response_class = Google::Apis::DataprocV1::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_batch(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Empty

Deletes the batch workload resource. If the batch is not in a CANCELLED, SUCCEEDED or FAILED State, the delete operation fails and the response returns FAILED_PRECONDITION.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



466
467
468
469
470
471
472
473
474
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 466

def delete_project_location_batch(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Empty::Representation
  command.response_class = Google::Apis::DataprocV1::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_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1505
1506
1507
1508
1509
1510
1511
1512
1513
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1505

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Empty::Representation
  command.response_class = Google::Apis::DataprocV1::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_session(name, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

Parameters:

  • name (String) —

    Required. The name of the session resource to delete.

  • request_id (String) (defaults to: nil) —

    Optional. A unique ID used to identify the request. If the service receives two DeleteSessionRequest (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteSessionRequest)s with the same ID, the second request is ignored.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1840

def delete_project_location_session(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::Operation
  command.params['name'] = name unless name.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_location_session_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Empty

Deletes a session template.

Parameters:

  • name (String) —

    Required. The name of the session template resource to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1647
1648
1649
1650
1651
1652
1653
1654
1655
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1647

def delete_project_location_session_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Empty::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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. For projects.regions. workflowTemplates.delete, the resource name of the template has the following format: projects/project_id/regions/region/workflowTemplates/template_id For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/project_id/locations/location/ workflowTemplates/template_id

  • version (Fixnum) (defaults to: nil) —

    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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2928

def delete_project_location_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Empty::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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. For projects.regions. autoscalingPolicies.delete, the resource name of the policy has the following format: projects/project_id/regions/region/autoscalingPolicies/policy_id For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/project_id/locations/location/ autoscalingPolicies/policy_id

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3344
3345
3346
3347
3348
3349
3350
3351
3352
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3344

def delete_project_region_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Empty::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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. For projects.regions. workflowTemplates.delete, the resource name of the template has the following format: projects/project_id/regions/region/workflowTemplates/template_id For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/project_id/locations/location/ workflowTemplates/template_id

  • version (Fixnum) (defaults to: nil) —

    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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 5072

def delete_project_region_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Empty::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::Operation

Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud. google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1# diagnoseclusterresults).

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • cluster_name (String) —

    Required. The cluster name.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3732

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, 'v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose', options)
  command.request_representation = Google::Apis::DataprocV1::DiagnoseClusterRequest::Representation
  command.request_object = diagnose_cluster_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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_cluster(project_id, region, cluster_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Dataproc region in which to handle the request.

  • cluster_name (String) —

    Required. The cluster name.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3771

def get_cluster(project_id, region, cluster_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{projectId}/regions/{region}/clusters/{clusterName}', options)
  command.response_representation = Google::Apis::DataprocV1::Cluster::Representation
  command.response_class = Google::Apis::DataprocV1::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_cluster_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::DataprocV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3807

def get_cluster_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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

#get_job(project_id, region, job_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Dataproc region in which to handle the request.

  • job_id (String) —

    Required. The job ID.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4446

def get_job(project_id, region, job_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{projectId}/regions/{region}/jobs/{jobId}', options)
  command.response_representation = Google::Apis::DataprocV1::Job::Representation
  command.response_class = Google::Apis::DataprocV1::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_job_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::DataprocV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4482

def get_job_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4835
4836
4837
4838
4839
4840
4841
4842
4843
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4835

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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_operation_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::DataprocV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4869

def get_operation_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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

#get_project_location_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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. For projects.regions. autoscalingPolicies.get, the resource name of the policy has the following format: projects/project_id/regions/region/autoscalingPolicies/policy_id For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/project_id/locations/location/ autoscalingPolicies/policy_id

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



155
156
157
158
159
160
161
162
163
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 155

def get_project_location_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1::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, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::DataprocV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 189

def get_project_location_autoscaling_policy_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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

#get_project_location_batch(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Batch

Gets the batch workload resource representation.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



497
498
499
500
501
502
503
504
505
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 497

def get_project_location_batch(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Batch::Representation
  command.response_class = Google::Apis::DataprocV1::Batch
  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_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1536
1537
1538
1539
1540
1541
1542
1543
1544
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1536

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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_location_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Session

Gets the resource representation for an interactive session.

Parameters:

  • name (String) —

    Required. The name of the session to retrieve.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1871
1872
1873
1874
1875
1876
1877
1878
1879
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1871

def get_project_location_session(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::Session::Representation
  command.response_class = Google::Apis::DataprocV1::Session
  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_session_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SessionTemplate

Gets the resource representation for a session template.

Parameters:

  • name (String) —

    Required. The name of the session template to retrieve.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1677
1678
1679
1680
1681
1682
1683
1684
1685
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1677

def get_project_location_session_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::SessionTemplate::Representation
  command.response_class = Google::Apis::DataprocV1::SessionTemplate
  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_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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. For projects.regions. workflowTemplates.get, the resource name of the template has the following format: projects/project_id/regions/region/workflowTemplates/template_id For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/project_id/locations/location/ workflowTemplates/template_id

  • version (Fixnum) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2970

def get_project_location_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1::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, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::DataprocV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3005

def get_project_location_workflow_template_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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

#get_project_region_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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. For projects.regions. autoscalingPolicies.get, the resource name of the policy has the following format: projects/project_id/regions/region/autoscalingPolicies/policy_id For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/project_id/locations/location/ autoscalingPolicies/policy_id

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3380
3381
3382
3383
3384
3385
3386
3387
3388
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3380

def get_project_region_autoscaling_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1::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_autoscaling_policy_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::DataprocV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3414

def get_project_region_autoscaling_policy_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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

#get_project_region_cluster_node_group(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::NodeGroup

Gets the resource representation for a node group in a cluster.

Parameters:

  • name (String) —

    Required. The name of the node group to retrieve. Format: projects/project/ regions/region/clusters/cluster/nodeGroups/nodeGroup

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4262
4263
4264
4265
4266
4267
4268
4269
4270
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4262

def get_project_region_cluster_node_group(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::NodeGroup::Representation
  command.response_class = Google::Apis::DataprocV1::NodeGroup
  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_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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. For projects.regions. workflowTemplates.get, the resource name of the template has the following format: projects/project_id/regions/region/workflowTemplates/template_id For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/project_id/locations/location/ workflowTemplates/template_id

  • version (Fixnum) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 5114

def get_project_region_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1::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, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::DataprocV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 5149

def get_project_region_workflow_template_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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

#inject_cluster_credentials(project, region, cluster, inject_credentials_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Inject encrypted credentials into all of the VMs in a cluster.The target cluster must be a personal auth cluster assigned to the user who is issuing the RPC.

Parameters:

  • project (String) —

    Required. The ID of the Google Cloud Platform project the cluster belongs to, of the form projects/.

  • region (String) —

    Required. The region containing the cluster, of the form regions/.

  • cluster (String) —

    Required. The cluster, in the form clusters/.

  • inject_credentials_request_object (Google::Apis::DataprocV1::InjectCredentialsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3847

def inject_cluster_credentials(project, region, cluster, inject_credentials_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+project}/{+region}/{+cluster}:injectCredentials', options)
  command.request_representation = Google::Apis::DataprocV1::InjectCredentialsRequest::Representation
  command.request_object = inject_credentials_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::Operation
  command.params['project'] = project unless project.nil?
  command.params['region'] = region unless region.nil?
  command.params['cluster'] = cluster unless cluster.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::DataprocV1::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 (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata ( https://cloud.google.com/dataproc/docs/concepts/workflows/debugging# using_workflowmetadata).On successful completion, Operation.response will be Empty.

Parameters:

  • name (String) —

    Required. The resource name of the workflow template, as described in https:// cloud.google.com/apis/design/resource_names. For projects.regions. workflowTemplates.instantiate, the resource name of the template has the following format: projects/project_id/regions/region/workflowTemplates/ template_id For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/project_id/ locations/location/workflowTemplates/template_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3053

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, 'v1/{+name}:instantiate', options)
  command.request_representation = Google::Apis::DataprocV1::InstantiateWorkflowTemplateRequest::Representation
  command.request_object = instantiate_workflow_template_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 (https://cloud. google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1# workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/ dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.

Parameters:

  • parent (String) —

    Required. The resource name of the region or location, as described in https:// cloud.google.com/apis/design/resource_names. For projects.regions. workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/project_id/regions/region For projects. locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/project_id/locations/location

  • workflow_template_object (Google::Apis::DataprocV1::WorkflowTemplate) (defaults to: nil)
  • request_id (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3108

def instantiate_project_location_workflow_template_inline(parent, workflow_template_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/workflowTemplates:instantiateInline', options)
  command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::Operation
  command.params['parent'] = parent unless parent.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::DataprocV1::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 (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata ( https://cloud.google.com/dataproc/docs/concepts/workflows/debugging# using_workflowmetadata).On successful completion, Operation.response will be Empty.

Parameters:

  • name (String) —

    Required. The resource name of the workflow template, as described in https:// cloud.google.com/apis/design/resource_names. For projects.regions. workflowTemplates.instantiate, the resource name of the template has the following format: projects/project_id/regions/region/workflowTemplates/ template_id For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/project_id/ locations/location/workflowTemplates/template_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 5197

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, 'v1/{+name}:instantiate', options)
  command.request_representation = Google::Apis::DataprocV1::InstantiateWorkflowTemplateRequest::Representation
  command.request_object = instantiate_workflow_template_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 (https://cloud. google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1# workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/ dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.

Parameters:

  • parent (String) —

    Required. The resource name of the region or location, as described in https:// cloud.google.com/apis/design/resource_names. For projects.regions. workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/project_id/regions/region For projects. locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/project_id/locations/location

  • workflow_template_object (Google::Apis::DataprocV1::WorkflowTemplate) (defaults to: nil)
  • request_id (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 5252

def instantiate_project_region_workflow_template_inline(parent, workflow_template_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/workflowTemplates:instantiateInline', options)
  command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::Operation
  command.params['parent'] = parent unless parent.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_clusters(project_id, region, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::ListClustersResponse

Lists all regions/region/clusters in a project alphabetically.

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • filter (String) (defaults to: nil) —

    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, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED 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) (defaults to: nil) —

    Optional. The standard List page size.

  • page_token (String) (defaults to: nil) —

    Optional. The standard List page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3900

def list_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, 'v1/projects/{projectId}/regions/{region}/clusters', options)
  command.response_representation = Google::Apis::DataprocV1::ListClustersResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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_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::DataprocV1::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 Dataproc region in which to handle the request.

  • cluster_name (String) (defaults to: nil) —

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

  • filter (String) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4535

def list_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, 'v1/projects/{projectId}/regions/{region}/jobs', options)
  command.response_representation = Google::Apis::DataprocV1::ListJobsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4915

def list_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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['returnPartialSuccess'] = return_partial_success unless return_partial_success.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::DataprocV1::ListAutoscalingPoliciesResponse

Lists autoscaling policies in the project.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region or location, as described in https: //cloud.google.com/apis/design/resource_names. For projects.regions. autoscalingPolicies.list, the resource name of the region has the following format: projects/project_id/regions/region For projects.locations. autoscalingPolicies.list, the resource name of the location has the following format: projects/project_id/locations/location

  • page_size (Fixnum) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 232

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, 'v1/{+parent}/autoscalingPolicies', options)
  command.response_representation = Google::Apis::DataprocV1::ListAutoscalingPoliciesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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_batches(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::ListBatchesResponse

Lists batch workloads.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of batches.

  • filter (String) (defaults to: nil) —

    Optional. A filter for the batches to return in the response.A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, create_time, and labels.e.g. state = RUNNING and create_time < "2023-01-01T00:00:00Z" filters for batches in state RUNNING that were created before 2023-01-01. state = RUNNING and labels.environment= production filters for batches in state in a RUNNING state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf- filtering.txt for a detailed description of the filter syntax and a list of supported comparisons.

  • order_by (String) (defaults to: nil) —

    Optional. Field(s) on which to sort the list of batches.Currently the only supported sort orders are unspecified (empty) and create_time desc to sort by most recently created batches first.See https://google.aip.dev/132#ordering for more details.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of batches to return in each response. The service may return fewer than this value. The default page size is 20; the maximum page size is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 551

def list_project_location_batches(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/batches', options)
  command.response_representation = Google::Apis::DataprocV1::ListBatchesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::ListBatchesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.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_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil) —

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1580

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataprocV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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['returnPartialSuccess'] = return_partial_success unless return_partial_success.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_session_templates(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::ListSessionTemplatesResponse

Lists session templates.

Parameters:

  • parent (String) —

    Required. The parent that owns this collection of session templates.

  • filter (String) (defaults to: nil) —

    Optional. A filter for the session templates to return in the response. Filters are case sensitive and have the following syntax:field = value AND field = value ...

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1717

def list_project_location_session_templates(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/sessionTemplates', options)
  command.response_representation = Google::Apis::DataprocV1::ListSessionTemplatesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::ListSessionTemplatesResponse
  command.params['parent'] = parent unless parent.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_location_sessions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::ListSessionsResponse

Lists interactive sessions.

Parameters:

  • parent (String) —

    Required. The parent, which owns this collection of sessions.

  • filter (String) (defaults to: nil) —

    Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, create_time, and labels.Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state that were created before 2023-01-01. state = ACTIVE and labels. environment=production is a filter for sessions in an ACTIVE state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf- filtering.txt for a detailed description of the filter syntax and a list of supported comparators.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1919

def list_project_location_sessions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
  command.response_representation = Google::Apis::DataprocV1::ListSessionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::ListSessionsResponse
  command.params['parent'] = parent unless parent.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_location_workflow_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::ListWorkflowTemplatesResponse

Lists workflows that match the specified filter in the request.

Parameters:

  • parent (String) —

    Required. The resource name of the region or location, as described in https:// cloud.google.com/apis/design/resource_names. For projects.regions. workflowTemplates,list, the resource name of the region has the following format: projects/project_id/regions/region For projects.locations. workflowTemplates.list, the resource name of the location has the following format: projects/project_id/locations/location

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3151

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, 'v1/{+parent}/workflowTemplates', options)
  command.response_representation = Google::Apis::DataprocV1::ListWorkflowTemplatesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::ListAutoscalingPoliciesResponse

Lists autoscaling policies in the project.

Parameters:

  • parent (String) —

    Required. The "resource name" of the region or location, as described in https: //cloud.google.com/apis/design/resource_names. For projects.regions. autoscalingPolicies.list, the resource name of the region has the following format: projects/project_id/regions/region For projects.locations. autoscalingPolicies.list, the resource name of the location has the following format: projects/project_id/locations/location

  • page_size (Fixnum) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3457

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, 'v1/{+parent}/autoscalingPolicies', options)
  command.response_representation = Google::Apis::DataprocV1::ListAutoscalingPoliciesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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_workflow_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::ListWorkflowTemplatesResponse

Lists workflows that match the specified filter in the request.

Parameters:

  • parent (String) —

    Required. The resource name of the region or location, as described in https:// cloud.google.com/apis/design/resource_names. For projects.regions. workflowTemplates,list, the resource name of the region has the following format: projects/project_id/regions/region For projects.locations. workflowTemplates.list, the resource name of the location has the following format: projects/project_id/locations/location

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 5295

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, 'v1/{+parent}/workflowTemplates', options)
  command.response_representation = Google::Apis::DataprocV1::ListWorkflowTemplatesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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_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::DataprocV1::Operation

Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#clusteroperationmetadata). The cluster must be in a RUNNING state or an error is returned.

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • cluster_name (String) —

    Required. The cluster name.

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

    Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. ( see JSON representation of Duration (https://developers.google.com/protocol- buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.

  • request_id (String) (defaults to: nil) —

    Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/ google.cloud.dataproc.v1#google.cloud.dataproc.v1.UpdateClusterRequest)s 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) (defaults to: nil) —

    Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: "config": " workerConfig":"numInstances":"5" Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: "config": "secondaryWorkerConfig":"numInstances":"5" Note: Currently, only the following fields can be updated: Mask * Purpose* labels Update labels config.worker_config.num_instances Resize primary worker group config.secondary_worker_config.num_instances Resize secondary worker group config.autoscaling_config.policy_uri Use, stop using, or change autoscaling policies

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3975

def patch_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, 'v1/projects/{projectId}/regions/{region}/clusters/{clusterName}', options)
  command.request_representation = Google::Apis::DataprocV1::Cluster::Representation
  command.request_object = cluster_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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_location_session_template(name, session_template_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SessionTemplate

Updates the session template synchronously.

Parameters:

  • name (String) —

    Required. Identifier. The resource name of the session template.

  • session_template_object (Google::Apis::DataprocV1::SessionTemplate) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1751

def patch_project_location_session_template(name, session_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DataprocV1::SessionTemplate::Representation
  command.request_object = session_template_object
  command.response_representation = Google::Apis::DataprocV1::SessionTemplate::Representation
  command.response_class = Google::Apis::DataprocV1::SessionTemplate
  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

#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::DataprocV1::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 Dataproc region in which to handle the request.

  • job_id (String) —

    Required. The job ID.

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

    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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4581

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, 'v1/projects/{projectId}/regions/{region}/jobs/{jobId}', options)
  command.request_representation = Google::Apis::DataprocV1::Job::Representation
  command.request_object = job_object
  command.response_representation = Google::Apis::DataprocV1::Job::Representation
  command.response_class = Google::Apis::DataprocV1::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

#repair_cluster(project_id, region, cluster_name, repair_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Repairs a cluster.

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • cluster_name (String) —

    Required. The cluster name.

  • repair_cluster_request_object (Google::Apis::DataprocV1::RepairClusterRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4017

def repair_cluster(project_id, region, cluster_name, repair_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:repair', options)
  command.request_representation = Google::Apis::DataprocV1::RepairClusterRequest::Representation
  command.request_object = repair_cluster_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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

#repair_node_group(name, repair_node_group_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Repair nodes in a node group.

Parameters:

  • name (String) —

    Required. The name of the node group to resize. Format: projects/project/ regions/region/clusters/cluster/nodeGroups/nodeGroup

  • repair_node_group_request_object (Google::Apis::DataprocV1::RepairNodeGroupRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4294

def repair_node_group(name, repair_node_group_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:repair', options)
  command.request_representation = Google::Apis::DataprocV1::RepairNodeGroupRequest::Representation
  command.request_object = repair_node_group_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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

#resize_node_group(name, resize_node_group_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Resizes a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/ rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).

Parameters:

  • name (String) —

    Required. The name of the node group to resize. Format: projects/project/ regions/region/clusters/cluster/nodeGroups/nodeGroup

  • resize_node_group_request_object (Google::Apis::DataprocV1::ResizeNodeGroupRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4330

def resize_node_group(name, resize_node_group_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:resize', options)
  command.request_representation = Google::Apis::DataprocV1::ResizeNodeGroupRequest::Representation
  command.request_object = resize_node_group_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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

#search_project_location_batch_spark_application_executor_stage_summary(name, page_size: nil, page_token: nil, parent: nil, stage_attempt_id: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSparkApplicationExecutorStageSummaryResponse

Obtain executor summary with respect to a spark stage attempt.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous AccessSparkApplicationExecutorsList call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • stage_attempt_id (Fixnum) (defaults to: nil) —

    Required. Stage Attempt ID

  • stage_id (Fixnum) (defaults to: nil) —

    Required. Stage ID

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



935
936
937
938
939
940
941
942
943
944
945
946
947
948
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 935

def search_project_location_batch_spark_application_executor_stage_summary(name, page_size: nil, page_token: nil, parent: nil, stage_attempt_id: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchExecutorStageSummary', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSparkApplicationExecutorStageSummaryResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSparkApplicationExecutorStageSummaryResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageAttemptId'] = stage_attempt_id unless stage_attempt_id.nil?
  command.query['stageId'] = stage_id unless stage_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

#search_project_location_batch_spark_application_executors(name, executor_status: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSparkApplicationExecutorsResponse

Obtain data corresponding to executors for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • executor_status (String) (defaults to: nil) —

    Optional. Filter to select whether active/ dead or all executors should be selected.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous AccessSparkApplicationExecutorsList call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 985

def search_project_location_batch_spark_application_executors(name, executor_status: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchExecutors', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSparkApplicationExecutorsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSparkApplicationExecutorsResponse
  command.params['name'] = name unless name.nil?
  command.query['executorStatus'] = executor_status unless executor_status.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['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

#search_project_location_batch_spark_application_jobs(name, job_status: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSparkApplicationJobsResponse

Obtain list of spark jobs corresponding to a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • job_status (String) (defaults to: nil) —

    Optional. List only jobs in the specific state.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of jobs to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSparkApplicationJobs call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1032

def search_project_location_batch_spark_application_jobs(name, job_status: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchJobs', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSparkApplicationJobsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSparkApplicationJobsResponse
  command.params['name'] = name unless name.nil?
  command.query['jobStatus'] = job_status unless job_status.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['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

#search_project_location_batch_spark_application_sql_queries(name, details: nil, page_size: nil, page_token: nil, parent: nil, plan_description: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSparkApplicationSqlQueriesResponse

Obtain data corresponding to SQL Queries for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • details (Boolean) (defaults to: nil) —

    Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of queries to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSparkApplicationSqlQueries call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • plan_description (Boolean) (defaults to: nil) —

    Optional. Enables/ disables physical plan description on demand

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1083

def search_project_location_batch_spark_application_sql_queries(name, details: nil, page_size: nil, page_token: nil, parent: nil, plan_description: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchSqlQueries', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSparkApplicationSqlQueriesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSparkApplicationSqlQueriesResponse
  command.params['name'] = name unless name.nil?
  command.query['details'] = details unless details.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['planDescription'] = plan_description unless plan_description.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_batch_spark_application_stage_attempt_tasks(name, page_size: nil, page_token: nil, parent: nil, sort_runtime: nil, stage_attempt_id: nil, stage_id: nil, task_status: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSparkApplicationStageAttemptTasksResponse

Obtain data corresponding to tasks for a spark stage attempt for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of tasks to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous ListSparkApplicationStageAttemptTasks call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • sort_runtime (Boolean) (defaults to: nil) —

    Optional. Sort the tasks by runtime.

  • stage_attempt_id (Fixnum) (defaults to: nil) —

    Optional. Stage Attempt ID

  • stage_id (Fixnum) (defaults to: nil) —

    Optional. Stage ID

  • task_status (String) (defaults to: nil) —

    Optional. List only tasks in the state.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1139

def search_project_location_batch_spark_application_stage_attempt_tasks(name, page_size: nil, page_token: nil, parent: nil, sort_runtime: nil, stage_attempt_id: nil, stage_id: nil, task_status: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchStageAttemptTasks', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSparkApplicationStageAttemptTasksResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSparkApplicationStageAttemptTasksResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['sortRuntime'] = sort_runtime unless sort_runtime.nil?
  command.query['stageAttemptId'] = stage_attempt_id unless stage_attempt_id.nil?
  command.query['stageId'] = stage_id unless stage_id.nil?
  command.query['taskStatus'] = task_status unless task_status.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_batch_spark_application_stage_attempts(name, page_size: nil, page_token: nil, parent: nil, stage_id: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSparkApplicationStageAttemptsResponse

Obtain data corresponding to a spark stage attempts for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of stage attempts (paging based on stage_attempt_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSparkApplicationStageAttempts call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • stage_id (Fixnum) (defaults to: nil) —

    Required. Stage ID for which attempts are to be fetched

  • summary_metrics_mask (String) (defaults to: nil) —

    Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1195

def search_project_location_batch_spark_application_stage_attempts(name, page_size: nil, page_token: nil, parent: nil, stage_id: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchStageAttempts', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSparkApplicationStageAttemptsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSparkApplicationStageAttemptsResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageId'] = stage_id unless stage_id.nil?
  command.query['summaryMetricsMask'] = summary_metrics_mask unless summary_metrics_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

#search_project_location_batch_spark_application_stages(name, page_size: nil, page_token: nil, parent: nil, stage_status: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSparkApplicationStagesResponse

Obtain data corresponding to stages for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of stages (paging based on stage_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous FetchSparkApplicationStagesList call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • stage_status (String) (defaults to: nil) —

    Optional. List only stages in the given state.

  • summary_metrics_mask (String) (defaults to: nil) —

    Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1249

def search_project_location_batch_spark_application_stages(name, page_size: nil, page_token: nil, parent: nil, stage_status: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchStages', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSparkApplicationStagesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSparkApplicationStagesResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageStatus'] = stage_status unless stage_status.nil?
  command.query['summaryMetricsMask'] = summary_metrics_mask unless summary_metrics_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

#search_project_location_batch_spark_applications(parent, application_status: nil, max_end_time: nil, max_time: nil, min_end_time: nil, min_time: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSparkApplicationsResponse

Obtain high level information and list of Spark Applications corresponding to a batch

Parameters:

  • parent (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"

  • application_status (String) (defaults to: nil) —

    Optional. Search only applications in the chosen state.

  • max_end_time (String) (defaults to: nil) —

    Optional. Latest end timestamp to list.

  • max_time (String) (defaults to: nil) —

    Optional. Latest start timestamp to list.

  • min_end_time (String) (defaults to: nil) —

    Optional. Earliest end timestamp to list.

  • min_time (String) (defaults to: nil) —

    Optional. Earliest start timestamp to list.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of applications to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSparkApplications call. Provide this token to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 882

def search_project_location_batch_spark_applications(parent, application_status: nil, max_end_time: nil, max_time: nil, min_end_time: nil, min_time: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/sparkApplications:search', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSparkApplicationsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSparkApplicationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['applicationStatus'] = application_status unless application_status.nil?
  command.query['maxEndTime'] = max_end_time unless max_end_time.nil?
  command.query['maxTime'] = max_time unless max_time.nil?
  command.query['minEndTime'] = min_end_time unless min_end_time.nil?
  command.query['minTime'] = min_time unless min_time.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

#search_project_location_session_spark_application_executor_stage_summary(name, page_size: nil, page_token: nil, parent: nil, stage_attempt_id: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSessionSparkApplicationExecutorStageSummaryResponse

Obtain executor summary with respect to a spark stage attempt.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSessionSparkApplicationExecutorStageSummary call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • stage_attempt_id (Fixnum) (defaults to: nil) —

    Required. Stage Attempt ID

  • stage_id (Fixnum) (defaults to: nil) —

    Required. Stage ID

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2335

def search_project_location_session_spark_application_executor_stage_summary(name, page_size: nil, page_token: nil, parent: nil, stage_attempt_id: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchExecutorStageSummary', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSessionSparkApplicationExecutorStageSummaryResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSessionSparkApplicationExecutorStageSummaryResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageAttemptId'] = stage_attempt_id unless stage_attempt_id.nil?
  command.query['stageId'] = stage_id unless stage_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

#search_project_location_session_spark_application_executors(name, executor_status: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSessionSparkApplicationExecutorsResponse

Obtain data corresponding to executors for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • executor_status (String) (defaults to: nil) —

    Optional. Filter to select whether active/ dead or all executors should be selected.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSessionSparkApplicationExecutors call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2385

def search_project_location_session_spark_application_executors(name, executor_status: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchExecutors', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSessionSparkApplicationExecutorsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSessionSparkApplicationExecutorsResponse
  command.params['name'] = name unless name.nil?
  command.query['executorStatus'] = executor_status unless executor_status.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['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

#search_project_location_session_spark_application_jobs(name, job_ids: nil, job_status: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSessionSparkApplicationJobsResponse

Obtain list of spark jobs corresponding to a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • job_ids (Array<Fixnum>, Fixnum) (defaults to: nil) —

    Optional. List of Job IDs to filter by if provided.

  • job_status (String) (defaults to: nil) —

    Optional. List only jobs in the specific state.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of jobs to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSessionSparkApplicationJobs call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2435

def search_project_location_session_spark_application_jobs(name, job_ids: nil, job_status: nil, page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchJobs', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSessionSparkApplicationJobsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSessionSparkApplicationJobsResponse
  command.params['name'] = name unless name.nil?
  command.query['jobIds'] = job_ids unless job_ids.nil?
  command.query['jobStatus'] = job_status unless job_status.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['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

#search_project_location_session_spark_application_sql_queries(name, details: nil, operation_ids: nil, page_size: nil, page_token: nil, parent: nil, plan_description: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSessionSparkApplicationSqlQueriesResponse

Obtain data corresponding to SQL Queries for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • details (Boolean) (defaults to: nil) —

    Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.

  • operation_ids (Array<String>, String) (defaults to: nil) —

    Optional. List of Spark Connect operation IDs to filter by if provided.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of queries to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSessionSparkApplicationSqlQueries call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • plan_description (Boolean) (defaults to: nil) —

    Optional. Enables/ disables physical plan description on demand

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2489

def search_project_location_session_spark_application_sql_queries(name, details: nil, operation_ids: nil, page_size: nil, page_token: nil, parent: nil, plan_description: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchSqlQueries', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSessionSparkApplicationSqlQueriesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSessionSparkApplicationSqlQueriesResponse
  command.params['name'] = name unless name.nil?
  command.query['details'] = details unless details.nil?
  command.query['operationIds'] = operation_ids unless operation_ids.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['planDescription'] = plan_description unless plan_description.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_session_spark_application_stage_attempt_tasks(name, page_size: nil, page_token: nil, parent: nil, sort_runtime: nil, stage_attempt_id: nil, stage_id: nil, task_status: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSessionSparkApplicationStageAttemptTasksResponse

Obtain data corresponding to tasks for a spark stage attempt for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of tasks to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSessionSparkApplicationStageAttemptTasks call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • sort_runtime (Boolean) (defaults to: nil) —

    Optional. Sort the tasks by runtime.

  • stage_attempt_id (Fixnum) (defaults to: nil) —

    Optional. Stage Attempt ID

  • stage_id (Fixnum) (defaults to: nil) —

    Optional. Stage ID

  • task_status (String) (defaults to: nil) —

    Optional. List only tasks in the state.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2546

def search_project_location_session_spark_application_stage_attempt_tasks(name, page_size: nil, page_token: nil, parent: nil, sort_runtime: nil, stage_attempt_id: nil, stage_id: nil, task_status: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchStageAttemptTasks', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSessionSparkApplicationStageAttemptTasksResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSessionSparkApplicationStageAttemptTasksResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['sortRuntime'] = sort_runtime unless sort_runtime.nil?
  command.query['stageAttemptId'] = stage_attempt_id unless stage_attempt_id.nil?
  command.query['stageId'] = stage_id unless stage_id.nil?
  command.query['taskStatus'] = task_status unless task_status.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_session_spark_application_stage_attempts(name, page_size: nil, page_token: nil, parent: nil, stage_id: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSessionSparkApplicationStageAttemptsResponse

Obtain data corresponding to a spark stage attempts for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of stage attempts (paging based on stage_attempt_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSessionSparkApplicationStageAttempts call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • stage_id (Fixnum) (defaults to: nil) —

    Required. Stage ID for which attempts are to be fetched

  • summary_metrics_mask (String) (defaults to: nil) —

    Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2602

def search_project_location_session_spark_application_stage_attempts(name, page_size: nil, page_token: nil, parent: nil, stage_id: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchStageAttempts', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSessionSparkApplicationStageAttemptsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSessionSparkApplicationStageAttemptsResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageId'] = stage_id unless stage_id.nil?
  command.query['summaryMetricsMask'] = summary_metrics_mask unless summary_metrics_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

#search_project_location_session_spark_application_stages(name, page_size: nil, page_token: nil, parent: nil, stage_ids: nil, stage_status: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSessionSparkApplicationStagesResponse

Obtain data corresponding to stages for a Spark Application.

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of stages (paging based on stage_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSessionSparkApplicationStages call. Provide this token to retrieve the subsequent page.

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • stage_ids (Array<Fixnum>, Fixnum) (defaults to: nil) —

    Optional. List of Stage IDs to filter by if provided.

  • stage_status (String) (defaults to: nil) —

    Optional. List only stages in the given state.

  • summary_metrics_mask (String) (defaults to: nil) —

    Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2658

def search_project_location_session_spark_application_stages(name, page_size: nil, page_token: nil, parent: nil, stage_ids: nil, stage_status: nil, summary_metrics_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:searchStages', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSessionSparkApplicationStagesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSessionSparkApplicationStagesResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageIds'] = stage_ids unless stage_ids.nil?
  command.query['stageStatus'] = stage_status unless stage_status.nil?
  command.query['summaryMetricsMask'] = summary_metrics_mask unless summary_metrics_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

#search_project_location_session_spark_applications(parent, application_status: nil, max_end_time: nil, max_time: nil, min_end_time: nil, min_time: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SearchSessionSparkApplicationsResponse

Obtain high level information and list of Spark Applications corresponding to a batch

Parameters:

  • parent (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID"

  • application_status (String) (defaults to: nil) —

    Optional. Search only applications in the chosen state.

  • max_end_time (String) (defaults to: nil) —

    Optional. Latest end timestamp to list.

  • max_time (String) (defaults to: nil) —

    Optional. Latest start timestamp to list.

  • min_end_time (String) (defaults to: nil) —

    Optional. Earliest end timestamp to list.

  • min_time (String) (defaults to: nil) —

    Optional. Earliest start timestamp to list.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of applications to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.

  • page_token (String) (defaults to: nil) —

    Optional. A page token received from a previous SearchSessionSparkApplications call. Provide this token to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2282

def search_project_location_session_spark_applications(parent, application_status: nil, max_end_time: nil, max_time: nil, min_end_time: nil, min_time: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/sparkApplications:search', options)
  command.response_representation = Google::Apis::DataprocV1::SearchSessionSparkApplicationsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SearchSessionSparkApplicationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['applicationStatus'] = application_status unless application_status.nil?
  command.query['maxEndTime'] = max_end_time unless max_end_time.nil?
  command.query['maxTime'] = max_time unless max_time.nil?
  command.query['minEndTime'] = min_end_time unless min_end_time.nil?
  command.query['minTime'] = min_time unless min_time.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

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

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4056

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, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4621

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, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4954

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, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 269

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, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3188

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, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3494

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, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 5332

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, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataprocV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataprocV1::Policy::Representation
  command.response_class = Google::Apis::DataprocV1::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

#start_cluster(project_id, region, cluster_name, start_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Starts 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 Dataproc region in which to handle the request.

  • cluster_name (String) —

    Required. The cluster name.

  • start_cluster_request_object (Google::Apis::DataprocV1::StartClusterRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4093

def start_cluster(project_id, region, cluster_name, start_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:start', options)
  command.request_representation = Google::Apis::DataprocV1::StartClusterRequest::Representation
  command.request_object = start_cluster_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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

#stop_cluster(project_id, region, cluster_name, stop_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Stops 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 Dataproc region in which to handle the request.

  • cluster_name (String) —

    Required. The cluster name.

  • stop_cluster_request_object (Google::Apis::DataprocV1::StopClusterRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4132

def stop_cluster(project_id, region, cluster_name, stop_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop', options)
  command.request_representation = Google::Apis::DataprocV1::StopClusterRequest::Representation
  command.request_object = stop_cluster_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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

#submit_job(project_id, region, submit_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Dataproc region in which to handle the request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4656

def submit_job(project_id, region, submit_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectId}/regions/{region}/jobs:submit', options)
  command.request_representation = Google::Apis::DataprocV1::SubmitJobRequest::Representation
  command.request_object = submit_job_request_object
  command.response_representation = Google::Apis::DataprocV1::Job::Representation
  command.response_class = Google::Apis::DataprocV1::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

#submit_project_region_job_as_operation(project_id, region, submit_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Submits 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 Dataproc region in which to handle the request.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4692

def submit_project_region_job_as_operation(project_id, region, submit_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectId}/regions/{region}/jobs:submitAsOperation', options)
  command.request_representation = Google::Apis::DataprocV1::SubmitJobRequest::Representation
  command.request_object = submit_job_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::Operation
  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

#summarize_project_location_batch_spark_application_executors(name, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SummarizeSparkApplicationExecutorsResponse

Obtain summary of Executor Summary for a Spark Application

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1288

def summarize_project_location_batch_spark_application_executors(name, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:summarizeExecutors', options)
  command.response_representation = Google::Apis::DataprocV1::SummarizeSparkApplicationExecutorsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SummarizeSparkApplicationExecutorsResponse
  command.params['name'] = name unless name.nil?
  command.query['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

#summarize_project_location_batch_spark_application_jobs(name, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SummarizeSparkApplicationJobsResponse

Obtain summary of Jobs for a Spark Application

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1323

def summarize_project_location_batch_spark_application_jobs(name, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:summarizeJobs', options)
  command.response_representation = Google::Apis::DataprocV1::SummarizeSparkApplicationJobsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SummarizeSparkApplicationJobsResponse
  command.params['name'] = name unless name.nil?
  command.query['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

#summarize_project_location_batch_spark_application_stage_attempt_tasks(name, parent: nil, stage_attempt_id: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SummarizeSparkApplicationStageAttemptTasksResponse

Obtain summary of Tasks for a Spark Application Stage Attempt

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • stage_attempt_id (Fixnum) (defaults to: nil) —

    Required. Stage Attempt ID

  • stage_id (Fixnum) (defaults to: nil) —

    Required. Stage ID

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1362

def summarize_project_location_batch_spark_application_stage_attempt_tasks(name, parent: nil, stage_attempt_id: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:summarizeStageAttemptTasks', options)
  command.response_representation = Google::Apis::DataprocV1::SummarizeSparkApplicationStageAttemptTasksResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SummarizeSparkApplicationStageAttemptTasksResponse
  command.params['name'] = name unless name.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageAttemptId'] = stage_attempt_id unless stage_attempt_id.nil?
  command.query['stageId'] = stage_id unless stage_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

#summarize_project_location_batch_spark_application_stages(name, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SummarizeSparkApplicationStagesResponse

Obtain summary of Stages for a Spark Application

Parameters:

  • name (String) —

    Required. The fully qualified name of the batch to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Batch) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1399

def summarize_project_location_batch_spark_application_stages(name, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:summarizeStages', options)
  command.response_representation = Google::Apis::DataprocV1::SummarizeSparkApplicationStagesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SummarizeSparkApplicationStagesResponse
  command.params['name'] = name unless name.nil?
  command.query['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

#summarize_project_location_session_spark_application_executors(name, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SummarizeSessionSparkApplicationExecutorsResponse

Obtain summary of Executor Summary for a Spark Application

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2698

def summarize_project_location_session_spark_application_executors(name, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:summarizeExecutors', options)
  command.response_representation = Google::Apis::DataprocV1::SummarizeSessionSparkApplicationExecutorsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SummarizeSessionSparkApplicationExecutorsResponse
  command.params['name'] = name unless name.nil?
  command.query['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

#summarize_project_location_session_spark_application_jobs(name, job_ids: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SummarizeSessionSparkApplicationJobsResponse

Obtain summary of Jobs for a Spark Application

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • job_ids (Array<Fixnum>, Fixnum) (defaults to: nil) —

    Optional. List of Job IDs to filter by if provided.

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2735

def summarize_project_location_session_spark_application_jobs(name, job_ids: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:summarizeJobs', options)
  command.response_representation = Google::Apis::DataprocV1::SummarizeSessionSparkApplicationJobsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SummarizeSessionSparkApplicationJobsResponse
  command.params['name'] = name unless name.nil?
  command.query['jobIds'] = job_ids unless job_ids.nil?
  command.query['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

#summarize_project_location_session_spark_application_stage_attempt_tasks(name, parent: nil, stage_attempt_id: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SummarizeSessionSparkApplicationStageAttemptTasksResponse

Obtain summary of Tasks for a Spark Application Stage Attempt

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • stage_attempt_id (Fixnum) (defaults to: nil) —

    Required. Stage Attempt ID

  • stage_id (Fixnum) (defaults to: nil) —

    Required. Stage ID

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2775

def summarize_project_location_session_spark_application_stage_attempt_tasks(name, parent: nil, stage_attempt_id: nil, stage_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:summarizeStageAttemptTasks', options)
  command.response_representation = Google::Apis::DataprocV1::SummarizeSessionSparkApplicationStageAttemptTasksResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SummarizeSessionSparkApplicationStageAttemptTasksResponse
  command.params['name'] = name unless name.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageAttemptId'] = stage_attempt_id unless stage_attempt_id.nil?
  command.query['stageId'] = stage_id unless stage_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

#summarize_project_location_session_spark_application_stages(name, parent: nil, stage_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::SummarizeSessionSparkApplicationStagesResponse

Obtain summary of Stages for a Spark Application

Parameters:

  • name (String) —

    Required. The fully qualified name of the session to retrieve in the format " projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/ sparkApplications/APPLICATION_ID"

  • parent (String) (defaults to: nil) —

    Required. Parent (Session) resource reference.

  • stage_ids (Array<Fixnum>, Fixnum) (defaults to: nil) —

    Optional. List of Stage IDs to filter by if provided.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2814

def summarize_project_location_session_spark_application_stages(name, parent: nil, stage_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:summarizeStages', options)
  command.response_representation = Google::Apis::DataprocV1::SummarizeSessionSparkApplicationStagesResponse::Representation
  command.response_class = Google::Apis::DataprocV1::SummarizeSessionSparkApplicationStagesResponse
  command.params['name'] = name unless name.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['stageIds'] = stage_ids unless stage_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#terminate_session(name, terminate_session_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::Operation

Terminates the interactive session.

Parameters:

  • name (String) —

    Required. The name of the session resource to terminate.

  • terminate_session_request_object (Google::Apis::DataprocV1::TerminateSessionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1953

def terminate_session(name, terminate_session_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:terminate', options)
  command.request_representation = Google::Apis::DataprocV1::TerminateSessionRequest::Representation
  command.request_object = terminate_session_request_object
  command.response_representation = Google::Apis::DataprocV1::Operation::Representation
  command.response_class = Google::Apis::DataprocV1::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

#test_cluster_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4173

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, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4732

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, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 4993

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, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 308

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, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3227

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, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3533

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, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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 Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 5371

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, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataprocV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataprocV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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 autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions. autoscalingPolicies, the resource name of the policy has the following format: projects/project_id/regions/region/autoscalingPolicies/policy_id For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/project_id/locations/location/ autoscalingPolicies/policy_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 348

def update_project_location_autoscaling_policy(name, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DataprocV1::AutoscalingPolicy::Representation
  command.request_object = autoscaling_policy_object
  command.response_representation = Google::Apis::DataprocV1::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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 workflow template, as described in https: //cloud.google.com/apis/design/resource_names. For projects.regions. workflowTemplates, the resource name of the template has the following format: projects/project_id/regions/region/workflowTemplates/template_id For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/project_id/locations/location/ workflowTemplates/template_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3267

def update_project_location_workflow_template(name, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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 autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions. autoscalingPolicies, the resource name of the policy has the following format: projects/project_id/regions/region/autoscalingPolicies/policy_id For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/project_id/locations/location/ autoscalingPolicies/policy_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 3573

def update_project_region_autoscaling_policy(name, autoscaling_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DataprocV1::AutoscalingPolicy::Representation
  command.request_object = autoscaling_policy_object
  command.response_representation = Google::Apis::DataprocV1::AutoscalingPolicy::Representation
  command.response_class = Google::Apis::DataprocV1::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::DataprocV1::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 workflow template, as described in https: //cloud.google.com/apis/design/resource_names. For projects.regions. workflowTemplates, the resource name of the template has the following format: projects/project_id/regions/region/workflowTemplates/template_id For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/project_id/locations/location/ workflowTemplates/template_id

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 5411

def update_project_region_workflow_template(name, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.request_object = workflow_template_object
  command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
  command.response_class = Google::Apis::DataprocV1::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

#write_session_spark_application_context(name, write_session_spark_application_context_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::WriteSessionSparkApplicationContextResponse

Write wrapper objects from dataplane to spanner

Parameters:

  • name (String) —

    Required. The fully qualified name of the spark application to write data about in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/ SESSION_ID/sparkApplications/APPLICATION_ID"

  • write_session_spark_application_context_request_object (Google::Apis::DataprocV1::WriteSessionSparkApplicationContextRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 2849

def write_session_spark_application_context(name, write_session_spark_application_context_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:write', options)
  command.request_representation = Google::Apis::DataprocV1::WriteSessionSparkApplicationContextRequest::Representation
  command.request_object = write_session_spark_application_context_request_object
  command.response_representation = Google::Apis::DataprocV1::WriteSessionSparkApplicationContextResponse::Representation
  command.response_class = Google::Apis::DataprocV1::WriteSessionSparkApplicationContextResponse
  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

#write_spark_application_context(name, write_spark_application_context_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataprocV1::WriteSparkApplicationContextResponse

Write wrapper objects from dataplane to spanner

Parameters:

  • name (String) —

    Required. The fully qualified name of the spark application to write data about in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/ BATCH_ID/sparkApplications/APPLICATION_ID"

  • write_spark_application_context_request_object (Google::Apis::DataprocV1::WriteSparkApplicationContextRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'lib/google/apis/dataproc_v1/service.rb', line 1433

def write_spark_application_context(name, write_spark_application_context_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:write', options)
  command.request_representation = Google::Apis::DataprocV1::WriteSparkApplicationContextRequest::Representation
  command.request_object = write_spark_application_context_request_object
  command.response_representation = Google::Apis::DataprocV1::WriteSparkApplicationContextResponse::Representation
  command.response_class = Google::Apis::DataprocV1::WriteSparkApplicationContextResponse
  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