Class OrderedJob (4.41.0) 

public final class OrderedJob extends GeneratedMessageV3 implements OrderedJobOrBuilder

A job executed by the workflow.

Protobuf type google.cloud.dataproc.v1.OrderedJob

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > OrderedJob

Implements

OrderedJobOrBuilder

Static Fields

HADOOP_JOB_FIELD_NUMBER

public static final int HADOOP_JOB_FIELD_NUMBER
Field Value
Type Description
int

HIVE_JOB_FIELD_NUMBER

public static final int HIVE_JOB_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

PIG_JOB_FIELD_NUMBER

public static final int PIG_JOB_FIELD_NUMBER
Field Value
Type Description
int

PREREQUISITE_STEP_IDS_FIELD_NUMBER

public static final int PREREQUISITE_STEP_IDS_FIELD_NUMBER
Field Value
Type Description
int

PRESTO_JOB_FIELD_NUMBER

public static final int PRESTO_JOB_FIELD_NUMBER
Field Value
Type Description
int

PYSPARK_JOB_FIELD_NUMBER

public static final int PYSPARK_JOB_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULING_FIELD_NUMBER

public static final int SCHEDULING_FIELD_NUMBER
Field Value
Type Description
int

SPARK_JOB_FIELD_NUMBER

public static final int SPARK_JOB_FIELD_NUMBER
Field Value
Type Description
int

SPARK_R_JOB_FIELD_NUMBER

public static final int SPARK_R_JOB_FIELD_NUMBER
Field Value
Type Description
int

SPARK_SQL_JOB_FIELD_NUMBER

public static final int SPARK_SQL_JOB_FIELD_NUMBER
Field Value
Type Description
int

STEP_ID_FIELD_NUMBER

public static final int STEP_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OrderedJob getDefaultInstance()
Returns
Type Description
OrderedJob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static OrderedJob.Builder newBuilder()
Returns
Type Description
OrderedJob.Builder

newBuilder(OrderedJob prototype)

public static OrderedJob.Builder newBuilder(OrderedJob prototype)
Parameter
Name Description
prototype OrderedJob
Returns
Type Description
OrderedJob.Builder

parseDelimitedFrom(InputStream input)

public static OrderedJob parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OrderedJob
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderedJob
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static OrderedJob parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
OrderedJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderedJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OrderedJob parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
OrderedJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderedJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OrderedJob parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
OrderedJob
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderedJob
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static OrderedJob parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OrderedJob
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderedJob
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static OrderedJob parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
OrderedJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OrderedJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderedJob
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<OrderedJob> parser()
Returns
Type Description
Parser<OrderedJob>

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
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public OrderedJob getDefaultInstanceForType()
Returns
Type Description
OrderedJob

getHadoopJob()

public HadoopJob getHadoopJob()

Optional. Job is a Hadoop job.

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

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
HiveJobOrBuilder

getJobTypeCase()

public OrderedJob.JobTypeCase getJobTypeCase()
Returns
Type Description
OrderedJob.JobTypeCase

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<OrderedJob> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int

The index of the element to return.
Returns
Type Description
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
Name Description
index int

The index of the value to return.
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
PySparkJobOrBuilder

getScheduling()

public JobScheduling getScheduling()

Optional. Job scheduling configuration.

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

Returns
Type Description
JobScheduling

The scheduling.

getSchedulingOrBuilder()

public JobSchedulingOrBuilder getSchedulingOrBuilder()

Optional. Job scheduling configuration.

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

Returns
Type Description
JobSchedulingOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for stepId.

hasHadoopJob()

public boolean hasHadoopJob()

Optional. Job is a Hadoop job.

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

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the sparkSqlJob field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public OrderedJob.Builder newBuilderForType()
Returns
Type Description
OrderedJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OrderedJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OrderedJob.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public OrderedJob.Builder toBuilder()
Returns
Type Description
OrderedJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException