public static final class Job.Builder extends GeneratedMessageV3.Builder<Job.Builder> implements JobOrBuilderDefines a job to be run by the Cloud Dataflow service. Do not enter confidential information when you supply string values using the API. Fields stripped from source Job proto:
- steps
- pipeline_description
- transform_name_mapping
Protobuf type google.events.cloud.dataflow.v1beta3.Job
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Job.BuilderImplements
JobOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllStageStates(Iterable<? extends ExecutionStageState> values)
public Job.Builder addAllStageStates(Iterable<? extends ExecutionStageState> values)This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.events.cloud.dataflow.v1beta3.ExecutionStageState> |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
addAllTempFiles(Iterable<String> values)
public Job.Builder addAllTempFiles(Iterable<String> values)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 |
values | Iterable<String>The tempFiles to add. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Job.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
addStageStates(ExecutionStageState value)
public Job.Builder addStageStates(ExecutionStageState value)This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionStageState |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
addStageStates(ExecutionStageState.Builder builderForValue)
public Job.Builder addStageStates(ExecutionStageState.Builder builderForValue)This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ExecutionStageState.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
addStageStates(int index, ExecutionStageState value)
public Job.Builder addStageStates(int index, ExecutionStageState value)This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | ExecutionStageState |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
addStageStates(int index, ExecutionStageState.Builder builderForValue)
public Job.Builder addStageStates(int index, ExecutionStageState.Builder builderForValue)This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | ExecutionStageState.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
addStageStatesBuilder()
public ExecutionStageState.Builder addStageStatesBuilder()This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Returns | |
|---|---|
| Type | Description |
ExecutionStageState.Builder | |
addStageStatesBuilder(int index)
public ExecutionStageState.Builder addStageStatesBuilder(int index)This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ExecutionStageState.Builder | |
addTempFiles(String value)
public Job.Builder addTempFiles(String value)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 |
value | StringThe tempFiles to add. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
addTempFilesBytes(ByteString value)
public Job.Builder addTempFilesBytes(ByteString value)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 |
value | ByteStringThe bytes of the tempFiles to add. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
build()
public Job build()| Returns | |
|---|---|
| Type | Description |
Job | |
buildPartial()
public Job buildPartial()| Returns | |
|---|---|
| Type | Description |
Job | |
clear()
public Job.Builder clear()| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearClientRequestId()
public Job.Builder clearClientRequestId()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 |
Job.Builder | This builder for chaining. |
clearCreateTime()
public Job.Builder clearCreateTime()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 |
Job.Builder | |
clearCreatedFromSnapshotId()
public Job.Builder clearCreatedFromSnapshotId()If this is specified, the job's initial state is populated from the given snapshot.
string created_from_snapshot_id = 23;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearCurrentState()
public Job.Builder clearCurrentState() 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.events.cloud.dataflow.v1beta3.JobState current_state = 7;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearCurrentStateTime()
public Job.Builder clearCurrentStateTime()The timestamp associated with the current state.
.google.protobuf.Timestamp current_state_time = 8;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearEnvironment()
public Job.Builder clearEnvironment()The environment for the job.
.google.events.cloud.dataflow.v1beta3.Environment environment = 5;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearExecutionInfo()
public Job.Builder clearExecutionInfo()Deprecated.
.google.events.cloud.dataflow.v1beta3.JobExecutionInfo execution_info = 10;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearField(Descriptors.FieldDescriptor field)
public Job.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearId()
public Job.Builder clearId()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 |
Job.Builder | This builder for chaining. |
clearJobMetadata()
public Job.Builder clearJobMetadata()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.events.cloud.dataflow.v1beta3.JobMetadata job_metadata = 21;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearLabels()
public Job.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearLocation()
public Job.Builder clearLocation()The regional endpoint that contains this job.
string location = 18;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearName()
public Job.Builder clearName() The user-specified Cloud Dataflow job name.
Only one Job with a given name can exist in a project within one region at
any given time. Jobs in different regions can have the same name.
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 |
Job.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Job.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearProjectId()
public Job.Builder clearProjectId()The ID of the Cloud Platform project that the job belongs to.
string project_id = 2;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearReplaceJobId()
public Job.Builder clearReplaceJobId() 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 |
Job.Builder | This builder for chaining. |
clearReplacedByJobId()
public Job.Builder clearReplacedByJobId() 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 |
Job.Builder | This builder for chaining. |
clearRequestedState()
public Job.Builder clearRequestedState() 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.events.cloud.dataflow.v1beta3.JobState requested_state = 9;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearSatisfiesPzs()
public Job.Builder clearSatisfiesPzs()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 |
Job.Builder | This builder for chaining. |
clearStageStates()
public Job.Builder clearStageStates()This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearStartTime()
public Job.Builder clearStartTime()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 |
Job.Builder | |
clearStepsLocation()
public Job.Builder clearStepsLocation()The Cloud Storage location where the steps are stored.
string steps_location = 24;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearTempFiles()
public Job.Builder clearTempFiles()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 |
Job.Builder | This builder for chaining. |
clearType()
public Job.Builder clearType()The type of Cloud Dataflow job.
.google.events.cloud.dataflow.v1beta3.JobType type = 4;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clone()
public Job.Builder clone()| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
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 | |
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()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 |
Builder | |
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.events.cloud.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. |
getCurrentStateTimeBuilder()
public Timestamp.Builder getCurrentStateTimeBuilder()The timestamp associated with the current state.
.google.protobuf.Timestamp current_state_time = 8;
| Returns | |
|---|---|
| Type | Description |
Builder | |
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.events.cloud.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 | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getEnvironment()
public Environment getEnvironment()The environment for the job.
.google.events.cloud.dataflow.v1beta3.Environment environment = 5;
| Returns | |
|---|---|
| Type | Description |
Environment | The environment. |
getEnvironmentBuilder()
public Environment.Builder getEnvironmentBuilder()The environment for the job.
.google.events.cloud.dataflow.v1beta3.Environment environment = 5;
| Returns | |
|---|---|
| Type | Description |
Environment.Builder | |
getEnvironmentOrBuilder()
public EnvironmentOrBuilder getEnvironmentOrBuilder()The environment for the job.
.google.events.cloud.dataflow.v1beta3.Environment environment = 5;
| Returns | |
|---|---|
| Type | Description |
EnvironmentOrBuilder | |
getExecutionInfo()
public JobExecutionInfo getExecutionInfo()Deprecated.
.google.events.cloud.dataflow.v1beta3.JobExecutionInfo execution_info = 10;
| Returns | |
|---|---|
| Type | Description |
JobExecutionInfo | The executionInfo. |
getExecutionInfoBuilder()
public JobExecutionInfo.Builder getExecutionInfoBuilder()Deprecated.
.google.events.cloud.dataflow.v1beta3.JobExecutionInfo execution_info = 10;
| Returns | |
|---|---|
| Type | Description |
JobExecutionInfo.Builder | |
getExecutionInfoOrBuilder()
public JobExecutionInfoOrBuilder getExecutionInfoOrBuilder()Deprecated.
.google.events.cloud.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.events.cloud.dataflow.v1beta3.JobMetadata job_metadata = 21;
| Returns | |
|---|---|
| Type | Description |
JobMetadata | The jobMetadata. |
getJobMetadataBuilder()
public JobMetadata.Builder getJobMetadataBuilder()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.events.cloud.dataflow.v1beta3.JobMetadata job_metadata = 21;
| Returns | |
|---|---|
| Type | Description |
JobMetadata.Builder | |
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.events.cloud.dataflow.v1beta3.JobMetadata job_metadata = 21;
| Returns | |
|---|---|
| Type | Description |
JobMetadataOrBuilder | |
getLabels()
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. |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getName()
public String getName() The user-specified Cloud Dataflow job name.
Only one Job with a given name can exist in a project within one region at
any given time. Jobs in different regions can have the same name.
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 can exist in a project within one region at
any given time. Jobs in different regions can have the same name.
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. |
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.events.cloud.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.events.cloud.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. |
getStageStates(int index)
public ExecutionStageState getStageStates(int index)This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ExecutionStageState | |
getStageStatesBuilder(int index)
public ExecutionStageState.Builder getStageStatesBuilder(int index)This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ExecutionStageState.Builder | |
getStageStatesBuilderList()
public List<ExecutionStageState.Builder> getStageStatesBuilderList()This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getStageStatesCount()
public int getStageStatesCount()This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.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.events.cloud.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.events.cloud.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.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.events.cloud.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. |
getStartTimeBuilder()
public Timestamp.Builder getStartTimeBuilder()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 |
Builder | |
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 | |
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. |
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 | intThe 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 | intThe 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. |
getType()
public JobType getType()The type of Cloud Dataflow job.
.google.events.cloud.dataflow.v1beta3.JobType type = 4;
| Returns | |
|---|---|
| Type | Description |
JobType | The type. |
getTypeValue()
public int getTypeValue()The type of Cloud Dataflow job.
.google.events.cloud.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.events.cloud.dataflow.v1beta3.Environment environment = 5;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the environment field is set. |
hasExecutionInfo()
public boolean hasExecutionInfo()Deprecated.
.google.events.cloud.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.events.cloud.dataflow.v1beta3.JobMetadata job_metadata = 21;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the jobMetadata 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeCreateTime(Timestamp value)
public Job.Builder mergeCreateTime(Timestamp value)The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
.google.protobuf.Timestamp create_time = 11;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeCurrentStateTime(Timestamp value)
public Job.Builder mergeCurrentStateTime(Timestamp value)The timestamp associated with the current state.
.google.protobuf.Timestamp current_state_time = 8;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeEnvironment(Environment value)
public Job.Builder mergeEnvironment(Environment value)The environment for the job.
.google.events.cloud.dataflow.v1beta3.Environment environment = 5;
| Parameter | |
|---|---|
| Name | Description |
value | Environment |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeExecutionInfo(JobExecutionInfo value)
public Job.Builder mergeExecutionInfo(JobExecutionInfo value)Deprecated.
.google.events.cloud.dataflow.v1beta3.JobExecutionInfo execution_info = 10;
| Parameter | |
|---|---|
| Name | Description |
value | JobExecutionInfo |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeFrom(Job other)
public Job.Builder mergeFrom(Job other)| Parameter | |
|---|---|
| Name | Description |
other | Job |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Job.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Job.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeJobMetadata(JobMetadata value)
public Job.Builder mergeJobMetadata(JobMetadata value)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.events.cloud.dataflow.v1beta3.JobMetadata job_metadata = 21;
| Parameter | |
|---|---|
| Name | Description |
value | JobMetadata |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeStartTime(Timestamp value)
public Job.Builder mergeStartTime(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Job.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
putAllLabels(Map<String,String> values)
public Job.Builder putAllLabels(Map<String,String> values)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 |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
putLabels(String key, String value)
public Job.Builder putLabels(String key, String value)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 |
value | String |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
removeLabels(String key)
public Job.Builder removeLabels(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 |
Job.Builder | |
removeStageStates(int index)
public Job.Builder removeStageStates(int index)This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setClientRequestId(String value)
public Job.Builder setClientRequestId(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe clientRequestId to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setClientRequestIdBytes(ByteString value)
public Job.Builder setClientRequestIdBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for clientRequestId to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setCreateTime(Timestamp value)
public Job.Builder setCreateTime(Timestamp value)The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
.google.protobuf.Timestamp create_time = 11;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setCreateTime(Timestamp.Builder builderForValue)
public Job.Builder setCreateTime(Timestamp.Builder builderForValue)The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
.google.protobuf.Timestamp create_time = 11;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setCreatedFromSnapshotId(String value)
public Job.Builder setCreatedFromSnapshotId(String value)If this is specified, the job's initial state is populated from the given snapshot.
string created_from_snapshot_id = 23;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe createdFromSnapshotId to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setCreatedFromSnapshotIdBytes(ByteString value)
public Job.Builder setCreatedFromSnapshotIdBytes(ByteString value)If this is specified, the job's initial state is populated from the given snapshot.
string created_from_snapshot_id = 23;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for createdFromSnapshotId to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setCurrentState(JobState value)
public Job.Builder setCurrentState(JobState value) 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.events.cloud.dataflow.v1beta3.JobState current_state = 7;
| Parameter | |
|---|---|
| Name | Description |
value | JobStateThe currentState to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setCurrentStateTime(Timestamp value)
public Job.Builder setCurrentStateTime(Timestamp value)The timestamp associated with the current state.
.google.protobuf.Timestamp current_state_time = 8;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setCurrentStateTime(Timestamp.Builder builderForValue)
public Job.Builder setCurrentStateTime(Timestamp.Builder builderForValue)The timestamp associated with the current state.
.google.protobuf.Timestamp current_state_time = 8;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setCurrentStateValue(int value)
public Job.Builder setCurrentStateValue(int value) 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.events.cloud.dataflow.v1beta3.JobState current_state = 7;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for currentState to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setEnvironment(Environment value)
public Job.Builder setEnvironment(Environment value)The environment for the job.
.google.events.cloud.dataflow.v1beta3.Environment environment = 5;
| Parameter | |
|---|---|
| Name | Description |
value | Environment |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setEnvironment(Environment.Builder builderForValue)
public Job.Builder setEnvironment(Environment.Builder builderForValue)The environment for the job.
.google.events.cloud.dataflow.v1beta3.Environment environment = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Environment.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setExecutionInfo(JobExecutionInfo value)
public Job.Builder setExecutionInfo(JobExecutionInfo value)Deprecated.
.google.events.cloud.dataflow.v1beta3.JobExecutionInfo execution_info = 10;
| Parameter | |
|---|---|
| Name | Description |
value | JobExecutionInfo |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setExecutionInfo(JobExecutionInfo.Builder builderForValue)
public Job.Builder setExecutionInfo(JobExecutionInfo.Builder builderForValue)Deprecated.
.google.events.cloud.dataflow.v1beta3.JobExecutionInfo execution_info = 10;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | JobExecutionInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public Job.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setId(String value)
public Job.Builder setId(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe id to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setIdBytes(ByteString value)
public Job.Builder setIdBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for id to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setJobMetadata(JobMetadata value)
public Job.Builder setJobMetadata(JobMetadata value)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.events.cloud.dataflow.v1beta3.JobMetadata job_metadata = 21;
| Parameter | |
|---|---|
| Name | Description |
value | JobMetadata |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setJobMetadata(JobMetadata.Builder builderForValue)
public Job.Builder setJobMetadata(JobMetadata.Builder builderForValue)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.events.cloud.dataflow.v1beta3.JobMetadata job_metadata = 21;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | JobMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setLocation(String value)
public Job.Builder setLocation(String value)The regional endpoint that contains this job.
string location = 18;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe location to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setLocationBytes(ByteString value)
public Job.Builder setLocationBytes(ByteString value)The regional endpoint that contains this job.
string location = 18;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for location to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setName(String value)
public Job.Builder setName(String value) The user-specified Cloud Dataflow job name.
Only one Job with a given name can exist in a project within one region at
any given time. Jobs in different regions can have the same name.
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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Job.Builder setNameBytes(ByteString value) The user-specified Cloud Dataflow job name.
Only one Job with a given name can exist in a project within one region at
any given time. Jobs in different regions can have the same name.
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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setProjectId(String value)
public Job.Builder setProjectId(String value)The ID of the Cloud Platform project that the job belongs to.
string project_id = 2;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe projectId to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setProjectIdBytes(ByteString value)
public Job.Builder setProjectIdBytes(ByteString value)The ID of the Cloud Platform project that the job belongs to.
string project_id = 2;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for projectId to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Job.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setReplaceJobId(String value)
public Job.Builder setReplaceJobId(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe replaceJobId to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setReplaceJobIdBytes(ByteString value)
public Job.Builder setReplaceJobIdBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for replaceJobId to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setReplacedByJobId(String value)
public Job.Builder setReplacedByJobId(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe replacedByJobId to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setReplacedByJobIdBytes(ByteString value)
public Job.Builder setReplacedByJobIdBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for replacedByJobId to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setRequestedState(JobState value)
public Job.Builder setRequestedState(JobState value) 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.events.cloud.dataflow.v1beta3.JobState requested_state = 9;
| Parameter | |
|---|---|
| Name | Description |
value | JobStateThe requestedState to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setRequestedStateValue(int value)
public Job.Builder setRequestedStateValue(int value) 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.events.cloud.dataflow.v1beta3.JobState requested_state = 9;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for requestedState to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setSatisfiesPzs(boolean value)
public Job.Builder setSatisfiesPzs(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe satisfiesPzs to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setStageStates(int index, ExecutionStageState value)
public Job.Builder setStageStates(int index, ExecutionStageState value)This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | ExecutionStageState |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setStageStates(int index, ExecutionStageState.Builder builderForValue)
public Job.Builder setStageStates(int index, ExecutionStageState.Builder builderForValue)This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
repeated .google.events.cloud.dataflow.v1beta3.ExecutionStageState stage_states = 20;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | ExecutionStageState.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setStartTime(Timestamp value)
public Job.Builder setStartTime(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setStartTime(Timestamp.Builder builderForValue)
public Job.Builder setStartTime(Timestamp.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setStepsLocation(String value)
public Job.Builder setStepsLocation(String value)The Cloud Storage location where the steps are stored.
string steps_location = 24;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe stepsLocation to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setStepsLocationBytes(ByteString value)
public Job.Builder setStepsLocationBytes(ByteString value)The Cloud Storage location where the steps are stored.
string steps_location = 24;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for stepsLocation to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setTempFiles(int index, String value)
public Job.Builder setTempFiles(int index, String value)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;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe tempFiles to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setType(JobType value)
public Job.Builder setType(JobType value)The type of Cloud Dataflow job.
.google.events.cloud.dataflow.v1beta3.JobType type = 4;
| Parameter | |
|---|---|
| Name | Description |
value | JobTypeThe type to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setTypeValue(int value)
public Job.Builder setTypeValue(int value)The type of Cloud Dataflow job.
.google.events.cloud.dataflow.v1beta3.JobType type = 4;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for type to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Job.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |