com.google.api.services.bigquery

Class Bigquery.Jobs.List

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.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	Bigquery.Jobs.List(java.lang.String projectId) Lists all jobs that you started in the specified project.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.Boolean	getAllUsers() Whether to display jobs owned by all users in the project.
java.lang.Long	getMaxResults() Maximum number of results to return
java.lang.String	getPageToken() Page token, returned by a previous call, to request the next page of results
java.lang.String	getProjectId() Project ID of the jobs to list
java.lang.String	getProjection() Restrict information returned to a set of selected fields
java.util.List<java.lang.String>	getStateFilter() Filter for job state
Bigquery.Jobs.List	set(java.lang.String parameterName, java.lang.Object value)
Bigquery.Jobs.List	setAllUsers(java.lang.Boolean allUsers) Whether to display jobs owned by all users in the project.
Bigquery.Jobs.List	setAlt(java.lang.String alt) Data format for the response.
Bigquery.Jobs.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Bigquery.Jobs.List	setKey(java.lang.String key) API key.
Bigquery.Jobs.List	setMaxResults(java.lang.Long maxResults) Maximum number of results to return
Bigquery.Jobs.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Bigquery.Jobs.List	setPageToken(java.lang.String pageToken) Page token, returned by a previous call, to request the next page of results
Bigquery.Jobs.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Bigquery.Jobs.List	setProjectId(java.lang.String projectId) Project ID of the jobs to list
Bigquery.Jobs.List	setProjection(java.lang.String projection) Restrict information returned to a set of selected fields
Bigquery.Jobs.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Bigquery.Jobs.List	setStateFilter(java.util.List<java.lang.String> stateFilter) Filter for job state
Bigquery.Jobs.List	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

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

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

Bigquery.Jobs.List

protected Bigquery.Jobs.List(java.lang.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 java.io.IOException

Overrides:

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

Throws:

java.io.IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

java.io.IOException

setAlt

public Bigquery.Jobs.List setAlt(java.lang.String alt)

Description copied from class: BigqueryRequest

Data format for the response.

Overrides:

setAlt in class BigqueryRequest<JobList>

setFields

public Bigquery.Jobs.List setFields(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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 userIp if both are provided.

Overrides:

setQuotaUser in class BigqueryRequest<JobList>

setUserIp

public Bigquery.Jobs.List setUserIp(java.lang.String userIp)

Description copied from class: BigqueryRequest

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

Overrides:

setUserIp in class BigqueryRequest<JobList>

getProjectId

public java.lang.String getProjectId()

Project ID of the jobs to list

setProjectId

public Bigquery.Jobs.List setProjectId(java.lang.String projectId)

Project ID of the jobs to list

getAllUsers

public java.lang.Boolean getAllUsers()

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

setAllUsers

public Bigquery.Jobs.List setAllUsers(java.lang.Boolean allUsers)

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

getMaxResults

public java.lang.Long getMaxResults()

Maximum number of results to return

setMaxResults

public Bigquery.Jobs.List setMaxResults(java.lang.Long maxResults)

Maximum number of results to return

getPageToken

public java.lang.String getPageToken()

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

setPageToken

public Bigquery.Jobs.List setPageToken(java.lang.String pageToken)

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

getProjection

public java.lang.String getProjection()

Restrict information returned to a set of selected fields

setProjection

public Bigquery.Jobs.List setProjection(java.lang.String projection)

Restrict information returned to a set of selected fields

getStateFilter

public java.util.List<java.lang.String> getStateFilter()

Filter for job state

setStateFilter

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

Filter for job state

set

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

Overrides:

set in class BigqueryRequest<JobList>