/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dataproc/v1/jobs.proto
package com.google.cloud.dataproc.v1;
public interface JobOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.Job)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
*
* @return Whether the reference field is set.
*/
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];
*
*
* @return The reference.
*/
com.google.cloud.dataproc.v1.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];
*
*/
com.google.cloud.dataproc.v1.JobReferenceOrBuilder getReferenceOrBuilder();
/**
*
*
*
* Required. Job information, including how, when, and where to
* run the job.
*
*
*
* .google.cloud.dataproc.v1.JobPlacement placement = 2 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the placement field is set.
*/
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];
*
*
* @return The placement.
*/
com.google.cloud.dataproc.v1.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];
*
*/
com.google.cloud.dataproc.v1.JobPlacementOrBuilder getPlacementOrBuilder();
/**
*
*
*
* Optional. Job is a Hadoop job.
*
*
*
* .google.cloud.dataproc.v1.HadoopJob hadoop_job = 3 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the hadoopJob field is set.
*/
boolean hasHadoopJob();
/**
*
*
*
* Optional. Job is a Hadoop job.
*
*
*
* .google.cloud.dataproc.v1.HadoopJob hadoop_job = 3 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The hadoopJob.
*/
com.google.cloud.dataproc.v1.HadoopJob getHadoopJob();
/**
*
*
*
* Optional. Job is a Hadoop job.
*
*
*
* .google.cloud.dataproc.v1.HadoopJob hadoop_job = 3 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.HadoopJobOrBuilder getHadoopJobOrBuilder();
/**
*
*
*
* Optional. Job is a Spark job.
*
*
*
* .google.cloud.dataproc.v1.SparkJob spark_job = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the sparkJob field is set.
*/
boolean hasSparkJob();
/**
*
*
*
* Optional. Job is a Spark job.
*
*
*
* .google.cloud.dataproc.v1.SparkJob spark_job = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The sparkJob.
*/
com.google.cloud.dataproc.v1.SparkJob getSparkJob();
/**
*
*
*
* Optional. Job is a Spark job.
*
*
*
* .google.cloud.dataproc.v1.SparkJob spark_job = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.SparkJobOrBuilder getSparkJobOrBuilder();
/**
*
*
*
* Optional. Job is a PySpark job.
*
*
*
* .google.cloud.dataproc.v1.PySparkJob pyspark_job = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the pysparkJob field is set.
*/
boolean hasPysparkJob();
/**
*
*
*
* Optional. Job is a PySpark job.
*
*
*
* .google.cloud.dataproc.v1.PySparkJob pyspark_job = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The pysparkJob.
*/
com.google.cloud.dataproc.v1.PySparkJob getPysparkJob();
/**
*
*
*
* Optional. Job is a PySpark job.
*
*
*
* .google.cloud.dataproc.v1.PySparkJob pyspark_job = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.PySparkJobOrBuilder getPysparkJobOrBuilder();
/**
*
*
*
* Optional. Job is a Hive job.
*
*
* .google.cloud.dataproc.v1.HiveJob hive_job = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the hiveJob field is set.
*/
boolean hasHiveJob();
/**
*
*
*
* Optional. Job is a Hive job.
*
*
* .google.cloud.dataproc.v1.HiveJob hive_job = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The hiveJob.
*/
com.google.cloud.dataproc.v1.HiveJob getHiveJob();
/**
*
*
*
* Optional. Job is a Hive job.
*
*
* .google.cloud.dataproc.v1.HiveJob hive_job = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.HiveJobOrBuilder getHiveJobOrBuilder();
/**
*
*
*
* Optional. Job is a Pig job.
*
*
* .google.cloud.dataproc.v1.PigJob pig_job = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the pigJob field is set.
*/
boolean hasPigJob();
/**
*
*
*
* Optional. Job is a Pig job.
*
*
* .google.cloud.dataproc.v1.PigJob pig_job = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The pigJob.
*/
com.google.cloud.dataproc.v1.PigJob getPigJob();
/**
*
*
*
* Optional. Job is a Pig job.
*
*
* .google.cloud.dataproc.v1.PigJob pig_job = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.PigJobOrBuilder getPigJobOrBuilder();
/**
*
*
*
* Optional. Job is a SparkR job.
*
*
*
* .google.cloud.dataproc.v1.SparkRJob spark_r_job = 21 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the sparkRJob field is set.
*/
boolean hasSparkRJob();
/**
*
*
*
* Optional. Job is a SparkR job.
*
*
*
* .google.cloud.dataproc.v1.SparkRJob spark_r_job = 21 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The sparkRJob.
*/
com.google.cloud.dataproc.v1.SparkRJob getSparkRJob();
/**
*
*
*
* Optional. Job is a SparkR job.
*
*
*
* .google.cloud.dataproc.v1.SparkRJob spark_r_job = 21 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.SparkRJobOrBuilder getSparkRJobOrBuilder();
/**
*
*
*
* Optional. Job is a SparkSql job.
*
*
*
* .google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the sparkSqlJob field is set.
*/
boolean hasSparkSqlJob();
/**
*
*
*
* Optional. Job is a SparkSql job.
*
*
*
* .google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The sparkSqlJob.
*/
com.google.cloud.dataproc.v1.SparkSqlJob getSparkSqlJob();
/**
*
*
*
* Optional. Job is a SparkSql job.
*
*
*
* .google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.SparkSqlJobOrBuilder getSparkSqlJobOrBuilder();
/**
*
*
*
* Optional. Job is a Presto job.
*
*
*
* .google.cloud.dataproc.v1.PrestoJob presto_job = 23 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the prestoJob field is set.
*/
boolean hasPrestoJob();
/**
*
*
*
* Optional. Job is a Presto job.
*
*
*
* .google.cloud.dataproc.v1.PrestoJob presto_job = 23 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The prestoJob.
*/
com.google.cloud.dataproc.v1.PrestoJob getPrestoJob();
/**
*
*
*
* Optional. Job is a Presto job.
*
*
*
* .google.cloud.dataproc.v1.PrestoJob presto_job = 23 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.PrestoJobOrBuilder getPrestoJobOrBuilder();
/**
*
*
*
* Optional. Job is a Trino job.
*
*
*
* .google.cloud.dataproc.v1.TrinoJob trino_job = 28 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the trinoJob field is set.
*/
boolean hasTrinoJob();
/**
*
*
*
* Optional. Job is a Trino job.
*
*
*
* .google.cloud.dataproc.v1.TrinoJob trino_job = 28 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The trinoJob.
*/
com.google.cloud.dataproc.v1.TrinoJob getTrinoJob();
/**
*
*
*
* Optional. Job is a Trino job.
*
*
*
* .google.cloud.dataproc.v1.TrinoJob trino_job = 28 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.TrinoJobOrBuilder getTrinoJobOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the status field is set.
*/
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];
*
*
* @return The status.
*/
com.google.cloud.dataproc.v1.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];
*
*/
com.google.cloud.dataproc.v1.JobStatusOrBuilder getStatusOrBuilder();
/**
*
*
*
* Output only. The previous job status.
*
*
*
* repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List getStatusHistoryList();
/**
*
*
*
* Output only. The previous job status.
*
*
*
* repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataproc.v1.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];
*
*/
int getStatusHistoryCount();
/**
*
*
*
* Output only. The previous job status.
*
*
*
* repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List
getStatusHistoryOrBuilderList();
/**
*
*
*
* Output only. The previous job status.
*
*
*
* repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataproc.v1.JobStatusOrBuilder getStatusHistoryOrBuilder(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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.dataproc.v1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.dataproc.v1.YarnApplicationOrBuilder getYarnApplicationsOrBuilder(int index);
/**
*
*
*
* 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];
*
*
* @return The driverOutputResourceUri.
*/
java.lang.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];
*
*
* @return The bytes for driverOutputResourceUri.
*/
com.google.protobuf.ByteString getDriverOutputResourceUriBytes();
/**
*
*
*
* 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];
*
* @return The driverControlFilesUri.
*/
java.lang.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];
*
* @return The bytes for driverControlFilesUri.
*/
com.google.protobuf.ByteString getDriverControlFilesUriBytes();
/**
*
*
*
* 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];
*/
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];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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];
*/
java.util.Map 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];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Optional. Job scheduling configuration.
*
*
*
* .google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the scheduling field is set.
*/
boolean hasScheduling();
/**
*
*
*
* Optional. Job scheduling configuration.
*
*
*
* .google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The scheduling.
*/
com.google.cloud.dataproc.v1.JobScheduling getScheduling();
/**
*
*
*
* Optional. Job scheduling configuration.
*
*
*
* .google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.JobSchedulingOrBuilder getSchedulingOrBuilder();
/**
*
*
*
* 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];
*
* @return The jobUuid.
*/
java.lang.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];
*
* @return The bytes for jobUuid.
*/
com.google.protobuf.ByteString getJobUuidBytes();
/**
*
*
*
* 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];
*
* @return The done.
*/
boolean getDone();
/**
*
*
*
* Optional. Driver scheduling configuration.
*
*
*
* .google.cloud.dataproc.v1.DriverSchedulingConfig driver_scheduling_config = 27 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the driverSchedulingConfig field is set.
*/
boolean hasDriverSchedulingConfig();
/**
*
*
*
* Optional. Driver scheduling configuration.
*
*
*
* .google.cloud.dataproc.v1.DriverSchedulingConfig driver_scheduling_config = 27 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The driverSchedulingConfig.
*/
com.google.cloud.dataproc.v1.DriverSchedulingConfig getDriverSchedulingConfig();
/**
*
*
*
* Optional. Driver scheduling configuration.
*
*
*
* .google.cloud.dataproc.v1.DriverSchedulingConfig driver_scheduling_config = 27 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.DriverSchedulingConfigOrBuilder getDriverSchedulingConfigOrBuilder();
public com.google.cloud.dataproc.v1.Job.TypeJobCase getTypeJobCase();
}