Interface JobOrBuilder (4.24.0)

Version 4.24.0

• 4.52.0 (latest)
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.46.0
• 4.45.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.34.0
• 4.33.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.8
• 3.1.2
• 3.0.3
• 2.3.1

public interface JobOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may 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.

map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getDone()

public abstract boolean getDone()

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.

bool done = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The done.

getDriverControlFilesUri()

public abstract String getDriverControlFilesUri()

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.

string driver_control_files_uri = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The driverControlFilesUri.

getDriverControlFilesUriBytes()

public abstract ByteString getDriverControlFilesUriBytes()

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.

string driver_control_files_uri = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for driverControlFilesUri.

getDriverOutputResourceUri()

public abstract String getDriverOutputResourceUri()

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

string driver_output_resource_uri = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The driverOutputResourceUri.

getDriverOutputResourceUriBytes()

public abstract ByteString getDriverOutputResourceUriBytes()

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

string driver_output_resource_uri = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for driverOutputResourceUri.

getDriverSchedulingConfig()

public abstract DriverSchedulingConfig getDriverSchedulingConfig()

Optional. Driver scheduling configuration.

.google.cloud.dataproc.v1.DriverSchedulingConfig driver_scheduling_config = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DriverSchedulingConfig	The driverSchedulingConfig.

getDriverSchedulingConfigOrBuilder()

public abstract DriverSchedulingConfigOrBuilder getDriverSchedulingConfigOrBuilder()

Optional. Driver scheduling configuration.

.google.cloud.dataproc.v1.DriverSchedulingConfig driver_scheduling_config = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DriverSchedulingConfigOrBuilder

getHadoopJob()

public abstract HadoopJob getHadoopJob()

Optional. Job is a Hadoop job.

.google.cloud.dataproc.v1.HadoopJob hadoop_job = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
HadoopJob	The hadoopJob.

getHadoopJobOrBuilder()

public abstract HadoopJobOrBuilder getHadoopJobOrBuilder()

Optional. Job is a Hadoop job.

.google.cloud.dataproc.v1.HadoopJob hadoop_job = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
HadoopJobOrBuilder

getHiveJob()

public abstract HiveJob getHiveJob()

Optional. Job is a Hive job.

.google.cloud.dataproc.v1.HiveJob hive_job = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
HiveJob	The hiveJob.

getHiveJobOrBuilder()

public abstract HiveJobOrBuilder getHiveJobOrBuilder()

Optional. Job is a Hive job.

.google.cloud.dataproc.v1.HiveJob hive_job = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
HiveJobOrBuilder

getJobUuid()

public abstract String getJobUuid()

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.

string job_uuid = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The jobUuid.

getJobUuidBytes()

public abstract ByteString getJobUuidBytes()

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.

string job_uuid = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for jobUuid.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may 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.

map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may 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.

map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may 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.

map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may 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.

map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getPigJob()

public abstract PigJob getPigJob()

Optional. Job is a Pig job.

.google.cloud.dataproc.v1.PigJob pig_job = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PigJob	The pigJob.

getPigJobOrBuilder()

public abstract PigJobOrBuilder getPigJobOrBuilder()

Optional. Job is a Pig job.

.google.cloud.dataproc.v1.PigJob pig_job = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PigJobOrBuilder

getPlacement()

public abstract JobPlacement getPlacement()

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

.google.cloud.dataproc.v1.JobPlacement placement = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
JobPlacement	The placement.

getPlacementOrBuilder()

public abstract JobPlacementOrBuilder getPlacementOrBuilder()

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

.google.cloud.dataproc.v1.JobPlacement placement = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
JobPlacementOrBuilder

getPrestoJob()

public abstract PrestoJob getPrestoJob()

Optional. Job is a Presto job.

.google.cloud.dataproc.v1.PrestoJob presto_job = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrestoJob	The prestoJob.

getPrestoJobOrBuilder()

public abstract PrestoJobOrBuilder getPrestoJobOrBuilder()

Optional. Job is a Presto job.

.google.cloud.dataproc.v1.PrestoJob presto_job = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrestoJobOrBuilder

getPysparkJob()

public abstract PySparkJob getPysparkJob()

Optional. Job is a PySpark job.

.google.cloud.dataproc.v1.PySparkJob pyspark_job = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PySparkJob	The pysparkJob.

getPysparkJobOrBuilder()

public abstract PySparkJobOrBuilder getPysparkJobOrBuilder()

Optional. Job is a PySpark job.

.google.cloud.dataproc.v1.PySparkJob pyspark_job = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PySparkJobOrBuilder

getReference()

public abstract JobReference getReference()

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 <code>job_id</code>.

.google.cloud.dataproc.v1.JobReference reference = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
JobReference	The reference.

getReferenceOrBuilder()

public abstract JobReferenceOrBuilder getReferenceOrBuilder()

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 <code>job_id</code>.

.google.cloud.dataproc.v1.JobReference reference = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
JobReferenceOrBuilder

getScheduling()

public abstract JobScheduling getScheduling()

Optional. Job scheduling configuration.

.google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
JobScheduling	The scheduling.

getSchedulingOrBuilder()

public abstract JobSchedulingOrBuilder getSchedulingOrBuilder()

Optional. Job scheduling configuration.

.google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
JobSchedulingOrBuilder

getSparkJob()

public abstract SparkJob getSparkJob()

Optional. Job is a Spark job.

.google.cloud.dataproc.v1.SparkJob spark_job = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SparkJob	The sparkJob.

getSparkJobOrBuilder()

public abstract SparkJobOrBuilder getSparkJobOrBuilder()

Optional. Job is a Spark job.

.google.cloud.dataproc.v1.SparkJob spark_job = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SparkJobOrBuilder

getSparkRJob()

public abstract SparkRJob getSparkRJob()

Optional. Job is a SparkR job.

.google.cloud.dataproc.v1.SparkRJob spark_r_job = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SparkRJob	The sparkRJob.

getSparkRJobOrBuilder()

public abstract SparkRJobOrBuilder getSparkRJobOrBuilder()

Optional. Job is a SparkR job.

.google.cloud.dataproc.v1.SparkRJob spark_r_job = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SparkRJobOrBuilder

getSparkSqlJob()

public abstract SparkSqlJob getSparkSqlJob()

Optional. Job is a SparkSql job.

.google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SparkSqlJob	The sparkSqlJob.

getSparkSqlJobOrBuilder()

public abstract SparkSqlJobOrBuilder getSparkSqlJobOrBuilder()

Optional. Job is a SparkSql job.

.google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SparkSqlJobOrBuilder

getStatus()

public abstract JobStatus getStatus()

Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.

.google.cloud.dataproc.v1.JobStatus status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
JobStatus	The status.

getStatusHistory(int index)

public abstract JobStatus getStatusHistory(int index)

Output only. The previous job status.

repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
JobStatus

getStatusHistoryCount()

public abstract int getStatusHistoryCount()

Output only. The previous job status.

repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getStatusHistoryList()

public abstract List<JobStatus> getStatusHistoryList()

Output only. The previous job status.

repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<JobStatus>

getStatusHistoryOrBuilder(int index)

public abstract JobStatusOrBuilder getStatusHistoryOrBuilder(int index)

Output only. The previous job status.

repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
JobStatusOrBuilder

getStatusHistoryOrBuilderList()

public abstract List<? extends JobStatusOrBuilder> getStatusHistoryOrBuilderList()

Output only. The previous job status.

repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.dataproc.v1.JobStatusOrBuilder>

getStatusOrBuilder()

public abstract JobStatusOrBuilder getStatusOrBuilder()

Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.

.google.cloud.dataproc.v1.JobStatus status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
JobStatusOrBuilder

getTrinoJob()

public abstract TrinoJob getTrinoJob()

Optional. Job is a Trino job.

.google.cloud.dataproc.v1.TrinoJob trino_job = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TrinoJob	The trinoJob.

getTrinoJobOrBuilder()

public abstract TrinoJobOrBuilder getTrinoJobOrBuilder()

Optional. Job is a Trino job.

.google.cloud.dataproc.v1.TrinoJob trino_job = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TrinoJobOrBuilder

getTypeJobCase()

public abstract Job.TypeJobCase getTypeJobCase()

Returns
Type	Description
Job.TypeJobCase

getYarnApplications(int index)

public abstract YarnApplication getYarnApplications(int index)

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.

repeated .google.cloud.dataproc.v1.YarnApplication yarn_applications = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
YarnApplication

getYarnApplicationsCount()

public abstract int getYarnApplicationsCount()

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.

repeated .google.cloud.dataproc.v1.YarnApplication yarn_applications = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getYarnApplicationsList()

public abstract List<YarnApplication> getYarnApplicationsList()

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.

repeated .google.cloud.dataproc.v1.YarnApplication yarn_applications = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<YarnApplication>

getYarnApplicationsOrBuilder(int index)

public abstract YarnApplicationOrBuilder getYarnApplicationsOrBuilder(int index)

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.

repeated .google.cloud.dataproc.v1.YarnApplication yarn_applications = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
YarnApplicationOrBuilder

getYarnApplicationsOrBuilderList()

public abstract List<? extends YarnApplicationOrBuilder> getYarnApplicationsOrBuilderList()

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.

repeated .google.cloud.dataproc.v1.YarnApplication yarn_applications = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.dataproc.v1.YarnApplicationOrBuilder>

hasDriverSchedulingConfig()

public abstract boolean hasDriverSchedulingConfig()

Optional. Driver scheduling configuration.

.google.cloud.dataproc.v1.DriverSchedulingConfig driver_scheduling_config = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the driverSchedulingConfig field is set.

hasHadoopJob()

public abstract boolean hasHadoopJob()

Optional. Job is a Hadoop job.

.google.cloud.dataproc.v1.HadoopJob hadoop_job = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the hadoopJob field is set.

hasHiveJob()

public abstract boolean hasHiveJob()

Optional. Job is a Hive job.

.google.cloud.dataproc.v1.HiveJob hive_job = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the hiveJob field is set.

hasPigJob()

public abstract boolean hasPigJob()

Optional. Job is a Pig job.

.google.cloud.dataproc.v1.PigJob pig_job = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the pigJob field is set.

hasPlacement()

public abstract boolean hasPlacement()

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

.google.cloud.dataproc.v1.JobPlacement placement = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the placement field is set.

hasPrestoJob()

public abstract boolean hasPrestoJob()

Optional. Job is a Presto job.

.google.cloud.dataproc.v1.PrestoJob presto_job = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the prestoJob field is set.

hasPysparkJob()

public abstract boolean hasPysparkJob()

Optional. Job is a PySpark job.

.google.cloud.dataproc.v1.PySparkJob pyspark_job = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the pysparkJob field is set.

hasReference()

public abstract boolean hasReference()

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 <code>job_id</code>.

.google.cloud.dataproc.v1.JobReference reference = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the reference field is set.

hasScheduling()

public abstract boolean hasScheduling()

Optional. Job scheduling configuration.

.google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the scheduling field is set.

hasSparkJob()

public abstract boolean hasSparkJob()

Optional. Job is a Spark job.

.google.cloud.dataproc.v1.SparkJob spark_job = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the sparkJob field is set.

hasSparkRJob()

public abstract boolean hasSparkRJob()

Optional. Job is a SparkR job.

.google.cloud.dataproc.v1.SparkRJob spark_r_job = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the sparkRJob field is set.

hasSparkSqlJob()

public abstract boolean hasSparkSqlJob()

Optional. Job is a SparkSql job.

.google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the sparkSqlJob field is set.

hasStatus()

public abstract boolean hasStatus()

Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.

.google.cloud.dataproc.v1.JobStatus status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the status field is set.

hasTrinoJob()

public abstract boolean hasTrinoJob()

Optional. Job is a Trino job.

.google.cloud.dataproc.v1.TrinoJob trino_job = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the trinoJob field is set.