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.



1969
1970
1971
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1969

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) 


1853
1854
1855
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1853

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) 


1861
1862
1863
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1861

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) 


1867
1868
1869
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1867

def driver_output_resource_uri
  @driver_output_resource_uri
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:



1875
1876
1877
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1875

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:



1881
1882
1883
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1881

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) 


1888
1889
1890
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1888

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>) 


1897
1898
1899
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1897

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:



1903
1904
1905
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1903

def pig_job
  @pig_job
end

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

Dataproc job config. Corresponds to the JSON property placement

Returns:



1908
1909
1910
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1908

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:



1916
1917
1918
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1916

def presto_job
  @presto_job
end

#pyspark_job ⇒ Google::Apis::DataprocV1::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:



1922
1923
1924
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1922

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:



1927
1928
1929
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1927

def reference
  @reference
end

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

Job scheduling options. Corresponds to the JSON property scheduling

Returns:



1932
1933
1934
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1932

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:



1938
1939
1940
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1938

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:



1944
1945
1946
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1944

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:



1950
1951
1952
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1950

def spark_sql_job
  @spark_sql_job
end

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

Dataproc job status. Corresponds to the JSON property status

Returns:



1955
1956
1957
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1955

def status
  @status
end

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

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

Returns:



1960
1961
1962
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1960

def status_history
  @status_history
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 may be changed before final release. Corresponds to the JSON property yarnApplications

Returns:



1967
1968
1969
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1967

def yarn_applications
  @yarn_applications
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 1974

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