com.google.api.services.dataflow

Class Dataflow.Projects.Jobs.Get

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.dataflow.DataflowRequest<Job>

com.google.api.services.dataflow.Dataflow.Projects.Jobs.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dataflow.Projects.Jobs

public class Dataflow.Projects.Jobs.Get
extends DataflowRequest<Job>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Get(String projectId, String jobId) Gets the state of the specified Cloud Dataflow job.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getJobId() The job ID.
String	getLocation() The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
String	getProjectId() The ID of the Cloud Platform project that the job belongs to.
String	getView() The level of information requested in response.
Dataflow.Projects.Jobs.Get	set(String parameterName, Object value)
Dataflow.Projects.Jobs.Get	set$Xgafv(String $Xgafv) V1 error format.
Dataflow.Projects.Jobs.Get	setAccessToken(String accessToken) OAuth access token.
Dataflow.Projects.Jobs.Get	setAlt(String alt) Data format for response.
Dataflow.Projects.Jobs.Get	setCallback(String callback) JSONP
Dataflow.Projects.Jobs.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Dataflow.Projects.Jobs.Get	setJobId(String jobId) The job ID.
Dataflow.Projects.Jobs.Get	setKey(String key) API key.
Dataflow.Projects.Jobs.Get	setLocation(String location) The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints) that contains this job.
Dataflow.Projects.Jobs.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dataflow.Projects.Jobs.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dataflow.Projects.Jobs.Get	setProjectId(String projectId) The ID of the Cloud Platform project that the job belongs to.
Dataflow.Projects.Jobs.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dataflow.Projects.Jobs.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dataflow.Projects.Jobs.Get	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Dataflow.Projects.Jobs.Get	setView(String view) The level of information requested in response.

Methods inherited from class com.google.api.services.dataflow.DataflowRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, 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

Get

protected Get(String projectId,
              String jobId)

Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. Create a request for the method "jobs.get". This request holds the parameters needed by the the dataflow server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Dataflow.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

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

jobId - The job ID.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Job>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Job>

Throws:

IOException

set$Xgafv

public Dataflow.Projects.Jobs.Get set$Xgafv(String $Xgafv)

Description copied from class: DataflowRequest

V1 error format.

Overrides:

set$Xgafv in class DataflowRequest<Job>

setAccessToken

public Dataflow.Projects.Jobs.Get setAccessToken(String accessToken)

Description copied from class: DataflowRequest

OAuth access token.

Overrides:

setAccessToken in class DataflowRequest<Job>

setAlt

public Dataflow.Projects.Jobs.Get setAlt(String alt)

Description copied from class: DataflowRequest

Data format for response.

Overrides:

setAlt in class DataflowRequest<Job>

setCallback

public Dataflow.Projects.Jobs.Get setCallback(String callback)

Description copied from class: DataflowRequest

JSONP

Overrides:

setCallback in class DataflowRequest<Job>

setFields

public Dataflow.Projects.Jobs.Get setFields(String fields)

Description copied from class: DataflowRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DataflowRequest<Job>

setKey

public Dataflow.Projects.Jobs.Get setKey(String key)

Description copied from class: DataflowRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DataflowRequest<Job>

setOauthToken

public Dataflow.Projects.Jobs.Get setOauthToken(String oauthToken)

Description copied from class: DataflowRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DataflowRequest<Job>

setPrettyPrint

public Dataflow.Projects.Jobs.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: DataflowRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DataflowRequest<Job>

setQuotaUser

public Dataflow.Projects.Jobs.Get setQuotaUser(String quotaUser)

Description copied from class: DataflowRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class DataflowRequest<Job>

setUploadType

public Dataflow.Projects.Jobs.Get setUploadType(String uploadType)

Description copied from class: DataflowRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class DataflowRequest<Job>

setUploadProtocol

public Dataflow.Projects.Jobs.Get setUploadProtocol(String uploadProtocol)

Description copied from class: DataflowRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class DataflowRequest<Job>

getProjectId

public String getProjectId()

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

setProjectId

public Dataflow.Projects.Jobs.Get setProjectId(String projectId)

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

getJobId

public String getJobId()

The job ID.

setJobId

public Dataflow.Projects.Jobs.Get setJobId(String jobId)

The job ID.

getLocation

public String getLocation()

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

setLocation

public Dataflow.Projects.Jobs.Get setLocation(String location)

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints) that contains this job.

getView

public String getView()

The level of information requested in response.

setView

public Dataflow.Projects.Jobs.Get setView(String view)

The level of information requested in response.

set

public Dataflow.Projects.Jobs.Get set(String parameterName,
                                      Object value)

Overrides:

set in class DataflowRequest<Job>