target.apidocs.com.google.api.services.bigquery.Bigquery.Jobs.GetQueryResults.html Maven / Gradle / Ivy
Bigquery.Jobs.GetQueryResults (BigQuery API v2-rev20240919-2.0.0)
com.google.api.services.bigquery
Class Bigquery.Jobs.GetQueryResults
- 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<GetQueryResultsResponse>
-
- com.google.api.services.bigquery.Bigquery.Jobs.GetQueryResults
-
- Enclosing class:
- Bigquery.Jobs
public class Bigquery.Jobs.GetQueryResults
extends BigqueryRequest<GetQueryResultsResponse>
-
-
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 GetQueryResults(String projectId,
String jobId)
RPC to get the results of a query job.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
com.google.api.client.http.HttpRequestbuildHttpRequestUsingHead()
com.google.api.client.http.HttpResponseexecuteUsingHead()
BooleangetFormatOptionsUseInt64Timestamp()
Optional.
StringgetJobId()
Required.
StringgetLocation()
The geographic location of the job.
LonggetMaxResults()
Maximum number of results to read.
StringgetPageToken()
Page token, returned by a previous call, to request the next page of results.
StringgetProjectId()
Required.
BigIntegergetStartIndex()
Zero-based index of the starting row.
LonggetTimeoutMs()
Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait
for the query to complete.
Bigquery.Jobs.GetQueryResultsset(String parameterName,
Object value)
Bigquery.Jobs.GetQueryResultsset$Xgafv(String $Xgafv)
V1 error format.
Bigquery.Jobs.GetQueryResultssetAccessToken(String accessToken)
OAuth access token.
Bigquery.Jobs.GetQueryResultssetAlt(String alt)
Data format for response.
Bigquery.Jobs.GetQueryResultssetCallback(String callback)
JSONP
Bigquery.Jobs.GetQueryResultssetFields(String fields)
Selector specifying which fields to include in a partial response.
Bigquery.Jobs.GetQueryResultssetFormatOptionsUseInt64Timestamp(Boolean formatOptionsUseInt64Timestamp)
Optional.
Bigquery.Jobs.GetQueryResultssetJobId(String jobId)
Required.
Bigquery.Jobs.GetQueryResultssetKey(String key)
API key.
Bigquery.Jobs.GetQueryResultssetLocation(String location)
The geographic location of the job.
Bigquery.Jobs.GetQueryResultssetMaxResults(Long maxResults)
Maximum number of results to read.
Bigquery.Jobs.GetQueryResultssetOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Bigquery.Jobs.GetQueryResultssetPageToken(String pageToken)
Page token, returned by a previous call, to request the next page of results.
Bigquery.Jobs.GetQueryResultssetPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Bigquery.Jobs.GetQueryResultssetProjectId(String projectId)
Required.
Bigquery.Jobs.GetQueryResultssetQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Bigquery.Jobs.GetQueryResultssetStartIndex(BigInteger startIndex)
Zero-based index of the starting row.
Bigquery.Jobs.GetQueryResultssetTimeoutMs(Long timeoutMs)
Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing
to wait for the query to complete.
Bigquery.Jobs.GetQueryResultssetUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Bigquery.Jobs.GetQueryResultssetUploadType(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
-
GetQueryResults
protected GetQueryResults(String projectId,
String jobId)
RPC to get the results of a query job.
Create a request for the method "jobs.getQueryResults".
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. GetQueryResults#initialize(com.google.api.client.googleapis.services.Abst
ractGoogleClientRequest) must be called to initialize this instance immediately after invoking
the constructor.
- Parameters:
projectId - Required. Project ID of the query job.jobId - Required. Job ID of the query 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<GetQueryResultsResponse>- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GetQueryResultsResponse>- Throws:
IOException
-
set$Xgafv
public Bigquery.Jobs.GetQueryResults set$Xgafv(String $Xgafv)
Description copied from class: BigqueryRequest
V1 error format.
- Overrides:
set$Xgafv in class BigqueryRequest<GetQueryResultsResponse>
-
setAccessToken
public Bigquery.Jobs.GetQueryResults setAccessToken(String accessToken)
Description copied from class: BigqueryRequest
OAuth access token.
- Overrides:
setAccessToken in class BigqueryRequest<GetQueryResultsResponse>
-
setAlt
public Bigquery.Jobs.GetQueryResults setAlt(String alt)
Description copied from class: BigqueryRequest
Data format for response.
- Overrides:
setAlt in class BigqueryRequest<GetQueryResultsResponse>
-
setCallback
public Bigquery.Jobs.GetQueryResults setCallback(String callback)
Description copied from class: BigqueryRequest
JSONP
- Overrides:
setCallback in class BigqueryRequest<GetQueryResultsResponse>
-
setFields
public Bigquery.Jobs.GetQueryResults setFields(String fields)
Description copied from class: BigqueryRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class BigqueryRequest<GetQueryResultsResponse>
-
setKey
public Bigquery.Jobs.GetQueryResults 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<GetQueryResultsResponse>
-
setOauthToken
public Bigquery.Jobs.GetQueryResults setOauthToken(String oauthToken)
Description copied from class: BigqueryRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class BigqueryRequest<GetQueryResultsResponse>
-
setPrettyPrint
public Bigquery.Jobs.GetQueryResults setPrettyPrint(Boolean prettyPrint)
Description copied from class: BigqueryRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class BigqueryRequest<GetQueryResultsResponse>
-
setQuotaUser
public Bigquery.Jobs.GetQueryResults 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<GetQueryResultsResponse>
-
setUploadType
public Bigquery.Jobs.GetQueryResults setUploadType(String uploadType)
Description copied from class: BigqueryRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class BigqueryRequest<GetQueryResultsResponse>
-
setUploadProtocol
public Bigquery.Jobs.GetQueryResults setUploadProtocol(String uploadProtocol)
Description copied from class: BigqueryRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class BigqueryRequest<GetQueryResultsResponse>
-
getProjectId
public String getProjectId()
Required. Project ID of the query job.
-
setProjectId
public Bigquery.Jobs.GetQueryResults setProjectId(String projectId)
Required. Project ID of the query job.
-
getJobId
public String getJobId()
Required. Job ID of the query job.
-
setJobId
public Bigquery.Jobs.GetQueryResults setJobId(String jobId)
Required. Job ID of the query job.
-
getFormatOptionsUseInt64Timestamp
public Boolean getFormatOptionsUseInt64Timestamp()
Optional. Output timestamp as usec int64. Default is false.
-
setFormatOptionsUseInt64Timestamp
public Bigquery.Jobs.GetQueryResults setFormatOptionsUseInt64Timestamp(Boolean formatOptionsUseInt64Timestamp)
Optional. Output timestamp as usec int64. Default is false.
-
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.GetQueryResults 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.
-
getMaxResults
public Long getMaxResults()
Maximum number of results to read.
-
setMaxResults
public Bigquery.Jobs.GetQueryResults setMaxResults(Long maxResults)
Maximum number of results to read.
-
getPageToken
public String getPageToken()
Page token, returned by a previous call, to request the next page of results.
-
setPageToken
public Bigquery.Jobs.GetQueryResults setPageToken(String pageToken)
Page token, returned by a previous call, to request the next page of results.
-
getStartIndex
public BigInteger getStartIndex()
Zero-based index of the starting row.
-
setStartIndex
public Bigquery.Jobs.GetQueryResults setStartIndex(BigInteger startIndex)
Zero-based index of the starting row.
-
getTimeoutMs
public Long getTimeoutMs()
Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait
for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query
is complete, the jobComplete field in the response is true. If the query has not yet completed,
jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the
call is not guaranteed to wait for the specified timeout; it typically returns after around 200
seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can
continue to wait for the query to complete by calling the getQueryResults method until the
jobComplete field in the getQueryResults response is true.
-
setTimeoutMs
public Bigquery.Jobs.GetQueryResults setTimeoutMs(Long timeoutMs)
Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing
to wait for the query to complete. By default, this limit is 10 seconds (10,000
milliseconds). If the query is complete, the jobComplete field in the response is true. If
the query has not yet completed, jobComplete is false. You can request a longer timeout
period in the timeoutMs field. However, the call is not guaranteed to wait for the
specified timeout; it typically returns after around 200 seconds (200,000 milliseconds),
even if the query is not complete. If jobComplete is false, you can continue to wait for
the query to complete by calling the getQueryResults method until the jobComplete field in
the getQueryResults response is true.
-
set
public Bigquery.Jobs.GetQueryResults set(String parameterName,
Object value)
- Overrides:
set in class BigqueryRequest<GetQueryResultsResponse>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy