target.apidocs.com.google.api.services.bigquery.Bigquery.Jobs.Cancel.html Maven / Gradle / Ivy
Bigquery.Jobs.Cancel (BigQuery API v2-rev20240616-2.0.0)
com.google.api.services.bigquery
Class Bigquery.Jobs.Cancel
- 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<JobCancelResponse>
-
- com.google.api.services.bigquery.Bigquery.Jobs.Cancel
-
- 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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Cancel(String projectId,
String jobId)
Requests that a job be cancelled.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getJobId()
Required.
String
getLocation()
The geographic location of the job.
String
getProjectId()
Required.
Bigquery.Jobs.Cancel
set(String parameterName,
Object value)
Bigquery.Jobs.Cancel
set$Xgafv(String $Xgafv)
V1 error format.
Bigquery.Jobs.Cancel
setAccessToken(String accessToken)
OAuth access token.
Bigquery.Jobs.Cancel
setAlt(String alt)
Data format for response.
Bigquery.Jobs.Cancel
setCallback(String callback)
JSONP
Bigquery.Jobs.Cancel
setFields(String fields)
Selector specifying which fields to include in a partial response.
Bigquery.Jobs.Cancel
setJobId(String jobId)
Required.
Bigquery.Jobs.Cancel
setKey(String key)
API key.
Bigquery.Jobs.Cancel
setLocation(String location)
The geographic location of the job.
Bigquery.Jobs.Cancel
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Bigquery.Jobs.Cancel
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Bigquery.Jobs.Cancel
setProjectId(String projectId)
Required.
Bigquery.Jobs.Cancel
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Bigquery.Jobs.Cancel
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Bigquery.Jobs.Cancel
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, 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
-
Cancel
protected Cancel(String projectId,
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
-
set$Xgafv
public Bigquery.Jobs.Cancel set$Xgafv(String $Xgafv)
Description copied from class: BigqueryRequest
V1 error format.
- Overrides:
set$Xgafv
in class BigqueryRequest<JobCancelResponse>
-
setAccessToken
public Bigquery.Jobs.Cancel setAccessToken(String accessToken)
Description copied from class: BigqueryRequest
OAuth access token.
- Overrides:
setAccessToken
in class BigqueryRequest<JobCancelResponse>
-
setAlt
public Bigquery.Jobs.Cancel setAlt(String alt)
Description copied from class: BigqueryRequest
Data format for response.
- Overrides:
setAlt
in class BigqueryRequest<JobCancelResponse>
-
setCallback
public Bigquery.Jobs.Cancel setCallback(String callback)
Description copied from class: BigqueryRequest
JSONP
- Overrides:
setCallback
in class BigqueryRequest<JobCancelResponse>
-
setFields
public Bigquery.Jobs.Cancel setFields(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(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(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(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(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<JobCancelResponse>
-
setUploadType
public Bigquery.Jobs.Cancel setUploadType(String uploadType)
Description copied from class: BigqueryRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class BigqueryRequest<JobCancelResponse>
-
setUploadProtocol
public Bigquery.Jobs.Cancel setUploadProtocol(String uploadProtocol)
Description copied from class: BigqueryRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class BigqueryRequest<JobCancelResponse>
-
getProjectId
public String getProjectId()
Required. Project ID of the job to cancel
-
setProjectId
public Bigquery.Jobs.Cancel setProjectId(String projectId)
Required. Project ID of the job to cancel
-
getJobId
public String getJobId()
Required. Job ID of the job to cancel
-
setJobId
public Bigquery.Jobs.Cancel setJobId(String jobId)
Required. Job ID of the job to cancel
-
getLocation
public String getLocation()
The geographic location of the job. You must specify the location to run the job for the following
scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location -
If the job's location is in a single region (for example, `us-central1`) For more information, see
https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
-
setLocation
public Bigquery.Jobs.Cancel setLocation(String location)
The geographic location of the job. You must specify the location to run the job for the
following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-
regional location - If the job's location is in a single region (for example, `us-
central1`) For more information, see
https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
-
set
public Bigquery.Jobs.Cancel set(String parameterName,
Object value)
- Overrides:
set
in class BigqueryRequest<JobCancelResponse>
Copyright © 2011–2024 Google. All rights reserved.