com.google.cloud.bigquery.spi.v2.BigQueryRpc Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-bigquery Show documentation
Show all versions of google-cloud-bigquery Show documentation
Java idiomatic client for Google Cloud BigQuery.
/*
* Copyright 2015 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.bigquery.spi.v2;
import com.google.api.services.bigquery.model.Dataset;
import com.google.api.services.bigquery.model.GetQueryResultsResponse;
import com.google.api.services.bigquery.model.Job;
import com.google.api.services.bigquery.model.JobConfiguration;
import com.google.api.services.bigquery.model.Table;
import com.google.api.services.bigquery.model.TableDataInsertAllRequest;
import com.google.api.services.bigquery.model.TableDataInsertAllResponse;
import com.google.api.services.bigquery.model.TableDataList;
import com.google.cloud.ServiceRpc;
import com.google.cloud.Tuple;
import com.google.cloud.bigquery.BigQueryException;
import java.util.Map;
public interface BigQueryRpc extends ServiceRpc {
// These options are part of the Google Cloud BigQuery query parameters
enum Option {
FIELDS("fields"),
DELETE_CONTENTS("deleteContents"),
ALL_DATASETS("all"),
ALL_USERS("allUsers"),
MAX_RESULTS("maxResults"),
PAGE_TOKEN("pageToken"),
START_INDEX("startIndex"),
STATE_FILTER("stateFilter"),
TIMEOUT("timeoutMs");
private final String value;
Option(String value) {
this.value = value;
}
public String value() {
return value;
}
@SuppressWarnings("unchecked")
T get(Map options) {
return (T) options.get(this);
}
String getString(Map options) {
return get(options);
}
Long getLong(Map options) {
return get(options);
}
Boolean getBoolean(Map options) {
return get(options);
}
}
/**
* Returns the requested dataset or {@code null} if not found.
*
* @throws BigQueryException upon failure
*/
Dataset getDataset(String projectId, String datasetId, Map options);
/**
* Lists the provided project's datasets. Partial information is returned on a dataset
* (datasetReference, friendlyName and id). To get full information use
* {@link #getDataset(String, String, Map)}.
*
* @throws BigQueryException upon failure
*/
Tuple> listDatasets(String projectId, Map options);
/**
* Creates a new dataset.
*
* @throws BigQueryException upon failure
*/
Dataset create(Dataset dataset, Map options);
/**
* Creates a new table.
*
* @throws BigQueryException upon failure
*/
Table create(Table table, Map options);
/**
* Creates a new job.
*
* @throws BigQueryException upon failure
*/
Job create(Job job, Map options);
/**
* Delete the requested dataset.
*
* @return {@code true} if dataset was deleted, {@code false} if it was not found
* @throws BigQueryException upon failure
*/
boolean deleteDataset(String projectId, String datasetId, Map options);
/**
* Updates dataset information.
*
* @throws BigQueryException upon failure
*/
Dataset patch(Dataset dataset, Map options);
/**
* Updates table information.
*
* @throws BigQueryException upon failure
*/
Table patch(Table table, Map options);
/**
* Returns the requested table or {@code null} if not found.
*
* @throws BigQueryException upon failure
*/
Table getTable(String projectId, String datasetId, String tableId, Map options);
/**
* Lists the dataset's tables. Partial information is returned on a table (tableReference,
* friendlyName, id and type). To get full information use
* {@link #getTable(String, String, String, Map)}.
*
* @throws BigQueryException upon failure
*/
Tuple> listTables(String projectId, String dataset,
Map options);
/**
* Delete the requested table.
*
* @return {@code true} if table was deleted, {@code false} if it was not found
* @throws BigQueryException upon failure
*/
boolean deleteTable(String projectId, String datasetId, String tableId);
/**
* Sends an insert all request.
*
* @throws BigQueryException upon failure
*/
TableDataInsertAllResponse insertAll(String projectId, String datasetId, String tableId,
TableDataInsertAllRequest request);
/**
* Lists the table's rows.
*
* @throws BigQueryException upon failure
*/
TableDataList listTableData(
String projectId, String datasetId, String tableId, Map options);
/**
* Returns the requested job or {@code null} if not found.
*
* @throws BigQueryException upon failure
*/
Job getJob(String projectId, String jobId, Map options);
/**
* Lists the project's jobs.
*
* @throws BigQueryException upon failure
*/
Tuple> listJobs(String projectId, Map options);
/**
* 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.
*
* @return {@code true} if cancel was requested successfully, {@code false} if the job was not
* found
* @throws BigQueryException upon failure
*/
boolean cancel(String projectId, String jobId);
/**
* Returns results of the query associated with the provided job.
*
* @throws BigQueryException upon failure
*/
GetQueryResultsResponse getQueryResults(String projectId, String jobId, Map options);
/**
* Opens a resumable upload session to load data into a BigQuery table and returns an upload URI.
*
* @param configuration load configuration
* @throws BigQueryException upon failure
*/
String open(JobConfiguration configuration);
/**
* Uploads the provided data to the resumable upload session at the specified position. This
* method returns the job created to insert the rows, only when {@code last} is {@code true}.
*
* @param uploadId the resumable upload session URI
* @param toWrite a byte array of data to upload
* @param toWriteOffset offset in the {@code toWrite} param to start writing from
* @param destOffset offset in the destination where to upload data to
* @param length the number of bytes to upload
* @param last {@code true} indicates that the last chunk is being uploaded
* @return returns the job created to insert the rows, only when {@code last} is {@code true}.
* Returns {@code null} otherwise
* @throws BigQueryException upon failure
*/
Job write(String uploadId, byte[] toWrite, int toWriteOffset, long destOffset, int length,
boolean last);
}