com.google.api.services.bigquery

Class Bigquery.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.bigquery.BigqueryRequest<JobList>

com.google.api.services.bigquery.Bigquery.Jobs.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Bigquery.Jobs

public class Bigquery.Jobs.List
extends BigqueryRequest<JobList>

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) Lists all jobs that you started in the specified project.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Boolean	getAllUsers() Whether to display jobs owned by all users in the project.
BigInteger	getMaxCreationTime() Max value for job creation time, in milliseconds since the POSIX epoch.
Long	getMaxResults() The maximum number of results to return in a single response page.
BigInteger	getMinCreationTime() Min value for job creation time, in milliseconds since the POSIX epoch.
String	getPageToken() Page token, returned by a previous call, to request the next page of results.
String	getParentJobId() If set, show only child jobs of the specified parent.
String	getProjectId() Project ID of the jobs to list.
String	getProjection() Restrict information returned to a set of selected fields
List<String>	getStateFilter() Filter for job state
Bigquery.Jobs.List	set(String parameterName, Object value)
Bigquery.Jobs.List	set$Xgafv(String $Xgafv) V1 error format.
Bigquery.Jobs.List	setAccessToken(String accessToken) OAuth access token.
Bigquery.Jobs.List	setAllUsers(Boolean allUsers) Whether to display jobs owned by all users in the project.
Bigquery.Jobs.List	setAlt(String alt) Data format for response.
Bigquery.Jobs.List	setCallback(String callback) JSONP
Bigquery.Jobs.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Bigquery.Jobs.List	setKey(String key) API key.
Bigquery.Jobs.List	setMaxCreationTime(BigInteger maxCreationTime) Max value for job creation time, in milliseconds since the POSIX epoch.
Bigquery.Jobs.List	setMaxResults(Long maxResults) The maximum number of results to return in a single response page.
Bigquery.Jobs.List	setMinCreationTime(BigInteger minCreationTime) Min value for job creation time, in milliseconds since the POSIX epoch.
Bigquery.Jobs.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Bigquery.Jobs.List	setPageToken(String pageToken) Page token, returned by a previous call, to request the next page of results.
Bigquery.Jobs.List	setParentJobId(String parentJobId) If set, show only child jobs of the specified parent.
Bigquery.Jobs.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Bigquery.Jobs.List	setProjectId(String projectId) Project ID of the jobs to list.
Bigquery.Jobs.List	setProjection(String projection) Restrict information returned to a set of selected fields
Bigquery.Jobs.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Bigquery.Jobs.List	setStateFilter(List<String> stateFilter) Filter for job state
Bigquery.Jobs.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Bigquery.Jobs.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.bigquery.BigqueryRequest

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)

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. Create a request for the method "jobs.list". This request holds the parameters needed by the the bigquery server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

projectId - Project ID of the jobs to list.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public Bigquery.Jobs.List set$Xgafv(String $Xgafv)

Description copied from class: BigqueryRequest

V1 error format.

Overrides:

set$Xgafv in class BigqueryRequest<JobList>

setAccessToken

public Bigquery.Jobs.List setAccessToken(String accessToken)

Description copied from class: BigqueryRequest

OAuth access token.

Overrides:

setAccessToken in class BigqueryRequest<JobList>

setAlt

public Bigquery.Jobs.List setAlt(String alt)

Description copied from class: BigqueryRequest

Data format for response.

Overrides:

setAlt in class BigqueryRequest<JobList>

setCallback

public Bigquery.Jobs.List setCallback(String callback)

Description copied from class: BigqueryRequest

JSONP

Overrides:

setCallback in class BigqueryRequest<JobList>

setFields

public Bigquery.Jobs.List setFields(String fields)

Description copied from class: BigqueryRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class BigqueryRequest<JobList>

setKey

public Bigquery.Jobs.List setKey(String key)

Description copied from class: BigqueryRequest

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 BigqueryRequest<JobList>

setOauthToken

public Bigquery.Jobs.List setOauthToken(String oauthToken)

Description copied from class: BigqueryRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class BigqueryRequest<JobList>

setPrettyPrint

public Bigquery.Jobs.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: BigqueryRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class BigqueryRequest<JobList>

setQuotaUser

public Bigquery.Jobs.List setQuotaUser(String quotaUser)

Description copied from class: BigqueryRequest

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 BigqueryRequest<JobList>

setUploadType

public Bigquery.Jobs.List setUploadType(String uploadType)

Description copied from class: BigqueryRequest

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

Overrides:

setUploadType in class BigqueryRequest<JobList>

setUploadProtocol

public Bigquery.Jobs.List setUploadProtocol(String uploadProtocol)

Description copied from class: BigqueryRequest

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

Overrides:

setUploadProtocol in class BigqueryRequest<JobList>

getProjectId

public String getProjectId()

Project ID of the jobs to list.

setProjectId

public Bigquery.Jobs.List setProjectId(String projectId)

Project ID of the jobs to list.

getAllUsers

public Boolean getAllUsers()

Whether to display jobs owned by all users in the project. Default False.

setAllUsers

public Bigquery.Jobs.List setAllUsers(Boolean allUsers)

Whether to display jobs owned by all users in the project. Default False.

getMaxCreationTime

public BigInteger getMaxCreationTime()

Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned.

setMaxCreationTime

public Bigquery.Jobs.List setMaxCreationTime(BigInteger maxCreationTime)

Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned.

getMaxResults

public Long getMaxResults()

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

setMaxResults

public Bigquery.Jobs.List setMaxResults(Long maxResults)

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

getMinCreationTime

public BigInteger getMinCreationTime()

Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned.

setMinCreationTime

public Bigquery.Jobs.List setMinCreationTime(BigInteger minCreationTime)

Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned.

getPageToken

public String getPageToken()

Page token, returned by a previous call, to request the next page of results.

setPageToken

public Bigquery.Jobs.List setPageToken(String pageToken)

Page token, returned by a previous call, to request the next page of results.

getParentJobId

public String getParentJobId()

If set, show only child jobs of the specified parent. Otherwise, show all top-level jobs.

setParentJobId

public Bigquery.Jobs.List setParentJobId(String parentJobId)

If set, show only child jobs of the specified parent. Otherwise, show all top-level jobs.

getProjection

public String getProjection()

Restrict information returned to a set of selected fields

setProjection

public Bigquery.Jobs.List setProjection(String projection)

Restrict information returned to a set of selected fields

getStateFilter

public List<String> getStateFilter()

Filter for job state

setStateFilter

public Bigquery.Jobs.List setStateFilter(List<String> stateFilter)

Filter for job state

set

public Bigquery.Jobs.List set(String parameterName,
                              Object value)

Overrides:

set in class BigqueryRequest<JobList>