target.apidocs.com.google.api.services.bigquery.Bigquery.Jobs.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-bigquery Show documentation

There is a newer version: v2-rev20241027-2.0.0

Show newest version







Bigquery.Jobs (BigQuery API v2-rev20240727-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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



java.lang.Object


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







Enclosing class:
Bigquery




public class Bigquery.Jobs
extends Object
The "jobs" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Bigquery.Jobs.Cancel 


class 
Bigquery.Jobs.Delete 


class 
Bigquery.Jobs.Get 


class 
Bigquery.Jobs.GetQueryResults 


class 
Bigquery.Jobs.Insert 


class 
Bigquery.Jobs.List 


class 
Bigquery.Jobs.Query 









Constructor Summary

Constructors 

Constructor and Description


Jobs() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Bigquery.Jobs.Cancel
cancel(String projectId,
      String jobId)
Requests that a job be cancelled.



Bigquery.Jobs.Delete
delete(String projectId,
      String jobId)
Requests the deletion of the metadata of a job.



Bigquery.Jobs.Get
get(String projectId,
   String jobId)
Returns information about a specific job.



Bigquery.Jobs.GetQueryResults
getQueryResults(String projectId,
               String jobId)
RPC to get the results of a query job.



Bigquery.Jobs.Insert
insert(String projectId,
      Job content)
Starts a new asynchronous job.



Bigquery.Jobs.Insert
insert(String projectId,
      Job content,
      com.google.api.client.http.AbstractInputStreamContent mediaContent)
Starts a new asynchronous job.



Bigquery.Jobs.List
list(String projectId)
Lists all jobs that you started in the specified project.



Bigquery.Jobs.Query
query(String projectId,
     QueryRequest content)
Runs a BigQuery SQL query synchronously and returns query results if the query completes within a
 specified timeout.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Jobs
public Jobs()









Method Detail





cancel
public Bigquery.Jobs.Cancel cancel(String projectId,
                                   String jobId)
                            throws IOException
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 bigquery server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. Project ID of the job to cancel
jobId - Required. Job ID of the job to cancel
Returns:
the request
Throws:
IOException








delete
public Bigquery.Jobs.Delete delete(String projectId,
                                   String jobId)
                            throws IOException
Requests the deletion of the metadata of a job. This call returns when the job's metadata is
 deleted.

 Create a request for the method "jobs.delete".

 This request holds the parameters needed by the bigquery server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. Project ID of the job for which metadata is to be deleted.
jobId - Required. Job ID of the job for which metadata is to be deleted. If this is a parent job which has
        child jobs, the metadata from all child jobs will be deleted as well. Direct deletion of
        the metadata of child jobs is not allowed.
Returns:
the request
Throws:
IOException








get
public Bigquery.Jobs.Get get(String projectId,
                             String jobId)
                      throws IOException
Returns information about a specific job. Job information is available for a six month period
 after creation. Requires that you're the person who ran the job, or have the Is Owner project
 role.

 Create a request for the method "jobs.get".

 This request holds the parameters needed by the bigquery server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. Project ID of the requested job.
jobId - Required. Job ID of the requested job.
Returns:
the request
Throws:
IOException








getQueryResults
public Bigquery.Jobs.GetQueryResults getQueryResults(String projectId,
                                                     String jobId)
                                              throws IOException
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 bigquery server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. Project ID of the query job.
jobId - Required. Job ID of the query job.
Returns:
the request
Throws:
IOException








insert
public Bigquery.Jobs.Insert insert(String projectId,
                                   Job content)
                            throws IOException
Starts a new asynchronous job. This API has two different kinds of endpoint URIs, as this method
 supports a variety of use cases. * The *Metadata* URI is used for most interactions, as it
 accepts the job configuration directly. * The *Upload* URI is ONLY for the case when you're
 sending both a load job configuration and a data stream together. In this case, the Upload URI
 accepts the job configuration and the data as two distinct multipart MIME parts.

 Create a request for the method "jobs.insert".

 This request holds the parameters needed by the bigquery server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Project ID of project that will be billed for the job.
content - the Job
Returns:
the request
Throws:
IOException








insert
public Bigquery.Jobs.Insert insert(String projectId,
                                   Job content,
                                   com.google.api.client.http.AbstractInputStreamContent mediaContent)
                            throws IOException
Starts a new asynchronous job. This API has two different kinds of endpoint URIs, as this method
 supports a variety of use cases. * The *Metadata* URI is used for most interactions, as it
 accepts the job configuration directly. * The *Upload* URI is ONLY for the case when you're
 sending both a load job configuration and a data stream together. In this case, the Upload URI
 accepts the job configuration and the data as two distinct multipart MIME parts.

 Create a request for the method "jobs.insert".

 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.

 
 This method should be used for uploading media content.
 

Parameters:
projectId - Project ID of project that will be billed for the job.
content - the Job media metadata or null if none
mediaContent - The media HTTP content.
Returns:
the request
Throws:
IOException - if the initialization of the request fails








list
public Bigquery.Jobs.List list(String projectId)
                        throws IOException
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 bigquery server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Project ID of the jobs to list.
Returns:
the request
Throws:
IOException








query
public Bigquery.Jobs.Query query(String projectId,
                                 QueryRequest content)
                          throws IOException
Runs a BigQuery SQL query synchronously and returns query results if the query completes within a
 specified timeout.

 Create a request for the method "jobs.query".

 This request holds the parameters needed by the bigquery server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
projectId - Required. Project ID of the query request.
content - the QueryRequest
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Bigquery.Jobs.Cancel`
`class`	`Bigquery.Jobs.Delete`
`class`	`Bigquery.Jobs.Get`
`class`	`Bigquery.Jobs.GetQueryResults`
`class`	`Bigquery.Jobs.Insert`
`class`	`Bigquery.Jobs.List`
`class`	`Bigquery.Jobs.Query`

Modifier and Type	Method and Description
`Bigquery.Jobs.Cancel`	`cancel(String projectId, String jobId)` Requests that a job be cancelled.
`Bigquery.Jobs.Delete`	`delete(String projectId, String jobId)` Requests the deletion of the metadata of a job.
`Bigquery.Jobs.Get`	`get(String projectId, String jobId)` Returns information about a specific job.
`Bigquery.Jobs.GetQueryResults`	`getQueryResults(String projectId, String jobId)` RPC to get the results of a query job.
`Bigquery.Jobs.Insert`	`insert(String projectId, Job content)` Starts a new asynchronous job.
`Bigquery.Jobs.Insert`	`insert(String projectId, Job content, com.google.api.client.http.AbstractInputStreamContent mediaContent)` Starts a new asynchronous job.
`Bigquery.Jobs.List`	`list(String projectId)` Lists all jobs that you started in the specified project.
`Bigquery.Jobs.Query`	`query(String projectId, QueryRequest content)` Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.