Interface JobOrBuilder (0.52.0)

public interface JobOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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 abstract 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`

getClientRequestId()

public abstract 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 abstract ByteString getClientRequestIdBytes()

string client_request_id = 14;

Returns
Type	Description
`ByteString`	The bytes for clientRequestId.

getCreateTime()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Timestamp getCurrentStateTime()

The timestamp associated with the current state.

.google.protobuf.Timestamp current_state_time = 8;

Returns
Type	Description
`Timestamp`	The currentStateTime.

getCurrentStateTimeOrBuilder()

public abstract TimestampOrBuilder getCurrentStateTimeOrBuilder()

The timestamp associated with the current state.

.google.protobuf.Timestamp current_state_time = 8;

Returns
Type	Description
`TimestampOrBuilder`

getCurrentStateValue()

public abstract 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.

getEnvironment()

public abstract Environment getEnvironment()

The environment for the job.

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

Returns
Type	Description
`Environment`	The environment.

getEnvironmentOrBuilder()

public abstract EnvironmentOrBuilder getEnvironmentOrBuilder()

The environment for the job.

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

Returns
Type	Description
`EnvironmentOrBuilder`

getExecutionInfo()

public abstract JobExecutionInfo getExecutionInfo()

Deprecated.

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

Returns
Type	Description
`JobExecutionInfo`	The executionInfo.

getExecutionInfoOrBuilder()

public abstract JobExecutionInfoOrBuilder getExecutionInfoOrBuilder()

Deprecated.

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

Returns
Type	Description
`JobExecutionInfoOrBuilder`

getId()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract String getLocation()

The regional endpoint that contains this job.

string location = 18;

Returns
Type	Description
`String`	The location.

getLocationBytes()

public abstract ByteString getLocationBytes()

The regional endpoint that contains this job.

string location = 18;

Returns
Type	Description
`ByteString`	The bytes for location.

getName()

public abstract 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 abstract 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.

getPipelineDescription()

public abstract 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 abstract PipelineDescriptionOrBuilder getPipelineDescriptionOrBuilder()

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

Returns
Type	Description
`PipelineDescriptionOrBuilder`

getProjectId()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract int getRequestedStateValue()

The job's requested state.

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

Returns
Type	Description
`int`	The enum numeric value on the wire for requestedState.

getSatisfiesPzs()

public abstract 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.

getStageStates(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract TimestampOrBuilder getStartTimeOrBuilder()

.google.protobuf.Timestamp start_time = 22;

Returns
Type	Description
`TimestampOrBuilder`

getSteps(int index)

public abstract 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 abstract 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 abstract 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 abstract String getStepsLocation()

The Cloud Storage location where the steps are stored.

string steps_location = 24;

Returns
Type	Description
`String`	The stepsLocation.

getStepsLocationBytes()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
`List<String>`	A list containing the tempFiles.

getTransformNameMapping() (deprecated)

public abstract Map<String,String> getTransformNameMapping()

Use #getTransformNameMappingMap() instead.

Returns
Type	Description
`Map<String,String>`

getTransformNameMappingCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract JobType getType()

The type of Cloud Dataflow job.

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

Returns
Type	Description
`JobType`	The type.

getTypeValue()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasExecutionInfo()

Deprecated.

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

Returns
Type	Description
`boolean`	Whether the executionInfo field is set.

hasJobMetadata()

public abstract 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 abstract boolean hasPipelineDescription()

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

Returns
Type	Description
`boolean`	Whether the pipelineDescription field is set.

hasStartTime()

public abstract boolean hasStartTime()

.google.protobuf.Timestamp start_time = 22;

Returns
Type	Description
`boolean`	Whether the startTime field is set.