Job (Google Dataflow API v1b3 (Rev. 24) 1.18.0-rc)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Job
extends GenericJson
```
Defines a job to be run by the 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 Google Dataflow API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

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

Constructor Summary

Constructors
Constructor and Description

Job()

Constructors
Constructor and Description
`Job()`

Method Summary

Methods
Modifier and Type	Method and Description
`Job`	`clone()`
`String`	`getClientRequestId()` Client's unique identifier of the job, re-used by SDK across retried attempts.
`String`	`getCreateTime()` Timestamp when job was initially created.
`String`	`getCurrentState()` The current state of the job.
`String`	`getCurrentStateTime()` The timestamp associated with the current state.
`Environment`	`getEnvironment()` Environment for the job.
`JobExecutionInfo`	`getExecutionInfo()` Information about how the Dataflow service will actually run the job.
`String`	`getId()` The unique ID of this job.
`String`	`getName()` The user-specified Dataflow job name.
`String`	`getProjectId()` The project which owns the job.
`String`	`getReplacedByJobId()` If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
`String`	`getReplaceJobId()` If this job is an update of an existing job, this field will be the ID of the job it replaced.
`String`	`getRequestedState()` The job's requested state.
`List<Step>`	`getSteps()` The top-level steps that constitute the entire job.
`List<String>`	`getTempFiles()` A set of files the system should be aware of that are used for temporary storage.
`Map<String,String>`	`getTransformNameMapping()` Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
`String`	`getType()` The type of dataflow job.
`Job`	`set(String fieldName, Object value)`
`Job`	`setClientRequestId(String clientRequestId)` Client's unique identifier of the job, re-used by SDK across retried attempts.
`Job`	`setCreateTime(String createTime)` Timestamp when job was initially created.
`Job`	`setCurrentState(String currentState)` The current state of the job.
`Job`	`setCurrentStateTime(String currentStateTime)` The timestamp associated with the current state.
`Job`	`setEnvironment(Environment environment)` Environment for the job.
`Job`	`setExecutionInfo(JobExecutionInfo executionInfo)` Information about how the Dataflow service will actually run the job.
`Job`	`setId(String id)` The unique ID of this job.
`Job`	`setName(String name)` The user-specified Dataflow job name.
`Job`	`setProjectId(String projectId)` The project which owns the job.
`Job`	`setReplacedByJobId(String replacedByJobId)` If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
`Job`	`setReplaceJobId(String replaceJobId)` If this job is an update of an existing job, this field will be the ID of the job it replaced.
`Job`	`setRequestedState(String requestedState)` The job's requested state.
`Job`	`setSteps(List<Step> steps)` The top-level steps that constitute the entire job.
`Job`	`setTempFiles(List<String> tempFiles)` A set of files the system should be aware of that are used for temporary storage.
`Job`	`setTransformNameMapping(Map<String,String> transformNameMapping)` Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
`Job`	`setType(String type)` The type of 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

- Constructor Detail
  - Job
```
public Job()
```
- Method Detail
  - getClientRequestId
```
public String getClientRequestId()
```
    Client's unique identifier of the job, re-used by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, 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, for example, 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(String clientRequestId)
```
    Client's unique identifier of the job, re-used by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, 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, for example, 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 String getCreateTime()
```
    Timestamp when job was initially created. Immutable, set by the Dataflow service.
    
    Returns:
    value or null for none
  - setCreateTime
```
public Job setCreateTime(String createTime)
```
    Timestamp when job was initially created. Immutable, set by the Dataflow service.
    
    Parameters:
    createTime - createTime or null for none
  - getCurrentState
```
public 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. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it.
    
    Returns:
    value or null for none
  - setCurrentState
```
public Job setCurrentState(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. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it.
    
    Parameters:
    currentState - currentState or null for none
  - getCurrentStateTime
```
public String getCurrentStateTime()
```
    The timestamp associated with the current state.
    
    Returns:
    value or null for none
  - setCurrentStateTime
```
public Job setCurrentStateTime(String currentStateTime)
```
    The timestamp associated with the current state.
    
    Parameters:
    currentStateTime - currentStateTime or null for none
  - getEnvironment
```
public Environment getEnvironment()
```
    Environment for the job.
    
    Returns:
    value or null for none
  - setEnvironment
```
public Job setEnvironment(Environment environment)
```
    Environment for the job.
    
    Parameters:
    environment - environment or null for none
  - getExecutionInfo
```
public JobExecutionInfo getExecutionInfo()
```
    Information about how the Dataflow service will actually run the job.
    
    Returns:
    value or null for none
  - setExecutionInfo
```
public Job setExecutionInfo(JobExecutionInfo executionInfo)
```
    Information about how the Dataflow service will actually run the job.
    
    Parameters:
    executionInfo - executionInfo or null for none
  - getId
```
public String getId()
```
    The unique ID of this job. This field is set by the 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(String id)
```
    The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job.
    
    Parameters:
    id - id or null for none
  - getName
```
public String getName()
```
    The user-specified 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 will return 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(String name)
```
    The user-specified 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 will return 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
  - getProjectId
```
public String getProjectId()
```
    The project which owns the job.
    
    Returns:
    value or null for none
  - setProjectId
```
public Job setProjectId(String projectId)
```
    The project which owns the job.
    
    Parameters:
    projectId - projectId or null for none
  - getReplaceJobId
```
public String getReplaceJobId()
```
    If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here will be stopped, and its intermediate state transferred to this job.
    
    Returns:
    value or null for none
  - setReplaceJobId
```
public Job setReplaceJobId(String replaceJobId)
```
    If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here will be stopped, and its intermediate state transferred to this job.
    
    Parameters:
    replaceJobId - replaceJobId or null for none
  - getReplacedByJobId
```
public String getReplacedByJobId()
```
    If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
    
    Returns:
    value or null for none
  - setReplacedByJobId
```
public Job setReplacedByJobId(String replacedByJobId)
```
    If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
    
    Parameters:
    replacedByJobId - replacedByJobId or null for none
  - getRequestedState
```
public 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(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
  - getSteps
```
public List<Step> getSteps()
```
    The top-level steps that constitute the entire job.
    
    Returns:
    value or null for none
  - setSteps
```
public Job setSteps(List<Step> steps)
```
    The top-level steps that constitute the entire job.
    
    Parameters:
    steps - steps or null for none
  - getTempFiles
```
public List<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(List<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 Map<String,String> getTransformNameMapping()
```
    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(Map<String,String> transformNameMapping)
```
    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 String getType()
```
    The type of dataflow job.
    
    Returns:
    value or null for none
  - setType
```
public Job setType(String type)
```
    The type of dataflow job.
    
    Parameters:
    type - type or null for none
  - set
```
public Job set(String fieldName,
      Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Job clone()
```
    Overrides:
    
    clone in class GenericJson

Google Dataflow API v1b3 (revision 24)

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

Constructor Detail

Job

Method Detail

getClientRequestId

setClientRequestId

getCreateTime

setCreateTime

getCurrentState

setCurrentState

getCurrentStateTime

setCurrentStateTime

getEnvironment

setEnvironment

getExecutionInfo

setExecutionInfo

getId

setId

getName

setName

getProjectId

setProjectId

getReplaceJobId

setReplaceJobId

getReplacedByJobId

setReplacedByJobId

getRequestedState

setRequestedState

getSteps

setSteps

getTempFiles

setTempFiles

getTransformNameMapping

setTransformNameMapping

getType

setType

set

clone