Package com.google.cloud.dataproc.v1

Interface JobOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Job, Job.Builder
    public interface JobOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasReference

        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:
        Whether the reference field is set.

      • getReference

        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:
        The reference.

      • getReferenceOrBuilder

        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];

      • hasPlacement

        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:
        Whether the placement field is set.

      • getPlacement

        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:
        The placement.

      • getPlacementOrBuilder

        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];

      • hasHadoopJob

        boolean hasHadoopJob()
         Optional. Job is a Hadoop job.
        .google.cloud.dataproc.v1.HadoopJob hadoop_job = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the hadoopJob field is set.

      • getHadoopJob

        HadoopJob getHadoopJob()
         Optional. Job is a Hadoop job.
        .google.cloud.dataproc.v1.HadoopJob hadoop_job = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The hadoopJob.

      • getHadoopJobOrBuilder

        HadoopJobOrBuilder getHadoopJobOrBuilder()
         Optional. Job is a Hadoop job.
        .google.cloud.dataproc.v1.HadoopJob hadoop_job = 3 [(.google.api.field_behavior) = OPTIONAL];

      • hasSparkJob

        boolean hasSparkJob()
         Optional. Job is a Spark job.
        .google.cloud.dataproc.v1.SparkJob spark_job = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the sparkJob field is set.

      • getSparkJob

        SparkJob getSparkJob()
         Optional. Job is a Spark job.
        .google.cloud.dataproc.v1.SparkJob spark_job = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The sparkJob.

      • getSparkJobOrBuilder

        SparkJobOrBuilder getSparkJobOrBuilder()
         Optional. Job is a Spark job.
        .google.cloud.dataproc.v1.SparkJob spark_job = 4 [(.google.api.field_behavior) = OPTIONAL];

      • hasPysparkJob

        boolean hasPysparkJob()
         Optional. Job is a PySpark job.
        .google.cloud.dataproc.v1.PySparkJob pyspark_job = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the pysparkJob field is set.

      • getPysparkJob

        PySparkJob getPysparkJob()
         Optional. Job is a PySpark job.
        .google.cloud.dataproc.v1.PySparkJob pyspark_job = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pysparkJob.

      • getPysparkJobOrBuilder

        PySparkJobOrBuilder getPysparkJobOrBuilder()
         Optional. Job is a PySpark job.
        .google.cloud.dataproc.v1.PySparkJob pyspark_job = 5 [(.google.api.field_behavior) = OPTIONAL];

      • hasHiveJob

        boolean hasHiveJob()
         Optional. Job is a Hive job.
        .google.cloud.dataproc.v1.HiveJob hive_job = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the hiveJob field is set.

      • getHiveJob

        HiveJob getHiveJob()
         Optional. Job is a Hive job.
        .google.cloud.dataproc.v1.HiveJob hive_job = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The hiveJob.

      • getHiveJobOrBuilder

        HiveJobOrBuilder getHiveJobOrBuilder()
         Optional. Job is a Hive job.
        .google.cloud.dataproc.v1.HiveJob hive_job = 6 [(.google.api.field_behavior) = OPTIONAL];

      • hasPigJob

        boolean hasPigJob()
         Optional. Job is a Pig job.
        .google.cloud.dataproc.v1.PigJob pig_job = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the pigJob field is set.

      • getPigJob

        PigJob getPigJob()
         Optional. Job is a Pig job.
        .google.cloud.dataproc.v1.PigJob pig_job = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pigJob.

      • getPigJobOrBuilder

        PigJobOrBuilder getPigJobOrBuilder()
         Optional. Job is a Pig job.
        .google.cloud.dataproc.v1.PigJob pig_job = 7 [(.google.api.field_behavior) = OPTIONAL];

      • hasSparkRJob

        boolean hasSparkRJob()
         Optional. Job is a SparkR job.
        .google.cloud.dataproc.v1.SparkRJob spark_r_job = 21 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the sparkRJob field is set.

      • getSparkRJob

        SparkRJob getSparkRJob()
         Optional. Job is a SparkR job.
        .google.cloud.dataproc.v1.SparkRJob spark_r_job = 21 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The sparkRJob.

      • getSparkRJobOrBuilder

        SparkRJobOrBuilder getSparkRJobOrBuilder()
         Optional. Job is a SparkR job.
        .google.cloud.dataproc.v1.SparkRJob spark_r_job = 21 [(.google.api.field_behavior) = OPTIONAL];

      • hasSparkSqlJob

        boolean hasSparkSqlJob()
         Optional. Job is a SparkSql job.
        .google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the sparkSqlJob field is set.

      • getSparkSqlJob

        SparkSqlJob getSparkSqlJob()
         Optional. Job is a SparkSql job.
        .google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The sparkSqlJob.

      • getSparkSqlJobOrBuilder

        SparkSqlJobOrBuilder getSparkSqlJobOrBuilder()
         Optional. Job is a SparkSql job.
        .google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 12 [(.google.api.field_behavior) = OPTIONAL];

      • hasPrestoJob

        boolean hasPrestoJob()
         Optional. Job is a Presto job.
        .google.cloud.dataproc.v1.PrestoJob presto_job = 23 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the prestoJob field is set.

      • getPrestoJob

        PrestoJob getPrestoJob()
         Optional. Job is a Presto job.
        .google.cloud.dataproc.v1.PrestoJob presto_job = 23 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The prestoJob.

      • getPrestoJobOrBuilder

        PrestoJobOrBuilder getPrestoJobOrBuilder()
         Optional. Job is a Presto job.
        .google.cloud.dataproc.v1.PrestoJob presto_job = 23 [(.google.api.field_behavior) = OPTIONAL];

      • hasTrinoJob

        boolean hasTrinoJob()
         Optional. Job is a Trino job.
        .google.cloud.dataproc.v1.TrinoJob trino_job = 28 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the trinoJob field is set.

      • getTrinoJob

        TrinoJob getTrinoJob()
         Optional. Job is a Trino job.
        .google.cloud.dataproc.v1.TrinoJob trino_job = 28 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The trinoJob.

      • getTrinoJobOrBuilder

        TrinoJobOrBuilder getTrinoJobOrBuilder()
         Optional. Job is a Trino job.
        .google.cloud.dataproc.v1.TrinoJob trino_job = 28 [(.google.api.field_behavior) = OPTIONAL];

      • hasStatus

        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:
        Whether the status field is set.

      • getStatus

        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:
        The status.

      • getStatusOrBuilder

        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];

      • getStatusHistoryList

        List<JobStatus> getStatusHistoryList()
         Output only. The previous job status.
        repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getStatusHistory

        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];

      • getStatusHistoryCount

        int getStatusHistoryCount()
         Output only. The previous job status.
        repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getStatusHistoryOrBuilderList

        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];

      • getStatusHistoryOrBuilder

        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];

      • getYarnApplicationsList

        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];

      • getYarnApplications

        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];

      • getYarnApplicationsCount

        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];

      • getYarnApplicationsOrBuilderList

        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];

      • getYarnApplicationsOrBuilder

        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];

      • getDriverOutputResourceUri

        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:
        The driverOutputResourceUri.

      • getDriverOutputResourceUriBytes

        com.google.protobuf.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:
        The bytes for driverOutputResourceUri.

      • getDriverControlFilesUri

        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:
        The driverControlFilesUri.

      • getDriverControlFilesUriBytes

        com.google.protobuf.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:
        The bytes for driverControlFilesUri.

      • getLabelsCount

        int getLabelsCount()
         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.
        map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

      • containsLabels

        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](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.
        map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsMap

        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](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.
        map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrDefault

        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](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.
        map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrThrow

        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](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.
        map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

      • hasScheduling

        boolean hasScheduling()
         Optional. Job scheduling configuration.
        .google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the scheduling field is set.

      • getScheduling

        JobScheduling getScheduling()
         Optional. Job scheduling configuration.
        .google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The scheduling.

      • getSchedulingOrBuilder

        JobSchedulingOrBuilder getSchedulingOrBuilder()
         Optional. Job scheduling configuration.
        .google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];

      • getJobUuid

        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:
        The jobUuid.

      • getJobUuidBytes

        com.google.protobuf.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:
        The bytes for jobUuid.

      • getDone

        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:
        The done.

      • hasDriverSchedulingConfig

        boolean hasDriverSchedulingConfig()
         Optional. Driver scheduling configuration.
        .google.cloud.dataproc.v1.DriverSchedulingConfig driver_scheduling_config = 27 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the driverSchedulingConfig field is set.

      • getDriverSchedulingConfig

        DriverSchedulingConfig getDriverSchedulingConfig()
         Optional. Driver scheduling configuration.
        .google.cloud.dataproc.v1.DriverSchedulingConfig driver_scheduling_config = 27 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The driverSchedulingConfig.

      • getDriverSchedulingConfigOrBuilder

        DriverSchedulingConfigOrBuilder getDriverSchedulingConfigOrBuilder()
         Optional. Driver scheduling configuration.
        .google.cloud.dataproc.v1.DriverSchedulingConfig driver_scheduling_config = 27 [(.google.api.field_behavior) = OPTIONAL];