Class: Google::Apis::DataprocV1::Job

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataproc_v1/classes.rb,
lib/google/apis/dataproc_v1/representations.rb,
lib/google/apis/dataproc_v1/representations.rb

Overview

A Dataproc job resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Job

Returns a new instance of Job.



4506
4507
4508
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4506

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#done ⇒ Boolean Also known as: done?

Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled. Corresponds to the JSON property done

Returns:

  • (Boolean) 


4372
4373
4374
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4372

def done
  @done
end

#driver_control_files_uri ⇒ String

Output only. If present, the location of miscellaneous control files which can be used as part of job setup and handling. If not present, control files might be placed in the same location as driver_output_uri. Corresponds to the JSON property driverControlFilesUri

Returns:

  • (String) 


4380
4381
4382
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4380

def driver_control_files_uri
  @driver_control_files_uri
end

#driver_output_resource_uri ⇒ String

Output only. A URI pointing to the location of the stdout of the job's driver program. Corresponds to the JSON property driverOutputResourceUri

Returns:

  • (String) 


4386
4387
4388
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4386

def driver_output_resource_uri
  @driver_output_resource_uri
end

#driver_scheduling_config ⇒ Google::Apis::DataprocV1::DriverSchedulingConfig

Driver scheduling configuration. Corresponds to the JSON property driverSchedulingConfig

Returns:



4391
4392
4393
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4391

def driver_scheduling_config
  @driver_scheduling_config
end

#flink_job ⇒ Google::Apis::DataprocV1::FlinkJob

A Dataproc job for running Apache Flink applications on YARN. Corresponds to the JSON property flinkJob

Returns:



4396
4397
4398
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4396

def flink_job
  @flink_job
end

#hadoop_job ⇒ Google::Apis::DataprocV1::HadoopJob

A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/ docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/ MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/ docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). Corresponds to the JSON property hadoopJob

Returns:



4404
4405
4406
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4404

def hadoop_job
  @hadoop_job
end

#hive_job ⇒ Google::Apis::DataprocV1::HiveJob

A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. Corresponds to the JSON property hiveJob

Returns:



4410
4411
4412
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4410

def hive_job
  @hive_job
end

#job_uuid ⇒ String

Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that might be reused over time. Corresponds to the JSON property jobUuid

Returns:

  • (String) 


4417
4418
4419
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4417

def job_uuid
  @job_uuid
end

#labels ⇒ Hash<String,String>

Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035. txt). Label values can be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt) . No more than 32 labels can be associated with a job. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


4426
4427
4428
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4426

def labels
  @labels
end

#pig_job ⇒ Google::Apis::DataprocV1::PigJob

A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. Corresponds to the JSON property pigJob

Returns:



4432
4433
4434
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4432

def pig_job
  @pig_job
end

#placement ⇒ Google::Apis::DataprocV1::JobPlacement

Dataproc job config. Corresponds to the JSON property placement

Returns:



4437
4438
4439
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4437

def placement
  @placement
end

#presto_job ⇒ Google::Apis::DataprocV1::PrestoJob

A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/ concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. Corresponds to the JSON property prestoJob

Returns:



4445
4446
4447
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4445

def presto_job
  @presto_job
end

#pyspark_job ⇒ Google::Apis::DataprocV1::PySparkJob

A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/ latest/api/python/index.html#pyspark-overview) applications on YARN. Corresponds to the JSON property pysparkJob

Returns:



4451
4452
4453
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4451

def pyspark_job
  @pyspark_job
end

#reference ⇒ Google::Apis::DataprocV1::JobReference

Encapsulates the full scoping used to reference a job. Corresponds to the JSON property reference

Returns:



4456
4457
4458
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4456

def reference
  @reference
end

#scheduling ⇒ Google::Apis::DataprocV1::JobScheduling

Job scheduling options. Corresponds to the JSON property scheduling

Returns:



4461
4462
4463
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4461

def scheduling
  @scheduling
end

#spark_job ⇒ Google::Apis::DataprocV1::SparkJob

A Dataproc job for running Apache Spark (https://spark.apache.org/) applications on YARN. Corresponds to the JSON property sparkJob

Returns:



4467
4468
4469
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4467

def spark_job
  @spark_job
end

#spark_r_job ⇒ Google::Apis::DataprocV1::SparkRJob

A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/ sparkr.html) applications on YARN. Corresponds to the JSON property sparkRJob

Returns:



4473
4474
4475
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4473

def spark_r_job
  @spark_r_job
end

#spark_sql_job ⇒ Google::Apis::DataprocV1::SparkSqlJob

A Dataproc job for running Apache Spark SQL (https://spark.apache.org/sql/) queries. Corresponds to the JSON property sparkSqlJob

Returns:



4479
4480
4481
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4479

def spark_sql_job
  @spark_sql_job
end

#status ⇒ Google::Apis::DataprocV1::JobStatus

Dataproc job status. Corresponds to the JSON property status

Returns:



4484
4485
4486
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4484

def status
  @status
end

#status_history ⇒ Array<Google::Apis::DataprocV1::JobStatus>

Output only. The previous job status. Corresponds to the JSON property statusHistory

Returns:



4489
4490
4491
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4489

def status_history
  @status_history
end

#trino_job ⇒ Google::Apis::DataprocV1::TrinoJob

A Dataproc job for running Trino (https://trino.io/) queries. IMPORTANT: The Dataproc Trino Optional Component (https://cloud.google.com/dataproc/docs/ concepts/components/trino) must be enabled when the cluster is created to submit a Trino job to the cluster. Corresponds to the JSON property trinoJob

Returns:



4497
4498
4499
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4497

def trino_job
  @trino_job
end

#yarn_applications ⇒ Array<Google::Apis::DataprocV1::YarnApplication>

Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release. Corresponds to the JSON property yarnApplications

Returns:



4504
4505
4506
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4504

def yarn_applications
  @yarn_applications
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 4511

def update!(**args)
  @done = args[:done] if args.key?(:done)
  @driver_control_files_uri = args[:driver_control_files_uri] if args.key?(:driver_control_files_uri)
  @driver_output_resource_uri = args[:driver_output_resource_uri] if args.key?(:driver_output_resource_uri)
  @driver_scheduling_config = args[:driver_scheduling_config] if args.key?(:driver_scheduling_config)
  @flink_job = args[:flink_job] if args.key?(:flink_job)
  @hadoop_job = args[:hadoop_job] if args.key?(:hadoop_job)
  @hive_job = args[:hive_job] if args.key?(:hive_job)
  @job_uuid = args[:job_uuid] if args.key?(:job_uuid)
  @labels = args[:labels] if args.key?(:labels)
  @pig_job = args[:pig_job] if args.key?(:pig_job)
  @placement = args[:placement] if args.key?(:placement)
  @presto_job = args[:presto_job] if args.key?(:presto_job)
  @pyspark_job = args[:pyspark_job] if args.key?(:pyspark_job)
  @reference = args[:reference] if args.key?(:reference)
  @scheduling = args[:scheduling] if args.key?(:scheduling)
  @spark_job = args[:spark_job] if args.key?(:spark_job)
  @spark_r_job = args[:spark_r_job] if args.key?(:spark_r_job)
  @spark_sql_job = args[:spark_sql_job] if args.key?(:spark_sql_job)
  @status = args[:status] if args.key?(:status)
  @status_history = args[:status_history] if args.key?(:status_history)
  @trino_job = args[:trino_job] if args.key?(:trino_job)
  @yarn_applications = args[:yarn_applications] if args.key?(:yarn_applications)
end