Class: Google::Cloud::Dataproc::V1::Job

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataproc/v1/jobs.rb

Overview

A Dataproc job resource.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#done ⇒ ::Boolean (readonly)

Returns 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.

Returns:

  • (::Boolean) —

    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.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#driver_control_files_uri ⇒ ::String (readonly)

Returns 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.

Returns:

  • (::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.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#driver_output_resource_uri ⇒ ::String (readonly)

Returns Output only. A URI pointing to the location of the stdout of the job's driver program.

Returns:

  • (::String) —

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



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#driver_scheduling_config ⇒ ::Google::Cloud::Dataproc::V1::DriverSchedulingConfig

Returns Optional. Driver scheduling configuration.

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#flink_job ⇒ ::Google::Cloud::Dataproc::V1::FlinkJob

Returns Optional. Job is a Flink job.

Note: The following fields are mutually exclusive: flink_job, hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_r_job, spark_sql_job, presto_job, trino_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dataproc::V1::FlinkJob) —

    Optional. Job is a Flink job.

    Note: The following fields are mutually exclusive: flink_job, hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_r_job, spark_sql_job, presto_job, trino_job. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#hadoop_job ⇒ ::Google::Cloud::Dataproc::V1::HadoopJob

Returns Optional. Job is a Hadoop job.

Note: The following fields are mutually exclusive: hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_r_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dataproc::V1::HadoopJob) —

    Optional. Job is a Hadoop job.

    Note: The following fields are mutually exclusive: hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_r_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#hive_job ⇒ ::Google::Cloud::Dataproc::V1::HiveJob

Returns Optional. Job is a Hive job.

Note: The following fields are mutually exclusive: hive_job, hadoop_job, spark_job, pyspark_job, pig_job, spark_r_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dataproc::V1::HiveJob) —

    Optional. Job is a Hive job.

    Note: The following fields are mutually exclusive: hive_job, hadoop_job, spark_job, pyspark_job, pig_job, spark_r_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#job_uuid ⇒ ::String (readonly)

Returns 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.

Returns:

  • (::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.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a job.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a job.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pig_job ⇒ ::Google::Cloud::Dataproc::V1::PigJob

Returns Optional. Job is a Pig job.

Note: The following fields are mutually exclusive: pig_job, hadoop_job, spark_job, pyspark_job, hive_job, spark_r_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dataproc::V1::PigJob) —

    Optional. Job is a Pig job.

    Note: The following fields are mutually exclusive: pig_job, hadoop_job, spark_job, pyspark_job, hive_job, spark_r_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#placement ⇒ ::Google::Cloud::Dataproc::V1::JobPlacement

Returns Required. Job information, including how, when, and where to run the job.

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#presto_job ⇒ ::Google::Cloud::Dataproc::V1::PrestoJob

Returns Optional. Job is a Presto job.

Note: The following fields are mutually exclusive: presto_job, hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_r_job, spark_sql_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dataproc::V1::PrestoJob) —

    Optional. Job is a Presto job.

    Note: The following fields are mutually exclusive: presto_job, hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_r_job, spark_sql_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pyspark_job ⇒ ::Google::Cloud::Dataproc::V1::PySparkJob

Returns Optional. Job is a PySpark job.

Note: The following fields are mutually exclusive: pyspark_job, hadoop_job, spark_job, hive_job, pig_job, spark_r_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dataproc::V1::PySparkJob) —

    Optional. Job is a PySpark job.

    Note: The following fields are mutually exclusive: pyspark_job, hadoop_job, spark_job, hive_job, pig_job, spark_r_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#reference ⇒ ::Google::Cloud::Dataproc::V1::JobReference

Returns Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.

Returns:

  • (::Google::Cloud::Dataproc::V1::JobReference) —

    Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#scheduling ⇒ ::Google::Cloud::Dataproc::V1::JobScheduling

Returns Optional. Job scheduling configuration.

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#spark_job ⇒ ::Google::Cloud::Dataproc::V1::SparkJob

Returns Optional. Job is a Spark job.

Note: The following fields are mutually exclusive: spark_job, hadoop_job, pyspark_job, hive_job, pig_job, spark_r_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dataproc::V1::SparkJob) —

    Optional. Job is a Spark job.

    Note: The following fields are mutually exclusive: spark_job, hadoop_job, pyspark_job, hive_job, pig_job, spark_r_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#spark_r_job ⇒ ::Google::Cloud::Dataproc::V1::SparkRJob

Returns Optional. Job is a SparkR job.

Note: The following fields are mutually exclusive: spark_r_job, hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dataproc::V1::SparkRJob) —

    Optional. Job is a SparkR job.

    Note: The following fields are mutually exclusive: spark_r_job, hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_sql_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#spark_sql_job ⇒ ::Google::Cloud::Dataproc::V1::SparkSqlJob

Returns Optional. Job is a SparkSql job.

Note: The following fields are mutually exclusive: spark_sql_job, hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_r_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dataproc::V1::SparkSqlJob) —

    Optional. Job is a SparkSql job.

    Note: The following fields are mutually exclusive: spark_sql_job, hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_r_job, presto_job, trino_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#status ⇒ ::Google::Cloud::Dataproc::V1::JobStatus (readonly)

Returns Output only. The job status. Additional application-specific status information might be contained in the type_job and yarn_applications fields.

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#status_history ⇒ ::Array<::Google::Cloud::Dataproc::V1::JobStatus> (readonly)

Returns Output only. The previous job status.

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#trino_job ⇒ ::Google::Cloud::Dataproc::V1::TrinoJob

Returns Optional. Job is a Trino job.

Note: The following fields are mutually exclusive: trino_job, hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_r_job, spark_sql_job, presto_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dataproc::V1::TrinoJob) —

    Optional. Job is a Trino job.

    Note: The following fields are mutually exclusive: trino_job, hadoop_job, spark_job, pyspark_job, hive_job, pig_job, spark_r_job, spark_sql_job, presto_job, flink_job. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#yarn_applications ⇒ ::Array<::Google::Cloud::Dataproc::V1::YarnApplication> (readonly)

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Dataproc::V1::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.



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'proto_docs/google/cloud/dataproc/v1/jobs.rb', line 918

class Job
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end