com.google.api.services.dataflow

Class Dataflow.Projects.Jobs.Snapshot

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<Snapshot>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dataflow.Projects.Jobs

public class Dataflow.Projects.Jobs.Snapshot
extends DataflowRequest<Snapshot>

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	Snapshot(String projectId, String jobId, SnapshotJobRequest content) Snapshot the state of a streaming job.

Method Summary

Modifier and Type	Method and Description
String	getJobId() The job to be snapshotted.
String	getProjectId() The project which owns the job to be snapshotted.
Dataflow.Projects.Jobs.Snapshot	set(String parameterName, Object value)
Dataflow.Projects.Jobs.Snapshot	set$Xgafv(String $Xgafv) V1 error format.
Dataflow.Projects.Jobs.Snapshot	setAccessToken(String accessToken) OAuth access token.
Dataflow.Projects.Jobs.Snapshot	setAlt(String alt) Data format for response.
Dataflow.Projects.Jobs.Snapshot	setCallback(String callback) JSONP
Dataflow.Projects.Jobs.Snapshot	setFields(String fields) Selector specifying which fields to include in a partial response.
Dataflow.Projects.Jobs.Snapshot	setJobId(String jobId) The job to be snapshotted.
Dataflow.Projects.Jobs.Snapshot	setKey(String key) API key.
Dataflow.Projects.Jobs.Snapshot	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dataflow.Projects.Jobs.Snapshot	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dataflow.Projects.Jobs.Snapshot	setProjectId(String projectId) The project which owns the job to be snapshotted.
Dataflow.Projects.Jobs.Snapshot	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dataflow.Projects.Jobs.Snapshot	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dataflow.Projects.Jobs.Snapshot	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Snapshot

protected Snapshot(String projectId,
                   String jobId,
                   SnapshotJobRequest content)

Snapshot the state of a streaming job. Create a request for the method "jobs.snapshot". 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 project which owns the job to be snapshotted.

jobId - The job to be snapshotted.

content - the SnapshotJobRequest

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: DataflowRequest

V1 error format.

Overrides:

set$Xgafv in class DataflowRequest<Snapshot>

setAccessToken

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

Description copied from class: DataflowRequest

OAuth access token.

Overrides:

setAccessToken in class DataflowRequest<Snapshot>

setAlt

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

Description copied from class: DataflowRequest

Data format for response.

Overrides:

setAlt in class DataflowRequest<Snapshot>

setCallback

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

Description copied from class: DataflowRequest

JSONP

Overrides:

setCallback in class DataflowRequest<Snapshot>

setFields

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

Description copied from class: DataflowRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DataflowRequest<Snapshot>

setKey

public Dataflow.Projects.Jobs.Snapshot 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<Snapshot>

setOauthToken

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

Description copied from class: DataflowRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DataflowRequest<Snapshot>

setPrettyPrint

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

Description copied from class: DataflowRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DataflowRequest<Snapshot>

setQuotaUser

public Dataflow.Projects.Jobs.Snapshot 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<Snapshot>

setUploadType

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

Description copied from class: DataflowRequest

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

Overrides:

setUploadType in class DataflowRequest<Snapshot>

setUploadProtocol

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

Description copied from class: DataflowRequest

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

Overrides:

setUploadProtocol in class DataflowRequest<Snapshot>

getProjectId

public String getProjectId()

The project which owns the job to be snapshotted.

setProjectId

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

The project which owns the job to be snapshotted.

getJobId

public String getJobId()

The job to be snapshotted.

setJobId

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

The job to be snapshotted.

set

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

Overrides:

set in class DataflowRequest<Snapshot>