Class OrderedJob (2.3.1)

public final class OrderedJob extends GeneratedMessageV3 implements OrderedJobOrBuilder

A job executed by the workflow.

Protobuf type google.cloud.dataproc.v1.OrderedJob

Implements

OrderedJobOrBuilder

Fields

HADOOP_JOB_FIELD_NUMBER

public static final int HADOOP_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

HIVE_JOB_FIELD_NUMBER

public static final int HIVE_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

PIG_JOB_FIELD_NUMBER

public static final int PIG_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

PREREQUISITE_STEP_IDS_FIELD_NUMBER

public static final int PREREQUISITE_STEP_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

PRESTO_JOB_FIELD_NUMBER

public static final int PRESTO_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

PYSPARK_JOB_FIELD_NUMBER

public static final int PYSPARK_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

SCHEDULING_FIELD_NUMBER

public static final int SCHEDULING_FIELD_NUMBER
Field Value
TypeDescription
int

SPARK_JOB_FIELD_NUMBER

public static final int SPARK_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

SPARK_R_JOB_FIELD_NUMBER

public static final int SPARK_R_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

SPARK_SQL_JOB_FIELD_NUMBER

public static final int SPARK_SQL_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

STEP_ID_FIELD_NUMBER

public static final int STEP_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

containsLabels(String key)

public boolean containsLabels(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static OrderedJob getDefaultInstance()
Returns
TypeDescription
OrderedJob

getDefaultInstanceForType()

public OrderedJob getDefaultInstanceForType()
Returns
TypeDescription
OrderedJob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getHadoopJob()

public HadoopJob getHadoopJob()

Optional. Job is a Hadoop job.

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

Returns
TypeDescription
HadoopJob

The hadoopJob.

getHadoopJobOrBuilder()

public HadoopJobOrBuilder getHadoopJobOrBuilder()

Optional. Job is a Hadoop job.

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

Returns
TypeDescription
HadoopJobOrBuilder

getHiveJob()

public HiveJob getHiveJob()

Optional. Job is a Hive job.

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

Returns
TypeDescription
HiveJob

The hiveJob.

getHiveJobOrBuilder()

public HiveJobOrBuilder getHiveJobOrBuilder()

Optional. Job is a Hive job.

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

Returns
TypeDescription
HiveJobOrBuilder

getJobTypeCase()

public OrderedJob.JobTypeCase getJobTypeCase()
Returns
TypeDescription
OrderedJob.JobTypeCase

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public 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}{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];

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> 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}{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];

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, 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}{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];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

public Parser<OrderedJob> getParserForType()
Returns
TypeDescription
Parser<OrderedJob>
Overrides

getPigJob()

public PigJob getPigJob()

Optional. Job is a Pig job.

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

Returns
TypeDescription
PigJob

The pigJob.

getPigJobOrBuilder()

public PigJobOrBuilder getPigJobOrBuilder()

Optional. Job is a Pig job.

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

Returns
TypeDescription
PigJobOrBuilder

getPrerequisiteStepIds(int index)

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The prerequisiteStepIds at the given index.

getPrerequisiteStepIdsBytes(int index)

public ByteString getPrerequisiteStepIdsBytes(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];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the prerequisiteStepIds at the given index.

getPrerequisiteStepIdsCount()

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

Returns
TypeDescription
int

The count of prerequisiteStepIds.

getPrerequisiteStepIdsList()

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

Returns
TypeDescription
ProtocolStringList

A list containing the prerequisiteStepIds.

getPrestoJob()

public PrestoJob getPrestoJob()

Optional. Job is a Presto job.

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

Returns
TypeDescription
PrestoJob

The prestoJob.

getPrestoJobOrBuilder()

public PrestoJobOrBuilder getPrestoJobOrBuilder()

Optional. Job is a Presto job.

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

Returns
TypeDescription
PrestoJobOrBuilder

getPysparkJob()

public PySparkJob getPysparkJob()

Optional. Job is a PySpark job.

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

Returns
TypeDescription
PySparkJob

The pysparkJob.

getPysparkJobOrBuilder()

public PySparkJobOrBuilder getPysparkJobOrBuilder()

Optional. Job is a PySpark job.

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

Returns
TypeDescription
PySparkJobOrBuilder

getScheduling()

public JobScheduling getScheduling()

Optional. Job scheduling configuration.

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

Returns
TypeDescription
JobScheduling

The scheduling.

getSchedulingOrBuilder()

public JobSchedulingOrBuilder getSchedulingOrBuilder()

Optional. Job scheduling configuration.

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

Returns
TypeDescription
JobSchedulingOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSparkJob()

public SparkJob getSparkJob()

Optional. Job is a Spark job.

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

Returns
TypeDescription
SparkJob

The sparkJob.

getSparkJobOrBuilder()

public SparkJobOrBuilder getSparkJobOrBuilder()

Optional. Job is a Spark job.

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

Returns
TypeDescription
SparkJobOrBuilder

getSparkRJob()

public SparkRJob getSparkRJob()

Optional. Job is a SparkR job.

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

Returns
TypeDescription
SparkRJob

The sparkRJob.

getSparkRJobOrBuilder()

public SparkRJobOrBuilder getSparkRJobOrBuilder()

Optional. Job is a SparkR job.

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

Returns
TypeDescription
SparkRJobOrBuilder

getSparkSqlJob()

public SparkSqlJob getSparkSqlJob()

Optional. Job is a SparkSql job.

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

Returns
TypeDescription
SparkSqlJob

The sparkSqlJob.

getSparkSqlJobOrBuilder()

public SparkSqlJobOrBuilder getSparkSqlJobOrBuilder()

Optional. Job is a SparkSql job.

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

Returns
TypeDescription
SparkSqlJobOrBuilder

getStepId()

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

Returns
TypeDescription
String

The stepId.

getStepIdBytes()

public ByteString getStepIdBytes()

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

Returns
TypeDescription
ByteString

The bytes for stepId.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasHadoopJob()

public boolean hasHadoopJob()

Optional. Job is a Hadoop job.

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

Returns
TypeDescription
boolean

Whether the hadoopJob field is set.

hasHiveJob()

public boolean hasHiveJob()

Optional. Job is a Hive job.

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

Returns
TypeDescription
boolean

Whether the hiveJob field is set.

hasPigJob()

public boolean hasPigJob()

Optional. Job is a Pig job.

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

Returns
TypeDescription
boolean

Whether the pigJob field is set.

hasPrestoJob()

public boolean hasPrestoJob()

Optional. Job is a Presto job.

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

Returns
TypeDescription
boolean

Whether the prestoJob field is set.

hasPysparkJob()

public boolean hasPysparkJob()

Optional. Job is a PySpark job.

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

Returns
TypeDescription
boolean

Whether the pysparkJob field is set.

hasScheduling()

public boolean hasScheduling()

Optional. Job scheduling configuration.

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

Returns
TypeDescription
boolean

Whether the scheduling field is set.

hasSparkJob()

public boolean hasSparkJob()

Optional. Job is a Spark job.

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

Returns
TypeDescription
boolean

Whether the sparkJob field is set.

hasSparkRJob()

public boolean hasSparkRJob()

Optional. Job is a SparkR job.

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

Returns
TypeDescription
boolean

Whether the sparkRJob field is set.

hasSparkSqlJob()

public boolean hasSparkSqlJob()

Optional. Job is a SparkSql job.

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

Returns
TypeDescription
boolean

Whether the sparkSqlJob field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static OrderedJob.Builder newBuilder()
Returns
TypeDescription
OrderedJob.Builder

newBuilder(OrderedJob prototype)

public static OrderedJob.Builder newBuilder(OrderedJob prototype)
Parameter
NameDescription
prototypeOrderedJob
Returns
TypeDescription
OrderedJob.Builder

newBuilderForType()

public OrderedJob.Builder newBuilderForType()
Returns
TypeDescription
OrderedJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OrderedJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
OrderedJob.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static OrderedJob parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static OrderedJob parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OrderedJob parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OrderedJob parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static OrderedJob parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static OrderedJob parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderedJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<OrderedJob> parser()
Returns
TypeDescription
Parser<OrderedJob>

toBuilder()

public OrderedJob.Builder toBuilder()
Returns
TypeDescription
OrderedJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException