• Home
• com.google.apis
• google-api-services-dataflow
• v1b3-rev20231112-2.0.0
• source code
• Dataflow.Projects.Locations.Jobs.WorkItems.Lease.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.dataflow.Dataflow.Projects.Locations.Jobs.WorkItems.Lease.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.dataflow
Class Dataflow.Projects.Locations.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.Projects.Locations.Jobs.WorkItems.Lease

















All Implemented Interfaces:
Cloneable, Map<String,Object>


Enclosing class:
Dataflow.Projects.Locations.Jobs.WorkItems




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











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
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 
Lease(String projectId,
     String location,
     String jobId,
     LeaseWorkItemRequest content)
Leases a dataflow WorkItem to run.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


String
getJobId()
Identifies the workflow job this worker belongs to.



String
getLocation()
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
           contains the WorkItem's job.



String
getProjectId()
Identifies the project this worker belongs to.



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


Dataflow.Projects.Locations.Jobs.WorkItems.Lease
set$Xgafv(String $Xgafv)
V1 error format.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setAccessToken(String accessToken)
OAuth access token.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setAlt(String alt)
Data format for response.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setCallback(String callback)
JSONP



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setFields(String fields)
Selector specifying which fields to include in a partial response.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setJobId(String jobId)
Identifies the workflow job this worker belongs to.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setKey(String key)
API key.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setLocation(String location)
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
 endpoints) that contains the WorkItem's job.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setProjectId(String projectId)
Identifies the project this worker belongs to.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



Dataflow.Projects.Locations.Jobs.WorkItems.Lease
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





Lease
protected Lease(String projectId,
                String location,
                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 - Identifies the project this worker belongs to.
location - The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
        contains the WorkItem's job.
jobId - Identifies the workflow job this worker belongs to.
content - the LeaseWorkItemRequest
Since:
1.13










Method Detail





set$Xgafv
public Dataflow.Projects.Locations.Jobs.WorkItems.Lease set$Xgafv(String $Xgafv)
Description copied from class: DataflowRequest
V1 error format.

Overrides:
set$Xgafv in class DataflowRequest<LeaseWorkItemResponse>








setAccessToken
public Dataflow.Projects.Locations.Jobs.WorkItems.Lease setAccessToken(String accessToken)
Description copied from class: DataflowRequest
OAuth access token.

Overrides:
setAccessToken in class DataflowRequest<LeaseWorkItemResponse>








setAlt
public Dataflow.Projects.Locations.Jobs.WorkItems.Lease setAlt(String alt)
Description copied from class: DataflowRequest
Data format for response.

Overrides:
setAlt in class DataflowRequest<LeaseWorkItemResponse>








setCallback
public Dataflow.Projects.Locations.Jobs.WorkItems.Lease setCallback(String callback)
Description copied from class: DataflowRequest
JSONP

Overrides:
setCallback in class DataflowRequest<LeaseWorkItemResponse>








setFields
public Dataflow.Projects.Locations.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.Projects.Locations.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.Projects.Locations.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.Projects.Locations.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.Projects.Locations.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:
setQuotaUser in class DataflowRequest<LeaseWorkItemResponse>








setUploadType
public Dataflow.Projects.Locations.Jobs.WorkItems.Lease setUploadType(String uploadType)
Description copied from class: DataflowRequest
Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:
setUploadType in class DataflowRequest<LeaseWorkItemResponse>








setUploadProtocol
public Dataflow.Projects.Locations.Jobs.WorkItems.Lease setUploadProtocol(String uploadProtocol)
Description copied from class: DataflowRequest
Upload protocol for media (e.g. "raw", "multipart").

Overrides:
setUploadProtocol in class DataflowRequest<LeaseWorkItemResponse>








getProjectId
public String getProjectId()
Identifies the project this worker belongs to.







setProjectId
public Dataflow.Projects.Locations.Jobs.WorkItems.Lease setProjectId(String projectId)
Identifies the project this worker belongs to.







getLocation
public String getLocation()
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
           contains the WorkItem's job.







setLocation
public Dataflow.Projects.Locations.Jobs.WorkItems.Lease setLocation(String location)
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
 endpoints) that contains the WorkItem's job.







getJobId
public String getJobId()
Identifies the workflow job this worker belongs to.







setJobId
public Dataflow.Projects.Locations.Jobs.WorkItems.Lease setJobId(String jobId)
Identifies the workflow job this worker belongs to.







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

Overrides:
set in class DataflowRequest<LeaseWorkItemResponse>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.