Job (Dataflow API v1b3 (Rev. 278) 1.23.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.dataflow.model.Job

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Job
extends com.google.api.client.json.GenericJson
```
Defines a job to be run by the Cloud Dataflow service.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Dataflow API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Job()

Constructors
Constructor and Description
`Job()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Job`	`clone()`
`java.lang.String`	`getClientRequestId()` The client's unique identifier of the job, re-used across retried attempts.
`java.lang.String`	`getCreatedFromSnapshotId()` If this is specified, the job's initial state is populated from the given snapshot.
`java.lang.String`	`getCreateTime()` The timestamp when the job was initially created.
`java.lang.String`	`getCurrentState()` The current state of the job.
`java.lang.String`	`getCurrentStateTime()` The timestamp associated with the current state.
`Environment`	`getEnvironment()` The environment for the job.
`JobExecutionInfo`	`getExecutionInfo()` Deprecated.
`java.lang.String`	`getId()` The unique ID of this job.
`JobMetadata`	`getJobMetadata()` This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here.
`java.util.Map<java.lang.String,java.lang.String>`	`getLabels()` User-defined labels for this job.
`java.lang.String`	`getLocation()` The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
`java.lang.String`	`getName()` The user-specified Cloud Dataflow job name.
`PipelineDescription`	`getPipelineDescription()` Preliminary field: The format of this data may change at any time.
`java.lang.String`	`getProjectId()` The ID of the Cloud Platform project that the job belongs to.
`java.lang.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.
`java.lang.String`	`getReplaceJobId()` If this job is an update of an existing job, this field is the job ID of the job it replaced.
`java.lang.String`	`getRequestedState()` The job's requested state.
`java.util.List<ExecutionStageState>`	`getStageStates()` This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
`java.lang.String`	`getStartTime()` The timestamp when the job was started (transitioned to JOB_STATE_PENDING).
`java.util.List<Step>`	`getSteps()` Exactly one of step or steps_location should be specified.
`java.lang.String`	`getStepsLocation()` The GCS location where the steps are stored.
`java.util.List<java.lang.String>`	`getTempFiles()` A set of files the system should be aware of that are used for temporary storage.
`java.util.Map<java.lang.String,java.lang.String>`	`getTransformNameMapping()` The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
`java.lang.String`	`getType()` The type of Cloud Dataflow job.
`Job`	`set(java.lang.String fieldName, java.lang.Object value)`
`Job`	`setClientRequestId(java.lang.String clientRequestId)` The client's unique identifier of the job, re-used across retried attempts.
`Job`	`setCreatedFromSnapshotId(java.lang.String createdFromSnapshotId)` If this is specified, the job's initial state is populated from the given snapshot.
`Job`	`setCreateTime(java.lang.String createTime)` The timestamp when the job was initially created.
`Job`	`setCurrentState(java.lang.String currentState)` The current state of the job.
`Job`	`setCurrentStateTime(java.lang.String currentStateTime)` The timestamp associated with the current state.
`Job`	`setEnvironment(Environment environment)` The environment for the job.
`Job`	`setExecutionInfo(JobExecutionInfo executionInfo)` Deprecated.
`Job`	`setId(java.lang.String id)` The unique ID of this job.
`Job`	`setJobMetadata(JobMetadata jobMetadata)` This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here.
`Job`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)` User-defined labels for this job.
`Job`	`setLocation(java.lang.String location)` The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
`Job`	`setName(java.lang.String name)` The user-specified Cloud Dataflow job name.
`Job`	`setPipelineDescription(PipelineDescription pipelineDescription)` Preliminary field: The format of this data may change at any time.
`Job`	`setProjectId(java.lang.String projectId)` The ID of the Cloud Platform project that the job belongs to.
`Job`	`setReplacedByJobId(java.lang.String replacedByJobId)` 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.
`Job`	`setReplaceJobId(java.lang.String replaceJobId)` If this job is an update of an existing job, this field is the job ID of the job it replaced.
`Job`	`setRequestedState(java.lang.String requestedState)` The job's requested state.
`Job`	`setStageStates(java.util.List<ExecutionStageState> stageStates)` This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
`Job`	`setStartTime(java.lang.String startTime)` The timestamp when the job was started (transitioned to JOB_STATE_PENDING).
`Job`	`setSteps(java.util.List<Step> steps)` Exactly one of step or steps_location should be specified.
`Job`	`setStepsLocation(java.lang.String stepsLocation)` The GCS location where the steps are stored.
`Job`	`setTempFiles(java.util.List<java.lang.String> tempFiles)` A set of files the system should be aware of that are used for temporary storage.
`Job`	`setTransformNameMapping(java.util.Map<java.lang.String,java.lang.String> transformNameMapping)` The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
`Job`	`setType(java.lang.String type)` The type of Cloud Dataflow job.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Job
```
public Job()
```
- Method Detail
  - getClientRequestId
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setClientRequestId
```
public Job setClientRequestId(java.lang.String clientRequestId)
```
    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.
    
    Parameters:
    
    clientRequestId - clientRequestId or null for none
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Job setCreateTime(java.lang.String createTime)
```
    The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
    
    Parameters:
    
    createTime - createTime or null for none
  - getCreatedFromSnapshotId
```
public java.lang.String getCreatedFromSnapshotId()
```
    If this is specified, the job's initial state is populated from the given snapshot.
    
    Returns:
    
    value or null for none
  - setCreatedFromSnapshotId
```
public Job setCreatedFromSnapshotId(java.lang.String createdFromSnapshotId)
```
    If this is specified, the job's initial state is populated from the given snapshot.
    
    Parameters:
    
    createdFromSnapshotId - createdFromSnapshotId or null for none
  - getCurrentState
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
  - setCurrentState
```
public Job setCurrentState(java.lang.String currentState)
```
    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.
    
    Parameters:
    
    currentState - currentState or null for none
  - getCurrentStateTime
```
public java.lang.String getCurrentStateTime()
```
    The timestamp associated with the current state.
    
    Returns:
    
    value or null for none
  - setCurrentStateTime
```
public Job setCurrentStateTime(java.lang.String currentStateTime)
```
    The timestamp associated with the current state.
    
    Parameters:
    
    currentStateTime - currentStateTime or null for none
  - getEnvironment
```
public Environment getEnvironment()
```
    The environment for the job.
    
    Returns:
    
    value or null for none
  - setEnvironment
```
public Job setEnvironment(Environment environment)
```
    The environment for the job.
    
    Parameters:
    
    environment - environment or null for none
  - getExecutionInfo
```
public JobExecutionInfo getExecutionInfo()
```
    Deprecated.
    
    Returns:
    
    value or null for none
  - setExecutionInfo
```
public Job setExecutionInfo(JobExecutionInfo executionInfo)
```
    Deprecated.
    
    Parameters:
    
    executionInfo - executionInfo or null for none
  - getId
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setId
```
public Job setId(java.lang.String id)
```
    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.
    
    Parameters:
    
    id - id or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setJobMetadata
```
public Job setJobMetadata(JobMetadata jobMetadata)
```
    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.
    
    Parameters:
    
    jobMetadata - jobMetadata or null for none
  - getLabels
```
public java.util.Map<java.lang.String,java.lang.String> getLabels()
```
    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.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Job setLabels(java.util.Map<java.lang.String,java.lang.String> labels)
```
    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.
    
    Parameters:
    
    labels - labels or null for none
  - getLocation
```
public java.lang.String getLocation()
```
    The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
    
    Returns:
    
    value or null for none
  - setLocation
```
public Job setLocation(java.lang.String location)
```
    The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
    
    Parameters:
    
    location - location or null for none
  - getName
```
public java.lang.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]([-a-z0-9]{0,38}[a-z0-9])?`
    
    Returns:
    
    value or null for none
  - setName
```
public Job setName(java.lang.String name)
```
    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]([-a-z0-9]{0,38}[a-z0-9])?`
    
    Parameters:
    
    name - name or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setPipelineDescription
```
public Job setPipelineDescription(PipelineDescription pipelineDescription)
```
    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.
    
    Parameters:
    
    pipelineDescription - pipelineDescription or null for none
  - getProjectId
```
public java.lang.String getProjectId()
```
    The ID of the Cloud Platform project that the job belongs to.
    
    Returns:
    
    value or null for none
  - setProjectId
```
public Job setProjectId(java.lang.String projectId)
```
    The ID of the Cloud Platform project that the job belongs to.
    
    Parameters:
    
    projectId - projectId or null for none
  - getReplaceJobId
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setReplaceJobId
```
public Job setReplaceJobId(java.lang.String replaceJobId)
```
    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.
    
    Parameters:
    
    replaceJobId - replaceJobId or null for none
  - getReplacedByJobId
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setReplacedByJobId
```
public Job setReplacedByJobId(java.lang.String replacedByJobId)
```
    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.
    
    Parameters:
    
    replacedByJobId - replacedByJobId or null for none
  - getRequestedState
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
  - setRequestedState
```
public Job setRequestedState(java.lang.String requestedState)
```
    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.
    
    Parameters:
    
    requestedState - requestedState or null for none
  - getStageStates
```
public java.util.List<ExecutionStageState> getStageStates()
```
    This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
    
    Returns:
    
    value or null for none
  - setStageStates
```
public Job setStageStates(java.util.List<ExecutionStageState> stageStates)
```
    This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
    
    Parameters:
    
    stageStates - stageStates or null for none
  - getStartTime
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
  - setStartTime
```
public Job setStartTime(java.lang.String startTime)
```
    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.
    
    Parameters:
    
    startTime - startTime or null for none
  - getSteps
```
public java.util.List<Step> getSteps()
```
    Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job.
    
    Returns:
    
    value or null for none
  - setSteps
```
public Job setSteps(java.util.List<Step> steps)
```
    Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job.
    
    Parameters:
    
    steps - steps or null for none
  - getStepsLocation
```
public java.lang.String getStepsLocation()
```
    The GCS location where the steps are stored.
    
    Returns:
    
    value or null for none
  - setStepsLocation
```
public Job setStepsLocation(java.lang.String stepsLocation)
```
    The GCS location where the steps are stored.
    
    Parameters:
    
    stepsLocation - stepsLocation or null for none
  - getTempFiles
```
public java.util.List<java.lang.String> getTempFiles()
```
    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}
    
    Returns:
    
    value or null for none
  - setTempFiles
```
public Job setTempFiles(java.util.List<java.lang.String> tempFiles)
```
    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}
    
    Parameters:
    
    tempFiles - tempFiles or null for none
  - getTransformNameMapping
```
public java.util.Map<java.lang.String,java.lang.String> getTransformNameMapping()
```
    The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
    
    Returns:
    
    value or null for none
  - setTransformNameMapping
```
public Job setTransformNameMapping(java.util.Map<java.lang.String,java.lang.String> transformNameMapping)
```
    The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
    
    Parameters:
    
    transformNameMapping - transformNameMapping or null for none
  - getType
```
public java.lang.String getType()
```
    The type of Cloud Dataflow job.
    
    Returns:
    
    value or null for none
  - setType
```
public Job setType(java.lang.String type)
```
    The type of Cloud Dataflow job.
    
    Parameters:
    
    type - type or null for none
  - set
```
public Job set(java.lang.String fieldName,
               java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Job clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Dataflow API v1b3 (revision 278)

Class Job

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Job

Method Detail

getClientRequestId

setClientRequestId

getCreateTime

setCreateTime

getCreatedFromSnapshotId

setCreatedFromSnapshotId

getCurrentState

setCurrentState

getCurrentStateTime

setCurrentStateTime

getEnvironment

setEnvironment

getExecutionInfo

setExecutionInfo

getId

setId

getJobMetadata

setJobMetadata

getLabels

setLabels

getLocation

setLocation

getName

setName

getPipelineDescription

setPipelineDescription

getProjectId

setProjectId

getReplaceJobId

setReplaceJobId

getReplacedByJobId

setReplacedByJobId

getRequestedState

setRequestedState

getStageStates

setStageStates

getStartTime

setStartTime

getSteps

setSteps

getStepsLocation

setStepsLocation

getTempFiles

setTempFiles

getTransformNameMapping

setTransformNameMapping

getType

setType

set

clone