BigQuery API v2 (revision 81)



com.google.api.services.bigquery
Class Bigquery.Jobs.Get

java.lang.Object
  extended by java.util.AbstractMap<String,Object>
      extended by com.google.api.client.util.GenericData
          extended by com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
              extended by com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
                  extended by com.google.api.services.bigquery.BigqueryRequest<Job>
                      extended by com.google.api.services.bigquery.Bigquery.Jobs.Get
All Implemented Interfaces:
Cloneable, Map<String,Object>
Enclosing class:
Bigquery.Jobs

public class Bigquery.Jobs.Get
extends BigqueryRequest<Job>


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
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>
 
Constructor Summary
protected Bigquery.Jobs.Get(String projectId, String jobId)
          Retrieves the specified job by ID.
 
Method Summary
 HttpRequest buildHttpRequestUsingHead()
           
 HttpResponse executeMedia()
           
 void executeMediaAndDownloadTo(OutputStream outputStream)
          Upgrade warning: in prior version 1.8 this method was called download.
 InputStream executeMediaAsInputStream()
           
 HttpResponse executeUsingHead()
           
 String getJobId()
          Job ID of the requested job
 String getProjectId()
          Project ID of the requested job
 Bigquery.Jobs.Get setAlt(String alt)
          Data format for the response.
 Bigquery.Jobs.Get setFields(String fields)
          Selector specifying which fields to include in a partial response.
 Bigquery.Jobs.Get setJobId(String jobId)
          Job ID of the requested job
 Bigquery.Jobs.Get setKey(String key)
          API key.
 Bigquery.Jobs.Get setOauthToken(String oauthToken)
          OAuth 2.0 token for the current user.
 Bigquery.Jobs.Get setPrettyPrint(Boolean prettyPrint)
          Returns response with indentations and line breaks.
 Bigquery.Jobs.Get setProjectId(String projectId)
          Project ID of the requested job
 Bigquery.Jobs.Get setQuotaUser(String quotaUser)
          Available to use for quota purposes for server-side applications.
 Bigquery.Jobs.Get setUserIp(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, execute, executeAndDownloadTo, executeAsInputStream, 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, set, 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.Get

protected Bigquery.Jobs.Get(String projectId,
                            String jobId)
Retrieves the specified job by ID. Create a request for the method "jobs.get". 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(AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:
projectId - Project ID of the requested job
jobId - Job ID of the requested job
Since:
1.13
Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException
Upgrade warning: in prior version 1.8 this method was called download.

Overrides:
executeMediaAndDownloadTo in class AbstractGoogleClientRequest<Job>
Throws:
IOException

executeMediaAsInputStream

public InputStream executeMediaAsInputStream()
                                      throws IOException
Overrides:
executeMediaAsInputStream in class AbstractGoogleClientRequest<Job>
Throws:
IOException

executeMedia

public HttpResponse executeMedia()
                          throws IOException
Overrides:
executeMedia in class AbstractGoogleClientRequest<Job>
Throws:
IOException

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException
Overrides:
executeUsingHead in class AbstractGoogleClientRequest<Job>
Throws:
IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
Overrides:
buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Job>
Throws:
IOException

setAlt

public Bigquery.Jobs.Get setAlt(String alt)
Description copied from class: BigqueryRequest
Data format for the response.

Overrides:
setAlt in class BigqueryRequest<Job>

setFields

public Bigquery.Jobs.Get setFields(String fields)
Description copied from class: BigqueryRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class BigqueryRequest<Job>

setKey

public Bigquery.Jobs.Get 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<Job>

setOauthToken

public Bigquery.Jobs.Get setOauthToken(String oauthToken)
Description copied from class: BigqueryRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class BigqueryRequest<Job>

setPrettyPrint

public Bigquery.Jobs.Get setPrettyPrint(Boolean prettyPrint)
Description copied from class: BigqueryRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class BigqueryRequest<Job>

setQuotaUser

public Bigquery.Jobs.Get 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 userIp if both are provided.

Overrides:
setQuotaUser in class BigqueryRequest<Job>

setUserIp

public Bigquery.Jobs.Get setUserIp(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<Job>

getProjectId

public String getProjectId()
Project ID of the requested job


setProjectId

public Bigquery.Jobs.Get setProjectId(String projectId)
Project ID of the requested job


getJobId

public String getJobId()
Job ID of the requested job


setJobId

public Bigquery.Jobs.Get setJobId(String jobId)
Job ID of the requested job