com.google.api.services.dataflow

Class Dataflow.Projects.Locations.Jobs.List

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

com.google.api.services.dataflow.Dataflow.Projects.Locations.Jobs.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dataflow.Projects.Locations.Jobs

public class Dataflow.Projects.Locations.Jobs.List
extends DataflowRequest<ListJobsResponse>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(String projectId, String location) List the jobs of a project.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getFilter() The kind of filter to use.
String	getLocation() The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
String	getName() Optional.
Integer	getPageSize() If there are many jobs, limit response to at most this many.
String	getPageToken() Set this to the 'next_page_token' field of a previous response to request additional results in a long list.
String	getProjectId() The project which owns the jobs.
String	getView() Deprecated.
Dataflow.Projects.Locations.Jobs.List	set(String parameterName, Object value)
Dataflow.Projects.Locations.Jobs.List	set$Xgafv(String $Xgafv) V1 error format.
Dataflow.Projects.Locations.Jobs.List	setAccessToken(String accessToken) OAuth access token.
Dataflow.Projects.Locations.Jobs.List	setAlt(String alt) Data format for response.
Dataflow.Projects.Locations.Jobs.List	setCallback(String callback) JSONP
Dataflow.Projects.Locations.Jobs.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Dataflow.Projects.Locations.Jobs.List	setFilter(String filter) The kind of filter to use.
Dataflow.Projects.Locations.Jobs.List	setKey(String key) API key.
Dataflow.Projects.Locations.Jobs.List	setLocation(String location) The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints) that contains this job.
Dataflow.Projects.Locations.Jobs.List	setName(String name) Optional.
Dataflow.Projects.Locations.Jobs.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dataflow.Projects.Locations.Jobs.List	setPageSize(Integer pageSize) If there are many jobs, limit response to at most this many.
Dataflow.Projects.Locations.Jobs.List	setPageToken(String pageToken) Set this to the 'next_page_token' field of a previous response to request additional results in a long list.
Dataflow.Projects.Locations.Jobs.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dataflow.Projects.Locations.Jobs.List	setProjectId(String projectId) The project which owns the jobs.
Dataflow.Projects.Locations.Jobs.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dataflow.Projects.Locations.Jobs.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dataflow.Projects.Locations.Jobs.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Dataflow.Projects.Locations.Jobs.List	setView(String view) Deprecated.

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

List

protected List(String projectId,
               String location)

List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. Create a request for the method "jobs.list". 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 jobs.

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

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListJobsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListJobsResponse>

Throws:

IOException

set$Xgafv

public Dataflow.Projects.Locations.Jobs.List set$Xgafv(String $Xgafv)

Description copied from class: DataflowRequest

V1 error format.

Overrides:

set$Xgafv in class DataflowRequest<ListJobsResponse>

setAccessToken

public Dataflow.Projects.Locations.Jobs.List setAccessToken(String accessToken)

Description copied from class: DataflowRequest

OAuth access token.

Overrides:

setAccessToken in class DataflowRequest<ListJobsResponse>

setAlt

public Dataflow.Projects.Locations.Jobs.List setAlt(String alt)

Description copied from class: DataflowRequest

Data format for response.

Overrides:

setAlt in class DataflowRequest<ListJobsResponse>

setCallback

public Dataflow.Projects.Locations.Jobs.List setCallback(String callback)

Description copied from class: DataflowRequest

JSONP

Overrides:

setCallback in class DataflowRequest<ListJobsResponse>

setFields

public Dataflow.Projects.Locations.Jobs.List setFields(String fields)

Description copied from class: DataflowRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DataflowRequest<ListJobsResponse>

setKey

public Dataflow.Projects.Locations.Jobs.List 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<ListJobsResponse>

setOauthToken

public Dataflow.Projects.Locations.Jobs.List setOauthToken(String oauthToken)

Description copied from class: DataflowRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DataflowRequest<ListJobsResponse>

setPrettyPrint

public Dataflow.Projects.Locations.Jobs.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DataflowRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DataflowRequest<ListJobsResponse>

setQuotaUser

public Dataflow.Projects.Locations.Jobs.List 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<ListJobsResponse>

setUploadType

public Dataflow.Projects.Locations.Jobs.List setUploadType(String uploadType)

Description copied from class: DataflowRequest

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

Overrides:

setUploadType in class DataflowRequest<ListJobsResponse>

setUploadProtocol

public Dataflow.Projects.Locations.Jobs.List setUploadProtocol(String uploadProtocol)

Description copied from class: DataflowRequest

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

Overrides:

setUploadProtocol in class DataflowRequest<ListJobsResponse>

getProjectId

public String getProjectId()

The project which owns the jobs.

setProjectId

public Dataflow.Projects.Locations.Jobs.List setProjectId(String projectId)

The project which owns the jobs.

getLocation

public String getLocation()

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

setLocation

public Dataflow.Projects.Locations.Jobs.List setLocation(String location)

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

getFilter

public String getFilter()

The kind of filter to use.

setFilter

public Dataflow.Projects.Locations.Jobs.List setFilter(String filter)

The kind of filter to use.

getName

public String getName()

Optional. The job name.

setName

public Dataflow.Projects.Locations.Jobs.List setName(String name)

Optional. The job name.

getPageSize

public Integer getPageSize()

If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.

setPageSize

public Dataflow.Projects.Locations.Jobs.List setPageSize(Integer pageSize)

If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.

getPageToken

public String getPageToken()

Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

setPageToken

public Dataflow.Projects.Locations.Jobs.List setPageToken(String pageToken)

Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

getView

public String getView()

Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.

setView

public Dataflow.Projects.Locations.Jobs.List setView(String view)

Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.

set

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

Overrides:

set in class DataflowRequest<ListJobsResponse>