/*
* 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/workflow_templates.proto
package com.google.cloud.dataproc.v1;
public interface OrderedJobOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.OrderedJob)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. The step id. The id must be unique among all jobs
* within the template.
* The step id is used as prefix for job id, as job
* `goog-dataproc-workflow-step-id` label, and in
* [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids]
* field from other steps.
* The id must contain only letters (a-z, A-Z), numbers (0-9),
* underscores (_), and hyphens (-). Cannot begin or end with underscore
* or hyphen. Must consist of between 3 and 50 characters.
*
*
* string step_id = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The stepId.
*/
java.lang.String getStepId();
/**
*
*
*
* Required. The step id. The id must be unique among all jobs
* within the template.
* The step id is used as prefix for job id, as job
* `goog-dataproc-workflow-step-id` label, and in
* [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids]
* field from other steps.
* The id must contain only letters (a-z, A-Z), numbers (0-9),
* underscores (_), and hyphens (-). Cannot begin or end with underscore
* or hyphen. Must consist of between 3 and 50 characters.
*
*
* string step_id = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for stepId.
*/
com.google.protobuf.ByteString getStepIdBytes();
/**
*
*
*
* Optional. Job is a Hadoop job.
*
*
*
* .google.cloud.dataproc.v1.HadoopJob hadoop_job = 2 [(.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 = 2 [(.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 = 2 [(.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 = 3 [(.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 = 3 [(.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 = 3 [(.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 = 4 [(.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 = 4 [(.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 = 4 [(.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 = 5 [(.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 = 5 [(.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 = 5 [(.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 = 6 [(.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 = 6 [(.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 = 6 [(.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 = 11 [(.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 = 11 [(.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 = 11 [(.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 = 7 [(.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 = 7 [(.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 = 7 [(.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 = 12 [(.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 = 12 [(.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 = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.PrestoJobOrBuilder getPrestoJobOrBuilder();
/**
*
*
*
* Optional. The labels to associate with this job.
* Label keys must be between 1 and 63 characters long, and must conform to
* the following regular expression:
* [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
* Label values must be between 1 and 63 characters long, and must conform to
* the following regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
* No more than 32 labels can be associated with a given job.
*
*
* map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. The labels to associate with this job.
* Label keys must be between 1 and 63 characters long, and must conform to
* the following regular expression:
* [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
* Label values must be between 1 and 63 characters long, and must conform to
* the following regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
* No more than 32 labels can be associated with a given job.
*
*
* map<string, string> labels = 8 [(.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 be between 1 and 63 characters long, and must conform to
* the following regular expression:
* [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
* Label values must be between 1 and 63 characters long, and must conform to
* the following regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
* No more than 32 labels can be associated with a given job.
*
*
* map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. The labels to associate with this job.
* Label keys must be between 1 and 63 characters long, and must conform to
* the following regular expression:
* [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
* Label values must be between 1 and 63 characters long, and must conform to
* the following regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
* No more than 32 labels can be associated with a given job.
*
*
* map<string, string> labels = 8 [(.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 be between 1 and 63 characters long, and must conform to
* the following regular expression:
* [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
* Label values must be between 1 and 63 characters long, and must conform to
* the following regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
* No more than 32 labels can be associated with a given job.
*
*
* map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Optional. Job scheduling configuration.
*
*
*
* .google.cloud.dataproc.v1.JobScheduling scheduling = 9 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the scheduling field is set.
*/
boolean hasScheduling();
/**
*
*
*
* Optional. Job scheduling configuration.
*
*
*
* .google.cloud.dataproc.v1.JobScheduling scheduling = 9 [(.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 = 9 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.JobSchedulingOrBuilder getSchedulingOrBuilder();
/**
*
*
*
* Optional. The optional list of prerequisite job step_ids.
* If not specified, the job will start at the beginning of workflow.
*
*
* repeated string prerequisite_step_ids = 10 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return A list containing the prerequisiteStepIds.
*/
java.util.List getPrerequisiteStepIdsList();
/**
*
*
*
* Optional. The optional list of prerequisite job step_ids.
* If not specified, the job will start at the beginning of workflow.
*
*
* repeated string prerequisite_step_ids = 10 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The count of prerequisiteStepIds.
*/
int getPrerequisiteStepIdsCount();
/**
*
*
*
* Optional. The optional list of prerequisite job step_ids.
* If not specified, the job will start at the beginning of workflow.
*
*
* repeated string prerequisite_step_ids = 10 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @param index The index of the element to return.
* @return The prerequisiteStepIds at the given index.
*/
java.lang.String getPrerequisiteStepIds(int index);
/**
*
*
*
* Optional. The optional list of prerequisite job step_ids.
* If not specified, the job will start at the beginning of workflow.
*
*
* repeated string prerequisite_step_ids = 10 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @param index The index of the value to return.
* @return The bytes of the prerequisiteStepIds at the given index.
*/
com.google.protobuf.ByteString getPrerequisiteStepIdsBytes(int index);
public com.google.cloud.dataproc.v1.OrderedJob.JobTypeCase getJobTypeCase();
}