Class: Google::Apis::DataprocV1beta2::Job

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataproc_v1beta2/classes.rb,
lib/google/apis/dataproc_v1beta2/representations.rb,
lib/google/apis/dataproc_v1beta2/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.



1637
1638
1639
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1637

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) 


1512
1513
1514
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1512

def done
  @done
end

#driver_control_files_uri ⇒ String

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

Returns:

  • (String) 


1520
1521
1522
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1520

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) 


1526
1527
1528
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1526

def driver_output_resource_uri
  @driver_output_resource_uri
end

#hadoop_job ⇒ Google::Apis::DataprocV1beta2::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:



1534
1535
1536
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1534

def hadoop_job
  @hadoop_job
end

#hive_job ⇒ Google::Apis::DataprocV1beta2::HiveJob

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

Returns:



1540
1541
1542
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1540

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 may be reused over time. Corresponds to the JSON property jobUuid

Returns:

  • (String) 


1547
1548
1549
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1547

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 may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt) . No more than 32 labels can be associated with a job. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1556
1557
1558
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1556

def labels
  @labels
end

#pig_job ⇒ Google::Apis::DataprocV1beta2::PigJob

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

Returns:



1562
1563
1564
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1562

def pig_job
  @pig_job
end

#placement ⇒ Google::Apis::DataprocV1beta2::JobPlacement

Dataproc job config. Corresponds to the JSON property placement

Returns:



1567
1568
1569
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1567

def placement
  @placement
end

#presto_job ⇒ Google::Apis::DataprocV1beta2::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:



1575
1576
1577
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1575

def presto_job
  @presto_job
end

#pyspark_job ⇒ Google::Apis::DataprocV1beta2::PySparkJob

A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/ python-programming-guide.html) applications on YARN. Corresponds to the JSON property pysparkJob

Returns:



1581
1582
1583
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1581

def pyspark_job
  @pyspark_job
end

#reference ⇒ Google::Apis::DataprocV1beta2::JobReference

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

Returns:



1586
1587
1588
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1586

def reference
  @reference
end

#scheduling ⇒ Google::Apis::DataprocV1beta2::JobScheduling

Job scheduling options. Corresponds to the JSON property scheduling

Returns:



1591
1592
1593
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1591

def scheduling
  @scheduling
end

#spark_job ⇒ Google::Apis::DataprocV1beta2::SparkJob

A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. Corresponds to the JSON property sparkJob

Returns:



1600
1601
1602
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1600

def spark_job
  @spark_job
end

#spark_r_job ⇒ Google::Apis::DataprocV1beta2::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:



1606
1607
1608
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1606

def spark_r_job
  @spark_r_job
end

#spark_sql_job ⇒ Google::Apis::DataprocV1beta2::SparkSqlJob

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

Returns:



1612
1613
1614
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1612

def spark_sql_job
  @spark_sql_job
end

#status ⇒ Google::Apis::DataprocV1beta2::JobStatus

Dataproc job status. Corresponds to the JSON property status

Returns:



1617
1618
1619
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1617

def status
  @status
end

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

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

Returns:



1622
1623
1624
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1622

def status_history
  @status_history
end

#submitted_by ⇒ String

Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is username@hostname. Corresponds to the JSON property submittedBy

Returns:

  • (String) 


1628
1629
1630
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1628

def submitted_by
  @submitted_by
end

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

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

Returns:



1635
1636
1637
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1635

def yarn_applications
  @yarn_applications
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
 
# File 'lib/google/apis/dataproc_v1beta2/classes.rb', line 1642

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)
  @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)
  @submitted_by = args[:submitted_by] if args.key?(:submitted_by)
  @yarn_applications = args[:yarn_applications] if args.key?(:yarn_applications)
end