com.google.api.services.dataflow

Class Dataflow.V1b3.Projects.Jobs.WorkItems.Lease

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

com.google.api.services.dataflow.Dataflow.V1b3.Projects.Jobs.WorkItems.Lease

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dataflow.V1b3.Projects.Jobs.WorkItems

public class Dataflow.V1b3.Projects.Jobs.WorkItems.Lease
extends DataflowRequest<LeaseWorkItemResponse>

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

Modifier	Constructor and Description
protected	Dataflow.V1b3.Projects.Jobs.WorkItems.Lease(String projectId, String jobId, LeaseWorkItemRequest content) Leases a dataflow WorkItem to run.

Method Summary

Methods

Modifier and Type	Method and Description
String	getJobId()
String	getProjectId()
Dataflow.V1b3.Projects.Jobs.WorkItems.Lease	set(String parameterName, Object value)
Dataflow.V1b3.Projects.Jobs.WorkItems.Lease	setAlt(String alt) Data format for the response.
Dataflow.V1b3.Projects.Jobs.WorkItems.Lease	setFields(String fields) Selector specifying which fields to include in a partial response.
Dataflow.V1b3.Projects.Jobs.WorkItems.Lease	setJobId(String jobId)
Dataflow.V1b3.Projects.Jobs.WorkItems.Lease	setKey(String key) API key.
Dataflow.V1b3.Projects.Jobs.WorkItems.Lease	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dataflow.V1b3.Projects.Jobs.WorkItems.Lease	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dataflow.V1b3.Projects.Jobs.WorkItems.Lease	setProjectId(String projectId)
Dataflow.V1b3.Projects.Jobs.WorkItems.Lease	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dataflow.V1b3.Projects.Jobs.WorkItems.Lease	setUserIp(String userIp) IP address of the site where the request originates.

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

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Dataflow.V1b3.Projects.Jobs.WorkItems.Lease

protected Dataflow.V1b3.Projects.Jobs.WorkItems.Lease(String projectId,
                                           String jobId,
                                           LeaseWorkItemRequest content)

Leases a dataflow WorkItem to run. Create a request for the method "workItems.lease". 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 -

jobId -

content - the LeaseWorkItemRequest

Since:

1.13

Method Detail

setAlt

public Dataflow.V1b3.Projects.Jobs.WorkItems.Lease setAlt(String alt)

Description copied from class: DataflowRequest

Data format for the response.

Overrides:

setAlt in class DataflowRequest<LeaseWorkItemResponse>

setFields

public Dataflow.V1b3.Projects.Jobs.WorkItems.Lease setFields(String fields)

Description copied from class: DataflowRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DataflowRequest<LeaseWorkItemResponse>

setKey

public Dataflow.V1b3.Projects.Jobs.WorkItems.Lease 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<LeaseWorkItemResponse>

setOauthToken

public Dataflow.V1b3.Projects.Jobs.WorkItems.Lease setOauthToken(String oauthToken)

Description copied from class: DataflowRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DataflowRequest<LeaseWorkItemResponse>

setPrettyPrint

public Dataflow.V1b3.Projects.Jobs.WorkItems.Lease setPrettyPrint(Boolean prettyPrint)

Description copied from class: DataflowRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DataflowRequest<LeaseWorkItemResponse>

setQuotaUser

public Dataflow.V1b3.Projects.Jobs.WorkItems.Lease 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 userIp if both are provided.

Overrides:

setQuotaUser in class DataflowRequest<LeaseWorkItemResponse>

setUserIp

public Dataflow.V1b3.Projects.Jobs.WorkItems.Lease setUserIp(String userIp)

Description copied from class: DataflowRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DataflowRequest<LeaseWorkItemResponse>

getProjectId

public String getProjectId()

setProjectId

public Dataflow.V1b3.Projects.Jobs.WorkItems.Lease setProjectId(String projectId)

getJobId

public String getJobId()

setJobId

public Dataflow.V1b3.Projects.Jobs.WorkItems.Lease setJobId(String jobId)

set

public Dataflow.V1b3.Projects.Jobs.WorkItems.Lease set(String parameterName,
                                              Object value)

Overrides:

set in class DataflowRequest<LeaseWorkItemResponse>