com.google.cloud.bigquery.spi

Interface BigQueryRpc

All Known Implementing Classes:

DefaultBigQueryRpc

public interface BigQueryRpc

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BigQueryRpc.Option
static class	BigQueryRpc.Tuple<X,Y>

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel(String projectId, String jobId) Sends a job cancel request.
com.google.api.services.bigquery.model.Dataset	create(com.google.api.services.bigquery.model.Dataset dataset, Map<BigQueryRpc.Option,?> options) Creates a new dataset.
com.google.api.services.bigquery.model.Job	create(com.google.api.services.bigquery.model.Job job, Map<BigQueryRpc.Option,?> options) Creates a new job.
com.google.api.services.bigquery.model.Table	create(com.google.api.services.bigquery.model.Table table, Map<BigQueryRpc.Option,?> options) Creates a new table.
boolean	deleteDataset(String projectId, String datasetId, Map<BigQueryRpc.Option,?> options) Delete the requested dataset.
boolean	deleteTable(String projectId, String datasetId, String tableId) Delete the requested table.
com.google.api.services.bigquery.model.Dataset	getDataset(String projectId, String datasetId, Map<BigQueryRpc.Option,?> options) Returns the requested dataset or null if not found.
com.google.api.services.bigquery.model.Job	getJob(String projectId, String jobId, Map<BigQueryRpc.Option,?> options) Returns the requested job or null if not found.
com.google.api.services.bigquery.model.GetQueryResultsResponse	getQueryResults(String projectId, String jobId, Map<BigQueryRpc.Option,?> options) Returns results of the query associated with the provided job.
com.google.api.services.bigquery.model.Table	getTable(String projectId, String datasetId, String tableId, Map<BigQueryRpc.Option,?> options) Returns the requested table or null if not found.
com.google.api.services.bigquery.model.TableDataInsertAllResponse	insertAll(String projectId, String datasetId, String tableId, com.google.api.services.bigquery.model.TableDataInsertAllRequest request) Sends an insert all request.
BigQueryRpc.Tuple<String,Iterable<com.google.api.services.bigquery.model.Dataset>>	listDatasets(String projectId, Map<BigQueryRpc.Option,?> options) Lists the provided project's datasets.
BigQueryRpc.Tuple<String,Iterable<com.google.api.services.bigquery.model.Job>>	listJobs(String projectId, Map<BigQueryRpc.Option,?> options) Lists the project's jobs.
BigQueryRpc.Tuple<String,Iterable<com.google.api.services.bigquery.model.TableRow>>	listTableData(String projectId, String datasetId, String tableId, Map<BigQueryRpc.Option,?> options) Lists the table's rows.
BigQueryRpc.Tuple<String,Iterable<com.google.api.services.bigquery.model.Table>>	listTables(String projectId, String dataset, Map<BigQueryRpc.Option,?> options) Lists the dataset's tables.
String	open(com.google.api.services.bigquery.model.JobConfiguration configuration) Opens a resumable upload session to load data into a BigQuery table and returns an upload URI.
com.google.api.services.bigquery.model.Dataset	patch(com.google.api.services.bigquery.model.Dataset dataset, Map<BigQueryRpc.Option,?> options) Updates dataset information.
com.google.api.services.bigquery.model.Table	patch(com.google.api.services.bigquery.model.Table table, Map<BigQueryRpc.Option,?> options) Updates table information.
com.google.api.services.bigquery.model.QueryResponse	query(com.google.api.services.bigquery.model.QueryRequest request) Runs the query associated with the request.
void	write(String uploadId, byte[] toWrite, int toWriteOffset, long destOffset, int length, boolean last) Uploads the provided data to the resumable upload session at the specified position.

Method Detail

getDataset

com.google.api.services.bigquery.model.Dataset getDataset(String projectId,
                                                        String datasetId,
                                                        Map<BigQueryRpc.Option,?> options)

Returns the requested dataset or null if not found.

Throws:

BigQueryException - upon failure

listDatasets

BigQueryRpc.Tuple<String,Iterable<com.google.api.services.bigquery.model.Dataset>> listDatasets(String projectId,
                                                                                              Map<BigQueryRpc.Option,?> options)

Lists the provided project's datasets. Partial information is returned on a dataset (datasetReference, friendlyName and id). To get full information use getDataset(String, String, Map).

Throws:

BigQueryException - upon failure

create

com.google.api.services.bigquery.model.Dataset create(com.google.api.services.bigquery.model.Dataset dataset,
                                                    Map<BigQueryRpc.Option,?> options)

Creates a new dataset.

Throws:

BigQueryException - upon failure

create

com.google.api.services.bigquery.model.Table create(com.google.api.services.bigquery.model.Table table,
                                                  Map<BigQueryRpc.Option,?> options)

Creates a new table.

Throws:

BigQueryException - upon failure

create

com.google.api.services.bigquery.model.Job create(com.google.api.services.bigquery.model.Job job,
                                                Map<BigQueryRpc.Option,?> options)

Creates a new job.

Throws:

BigQueryException - upon failure

deleteDataset

boolean deleteDataset(String projectId,
                    String datasetId,
                    Map<BigQueryRpc.Option,?> options)

Delete the requested dataset.

Returns:

true if dataset was deleted, false if it was not found

Throws:

BigQueryException - upon failure

patch

com.google.api.services.bigquery.model.Dataset patch(com.google.api.services.bigquery.model.Dataset dataset,
                                                   Map<BigQueryRpc.Option,?> options)

Updates dataset information.

Throws:

BigQueryException - upon failure

patch

com.google.api.services.bigquery.model.Table patch(com.google.api.services.bigquery.model.Table table,
                                                 Map<BigQueryRpc.Option,?> options)

Updates table information.

Throws:

BigQueryException - upon failure

getTable

com.google.api.services.bigquery.model.Table getTable(String projectId,
                                                    String datasetId,
                                                    String tableId,
                                                    Map<BigQueryRpc.Option,?> options)

Returns the requested table or null if not found.

Throws:

BigQueryException - upon failure

listTables

BigQueryRpc.Tuple<String,Iterable<com.google.api.services.bigquery.model.Table>> listTables(String projectId,
                                                                                          String dataset,
                                                                                          Map<BigQueryRpc.Option,?> options)

Lists the dataset's tables. Partial information is returned on a table (tableReference, friendlyName, id and type). To get full information use getTable(String, String, String, Map).

Throws:

BigQueryException - upon failure

deleteTable

boolean deleteTable(String projectId,
                  String datasetId,
                  String tableId)

Delete the requested table.

Returns:

true if table was deleted, false if it was not found

Throws:

BigQueryException - upon failure

insertAll

com.google.api.services.bigquery.model.TableDataInsertAllResponse insertAll(String projectId,
                                                                          String datasetId,
                                                                          String tableId,
                                                                          com.google.api.services.bigquery.model.TableDataInsertAllRequest request)

Sends an insert all request.

Throws:

BigQueryException - upon failure

listTableData

BigQueryRpc.Tuple<String,Iterable<com.google.api.services.bigquery.model.TableRow>> listTableData(String projectId,
                                                                                                String datasetId,
                                                                                                String tableId,
                                                                                                Map<BigQueryRpc.Option,?> options)

Lists the table's rows.

Throws:

BigQueryException - upon failure

getJob

com.google.api.services.bigquery.model.Job getJob(String projectId,
                                                String jobId,
                                                Map<BigQueryRpc.Option,?> options)

Returns the requested job or null if not found.

Throws:

BigQueryException - upon failure

listJobs

BigQueryRpc.Tuple<String,Iterable<com.google.api.services.bigquery.model.Job>> listJobs(String projectId,
                                                                                      Map<BigQueryRpc.Option,?> options)

Lists the project's jobs.

Throws:

BigQueryException - upon failure

cancel

boolean cancel(String projectId,
             String jobId)

Sends a job cancel request. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully.

Returns:

true if cancel was requested successfully, false if the job was not found

Throws:

BigQueryException - upon failure

getQueryResults

com.google.api.services.bigquery.model.GetQueryResultsResponse getQueryResults(String projectId,
                                                                             String jobId,
                                                                             Map<BigQueryRpc.Option,?> options)

Returns results of the query associated with the provided job.

Throws:

BigQueryException - upon failure

query

com.google.api.services.bigquery.model.QueryResponse query(com.google.api.services.bigquery.model.QueryRequest request)

Runs the query associated with the request.

Throws:

BigQueryException - upon failure

open

String open(com.google.api.services.bigquery.model.JobConfiguration configuration)

Opens a resumable upload session to load data into a BigQuery table and returns an upload URI.

Parameters:

configuration - load configuration

Throws:

BigQueryException - upon failure

write

void write(String uploadId,
         byte[] toWrite,
         int toWriteOffset,
         long destOffset,
         int length,
         boolean last)

Uploads the provided data to the resumable upload session at the specified position.

Parameters:

uploadId - the resumable upload session URI

toWrite - a byte array of data to upload

toWriteOffset - offset in the toWrite param to start writing from

destOffset - offset in the destination where to upload data to

length - the number of bytes to upload

last - true indicates that the last chunk is being uploaded

Throws:

BigQueryException - upon failure