Class Job (0.50.0) 

public final class Job extends GeneratedMessageV3 implements JobOrBuilder

Defines a job to be run by the Cloud Dataflow service.

Protobuf type google.dataflow.v1beta3.Job

Inheritance

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

Implements

JobOrBuilder

Static Fields

CLIENT_REQUEST_ID_FIELD_NUMBER

public static final int CLIENT_REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

CREATED_FROM_SNAPSHOT_ID_FIELD_NUMBER

public static final int CREATED_FROM_SNAPSHOT_ID_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CURRENT_STATE_FIELD_NUMBER

public static final int CURRENT_STATE_FIELD_NUMBER
Field Value
Type Description
int

CURRENT_STATE_TIME_FIELD_NUMBER

public static final int CURRENT_STATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_INFO_FIELD_NUMBER

public static final int EXECUTION_INFO_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

JOB_METADATA_FIELD_NUMBER

public static final int JOB_METADATA_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PIPELINE_DESCRIPTION_FIELD_NUMBER

public static final int PIPELINE_DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

REPLACED_BY_JOB_ID_FIELD_NUMBER

public static final int REPLACED_BY_JOB_ID_FIELD_NUMBER
Field Value
Type Description
int

REPLACE_JOB_ID_FIELD_NUMBER

public static final int REPLACE_JOB_ID_FIELD_NUMBER
Field Value
Type Description
int

REQUESTED_STATE_FIELD_NUMBER

public static final int REQUESTED_STATE_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int

STAGE_STATES_FIELD_NUMBER

public static final int STAGE_STATES_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STEPS_FIELD_NUMBER

public static final int STEPS_FIELD_NUMBER
Field Value
Type Description
int

STEPS_LOCATION_FIELD_NUMBER

public static final int STEPS_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

TEMP_FILES_FIELD_NUMBER

public static final int TEMP_FILES_FIELD_NUMBER
Field Value
Type Description
int

TRANSFORM_NAME_MAPPING_FIELD_NUMBER

public static final int TRANSFORM_NAME_MAPPING_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Job getDefaultInstance()
Returns
Type Description
Job

getDescriptor()

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

newBuilder()

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

newBuilder(Job prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

User-defined labels for this job.

The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

map<string, string> labels = 17;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsTransformNameMapping(String key)

public boolean containsTransformNameMapping(String key)

The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 13;

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

getClientRequestId()

public String getClientRequestId()

The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.

string client_request_id = 14;

Returns
Type Description
String

The clientRequestId.

getClientRequestIdBytes()

public ByteString getClientRequestIdBytes()

The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.

string client_request_id = 14;

Returns
Type Description
ByteString

The bytes for clientRequestId.

getCreateTime()

public Timestamp getCreateTime()

The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

.google.protobuf.Timestamp create_time = 11;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

.google.protobuf.Timestamp create_time = 11;

Returns
Type Description
TimestampOrBuilder

getCreatedFromSnapshotId()

public String getCreatedFromSnapshotId()

If this is specified, the job's initial state is populated from the given snapshot.

string created_from_snapshot_id = 23;

Returns
Type Description
String

The createdFromSnapshotId.

getCreatedFromSnapshotIdBytes()

public ByteString getCreatedFromSnapshotIdBytes()

If this is specified, the job's initial state is populated from the given snapshot.

string created_from_snapshot_id = 23;

Returns
Type Description
ByteString

The bytes for createdFromSnapshotId.

getCurrentState()

public JobState getCurrentState()

The current state of the job.

Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified.

A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made.

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

.google.dataflow.v1beta3.JobState current_state = 7;

Returns
Type Description
JobState

The currentState.

getCurrentStateTime()

public Timestamp getCurrentStateTime()

The timestamp associated with the current state.

.google.protobuf.Timestamp current_state_time = 8;

Returns
Type Description
Timestamp

The currentStateTime.

getCurrentStateTimeOrBuilder()

public TimestampOrBuilder getCurrentStateTimeOrBuilder()

The timestamp associated with the current state.

.google.protobuf.Timestamp current_state_time = 8;

Returns
Type Description
TimestampOrBuilder

getCurrentStateValue()

public int getCurrentStateValue()

The current state of the job.

Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified.

A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made.

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

.google.dataflow.v1beta3.JobState current_state = 7;

Returns
Type Description
int

The enum numeric value on the wire for currentState.

getDefaultInstanceForType()

public Job getDefaultInstanceForType()
Returns
Type Description
Job

getEnvironment()

public Environment getEnvironment()

The environment for the job.

.google.dataflow.v1beta3.Environment environment = 5;

Returns
Type Description
Environment

The environment.

getEnvironmentOrBuilder()

public EnvironmentOrBuilder getEnvironmentOrBuilder()

The environment for the job.

.google.dataflow.v1beta3.Environment environment = 5;

Returns
Type Description
EnvironmentOrBuilder

getExecutionInfo()

public JobExecutionInfo getExecutionInfo()

Deprecated.

.google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;

Returns
Type Description
JobExecutionInfo

The executionInfo.

getExecutionInfoOrBuilder()

public JobExecutionInfoOrBuilder getExecutionInfoOrBuilder()

Deprecated.

.google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;

Returns
Type Description
JobExecutionInfoOrBuilder

getId()

public String getId()

The unique ID of this job.

This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

The unique ID of this job.

This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getJobMetadata()

public JobMetadata getJobMetadata()

This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.

.google.dataflow.v1beta3.JobMetadata job_metadata = 21;

Returns
Type Description
JobMetadata

The jobMetadata.

getJobMetadataOrBuilder()

public JobMetadataOrBuilder getJobMetadataOrBuilder()

This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.

.google.dataflow.v1beta3.JobMetadata job_metadata = 21;

Returns
Type Description
JobMetadataOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

User-defined labels for this job.

The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

map<string, string> labels = 17;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

User-defined labels for this job.

The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

map<string, string> labels = 17;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

User-defined labels for this job.

The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

map<string, string> labels = 17;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

User-defined labels for this job.

The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

map<string, string> labels = 17;

Parameter
Name Description
key String
Returns
Type Description
String

getLocation()

public String getLocation()

The regional endpoint that contains this job.

string location = 18;

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

The regional endpoint that contains this job.

string location = 18;

Returns
Type Description
ByteString

The bytes for location.

getName()

public String getName()

The user-specified Cloud Dataflow job name.

Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job.

The name must match the regular expression a-z?

string name = 3;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The user-specified Cloud Dataflow job name.

Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job.

The name must match the regular expression a-z?

string name = 3;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Job> getParserForType()
Returns
Type Description
Parser<Job>
Overrides

getPipelineDescription()

public PipelineDescription getPipelineDescription()

Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

.google.dataflow.v1beta3.PipelineDescription pipeline_description = 19;

Returns
Type Description
PipelineDescription

The pipelineDescription.

getPipelineDescriptionOrBuilder()

public PipelineDescriptionOrBuilder getPipelineDescriptionOrBuilder()

Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

.google.dataflow.v1beta3.PipelineDescription pipeline_description = 19;

Returns
Type Description
PipelineDescriptionOrBuilder

getProjectId()

public String getProjectId()

The ID of the Cloud Platform project that the job belongs to.

string project_id = 2;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

The ID of the Cloud Platform project that the job belongs to.

string project_id = 2;

Returns
Type Description
ByteString

The bytes for projectId.

getReplaceJobId()

public String getReplaceJobId()

If this job is an update of an existing job, this field is the job ID of the job it replaced.

When sending a CreateJobRequest, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.

string replace_job_id = 12;

Returns
Type Description
String

The replaceJobId.

getReplaceJobIdBytes()

public ByteString getReplaceJobIdBytes()

If this job is an update of an existing job, this field is the job ID of the job it replaced.

When sending a CreateJobRequest, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.

string replace_job_id = 12;

Returns
Type Description
ByteString

The bytes for replaceJobId.

getReplacedByJobId()

public String getReplacedByJobId()

If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field contains the ID of that job.

string replaced_by_job_id = 15;

Returns
Type Description
String

The replacedByJobId.

getReplacedByJobIdBytes()

public ByteString getReplacedByJobIdBytes()

If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field contains the ID of that job.

string replaced_by_job_id = 15;

Returns
Type Description
ByteString

The bytes for replacedByJobId.

getRequestedState()

public JobState getRequestedState()

The job's requested state.

UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.

.google.dataflow.v1beta3.JobState requested_state = 9;

Returns
Type Description
JobState

The requestedState.

getRequestedStateValue()

public int getRequestedStateValue()

The job's requested state.

UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.

.google.dataflow.v1beta3.JobState requested_state = 9;

Returns
Type Description
int

The enum numeric value on the wire for requestedState.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.

bool satisfies_pzs = 25;

Returns
Type Description
boolean

The satisfiesPzs.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStageStates(int index)

public ExecutionStageState getStageStates(int index)

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;

Parameter
Name Description
index int
Returns
Type Description
ExecutionStageState

getStageStatesCount()

public int getStageStatesCount()

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;

Returns
Type Description
int

getStageStatesList()

public List<ExecutionStageState> getStageStatesList()

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;

Returns
Type Description
List<ExecutionStageState>

getStageStatesOrBuilder(int index)

public ExecutionStageStateOrBuilder getStageStatesOrBuilder(int index)

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;

Parameter
Name Description
index int
Returns
Type Description
ExecutionStageStateOrBuilder

getStageStatesOrBuilderList()

public List<? extends ExecutionStageStateOrBuilder> getStageStatesOrBuilderList()

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

repeated .google.dataflow.v1beta3.ExecutionStageState stage_states = 20;

Returns
Type Description
List<? extends com.google.dataflow.v1beta3.ExecutionStageStateOrBuilder>

getStartTime()

public Timestamp getStartTime()

The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

.google.protobuf.Timestamp start_time = 22;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

.google.protobuf.Timestamp start_time = 22;

Returns
Type Description
TimestampOrBuilder

getSteps(int index)

public Step getSteps(int index)

Exactly one of step or steps_location should be specified.

The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

repeated .google.dataflow.v1beta3.Step steps = 6;

Parameter
Name Description
index int
Returns
Type Description
Step

getStepsCount()

public int getStepsCount()

Exactly one of step or steps_location should be specified.

The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

repeated .google.dataflow.v1beta3.Step steps = 6;

Returns
Type Description
int

getStepsList()

public List<Step> getStepsList()

Exactly one of step or steps_location should be specified.

The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

repeated .google.dataflow.v1beta3.Step steps = 6;

Returns
Type Description
List<Step>

getStepsLocation()

public String getStepsLocation()

The Cloud Storage location where the steps are stored.

string steps_location = 24;

Returns
Type Description
String

The stepsLocation.

getStepsLocationBytes()

public ByteString getStepsLocationBytes()

The Cloud Storage location where the steps are stored.

string steps_location = 24;

Returns
Type Description
ByteString

The bytes for stepsLocation.

getStepsOrBuilder(int index)

public StepOrBuilder getStepsOrBuilder(int index)

Exactly one of step or steps_location should be specified.

The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

repeated .google.dataflow.v1beta3.Step steps = 6;

Parameter
Name Description
index int
Returns
Type Description
StepOrBuilder

getStepsOrBuilderList()

public List<? extends StepOrBuilder> getStepsOrBuilderList()

Exactly one of step or steps_location should be specified.

The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

repeated .google.dataflow.v1beta3.Step steps = 6;

Returns
Type Description
List<? extends com.google.dataflow.v1beta3.StepOrBuilder>

getTempFiles(int index)

public String getTempFiles(int index)

A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported.

The supported files are:

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object}
bucket.storage.googleapis.com/{object}

repeated string temp_files = 16;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The tempFiles at the given index.

getTempFilesBytes(int index)

public ByteString getTempFilesBytes(int index)

A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported.

The supported files are:

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object}
bucket.storage.googleapis.com/{object}

repeated string temp_files = 16;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the tempFiles at the given index.

getTempFilesCount()

public int getTempFilesCount()

A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported.

The supported files are:

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object}
bucket.storage.googleapis.com/{object}

repeated string temp_files = 16;

Returns
Type Description
int

The count of tempFiles.

getTempFilesList()

public ProtocolStringList getTempFilesList()

A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported.

The supported files are:

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object}
bucket.storage.googleapis.com/{object}

repeated string temp_files = 16;

Returns
Type Description
ProtocolStringList

A list containing the tempFiles.

getTransformNameMapping() (deprecated)

public Map<String,String> getTransformNameMapping()

Use #getTransformNameMappingMap() instead.

Returns
Type Description
Map<String,String>

getTransformNameMappingCount()

public int getTransformNameMappingCount()

The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 13;

Returns
Type Description
int

getTransformNameMappingMap()

public Map<String,String> getTransformNameMappingMap()

The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 13;

Returns
Type Description
Map<String,String>

getTransformNameMappingOrDefault(String key, String defaultValue)

public String getTransformNameMappingOrDefault(String key, String defaultValue)

The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 13;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getTransformNameMappingOrThrow(String key)

public String getTransformNameMappingOrThrow(String key)

The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 13;

Parameter
Name Description
key String
Returns
Type Description
String

getType()

public JobType getType()

The type of Cloud Dataflow job.

.google.dataflow.v1beta3.JobType type = 4;

Returns
Type Description
JobType

The type.

getTypeValue()

public int getTypeValue()

The type of Cloud Dataflow job.

.google.dataflow.v1beta3.JobType type = 4;

Returns
Type Description
int

The enum numeric value on the wire for type.

hasCreateTime()

public boolean hasCreateTime()

The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

.google.protobuf.Timestamp create_time = 11;

Returns
Type Description
boolean

Whether the createTime field is set.

hasCurrentStateTime()

public boolean hasCurrentStateTime()

The timestamp associated with the current state.

.google.protobuf.Timestamp current_state_time = 8;

Returns
Type Description
boolean

Whether the currentStateTime field is set.

hasEnvironment()

public boolean hasEnvironment()

The environment for the job.

.google.dataflow.v1beta3.Environment environment = 5;

Returns
Type Description
boolean

Whether the environment field is set.

hasExecutionInfo()

public boolean hasExecutionInfo()

Deprecated.

.google.dataflow.v1beta3.JobExecutionInfo execution_info = 10;

Returns
Type Description
boolean

Whether the executionInfo field is set.

hasJobMetadata()

public boolean hasJobMetadata()

This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.

.google.dataflow.v1beta3.JobMetadata job_metadata = 21;

Returns
Type Description
boolean

Whether the jobMetadata field is set.

hasPipelineDescription()

public boolean hasPipelineDescription()

Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

.google.dataflow.v1beta3.PipelineDescription pipeline_description = 19;

Returns
Type Description
boolean

Whether the pipelineDescription field is set.

hasStartTime()

public boolean hasStartTime()

The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

.google.protobuf.Timestamp start_time = 22;

Returns
Type Description
boolean

Whether the startTime 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 Job.Builder newBuilderForType()
Returns
Type Description
Job.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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