com.google.api.services.bigquery

Class Bigquery.Jobs.Cancel

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

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Bigquery.Jobs

public class Bigquery.Jobs.Cancel
extends BigqueryRequest<JobCancelResponse>

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.Cancel(java.lang.String projectId, java.lang.String jobId) Requests that a job be cancelled.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getJobId() [ Required] Job ID of the job to cancel [
java.lang.String	getProjectId() [ Required] Project ID of the job to cancel [
Bigquery.Jobs.Cancel	set(java.lang.String parameterName, java.lang.Object value)
Bigquery.Jobs.Cancel	setAlt(java.lang.String alt) Data format for the response.
Bigquery.Jobs.Cancel	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Bigquery.Jobs.Cancel	setJobId(java.lang.String jobId) [Required] Job ID of the job to cancel
Bigquery.Jobs.Cancel	setKey(java.lang.String key) API key.
Bigquery.Jobs.Cancel	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Bigquery.Jobs.Cancel	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Bigquery.Jobs.Cancel	setProjectId(java.lang.String projectId) [Required] Project ID of the job to cancel
Bigquery.Jobs.Cancel	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Bigquery.Jobs.Cancel	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, 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

Bigquery.Jobs.Cancel

protected Bigquery.Jobs.Cancel(java.lang.String projectId,
                    java.lang.String jobId)

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. Create a request for the method "jobs.cancel". 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 - [Required] Project ID of the job to cancel

jobId - [Required] Job ID of the job to cancel

Since:

1.13

Method Detail

setAlt

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

Description copied from class: BigqueryRequest

Data format for the response.

Overrides:

setAlt in class BigqueryRequest<JobCancelResponse>

setFields

public Bigquery.Jobs.Cancel 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<JobCancelResponse>

setKey

public Bigquery.Jobs.Cancel 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<JobCancelResponse>

setOauthToken

public Bigquery.Jobs.Cancel setOauthToken(java.lang.String oauthToken)

Description copied from class: BigqueryRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class BigqueryRequest<JobCancelResponse>

setPrettyPrint

public Bigquery.Jobs.Cancel setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: BigqueryRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class BigqueryRequest<JobCancelResponse>

setQuotaUser

public Bigquery.Jobs.Cancel 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<JobCancelResponse>

setUserIp

public Bigquery.Jobs.Cancel 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<JobCancelResponse>

getProjectId

public java.lang.String getProjectId()

[ Required] Project ID of the job to cancel [

setProjectId

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

[Required] Project ID of the job to cancel

getJobId

public java.lang.String getJobId()

[ Required] Job ID of the job to cancel [

setJobId

public Bigquery.Jobs.Cancel setJobId(java.lang.String jobId)

[Required] Job ID of the job to cancel

set

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

Overrides:

set in class BigqueryRequest<JobCancelResponse>