Send feedback
Interface BigQueryRpc (2.26.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.26.0 keyboard_arrow_down
public interface BigQueryRpc extends ServiceRpc
Implements
com.google.cloud.ServiceRpc Methods
cancel(String projectId, String jobId, String location)
public abstract boolean cancel ( String projectId , String jobId , String location )
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 Type Description boolean true if cancel was requested successfully, false if the job was not
found
create(Dataset dataset, Map<BigQueryRpc.Option,?> options)
public abstract Dataset create ( Dataset dataset , Map<BigQueryRpc . Option , ? > options )
Parameters Name Description datasetcom.google.api.services.bigquery.model.Dataset optionsMap <Option ,? >
Returns Type Description com.google.api.services.bigquery.model.Dataset
create(Job job, Map<BigQueryRpc.Option,?> options)
public abstract Job create ( Job job , Map<BigQueryRpc . Option , ? > options )
Parameters Name Description jobcom.google.api.services.bigquery.model.Job optionsMap <Option ,? >
Returns Type Description com.google.api.services.bigquery.model.Job
create(Routine routine, Map<BigQueryRpc.Option,?> options)
public abstract Routine create ( Routine routine , Map<BigQueryRpc . Option , ? > options )
Creates the requested routine.
Parameters Name Description routinecom.google.api.services.bigquery.model.Routine optionsMap <Option ,? >
Returns Type Description com.google.api.services.bigquery.model.Routine
create(Table table, Map<BigQueryRpc.Option,?> options)
public abstract Table create ( Table table , Map<BigQueryRpc . Option , ? > options )
Parameters Name Description tablecom.google.api.services.bigquery.model.Table optionsMap <Option ,? >
Returns Type Description com.google.api.services.bigquery.model.Table
createJobForQuery(Job job)
public abstract Job createJobForQuery ( Job job )
Parameter Name Description jobcom.google.api.services.bigquery.model.Job
Returns Type Description com.google.api.services.bigquery.model.Job
deleteDataset(String projectId, String datasetId, Map<BigQueryRpc.Option,?> options)
public abstract boolean deleteDataset ( String projectId , String datasetId , Map<BigQueryRpc . Option , ? > options )
Delete the requested dataset.
Returns Type Description boolean true if dataset was deleted, false if it was not found
deleteJob(String projectId, String jobName, String location)
public abstract boolean deleteJob ( String projectId , String jobName , String location )
Sends a job delete request.
Returns Type Description boolean true if delete was successful, false if the job was not found
deleteModel(String projectId, String datasetId, String modelId)
public abstract boolean deleteModel ( String projectId , String datasetId , String modelId )
Delete the requested model.
Returns Type Description boolean true if model was deleted, false if it was not found
deleteRoutine(String projectId, String datasetId, String routineId)
public abstract boolean deleteRoutine ( String projectId , String datasetId , String routineId )
Deletes the requested routine.
Returns Type Description boolean true if routine was deleted, false if it was not found
deleteTable(String projectId, String datasetId, String tableId)
public abstract boolean deleteTable ( String projectId , String datasetId , String tableId )
Delete the requested table.
Returns Type Description boolean true if table was deleted, false if it was not found
getDataset(String projectId, String datasetId, Map<BigQueryRpc.Option,?> options)
public abstract Dataset getDataset ( String projectId , String datasetId , Map<BigQueryRpc . Option , ? > options )
Returns the requested dataset or null if not found.
Returns Type Description com.google.api.services.bigquery.model.Dataset
getIamPolicy(String resourceId, Map<BigQueryRpc.Option,?> options)
public abstract Policy getIamPolicy ( String resourceId , Map<BigQueryRpc . Option , ? > options )
Returns the IAM Policy for the specified resource, using Policy V1.
Returns Type Description com.google.api.services.bigquery.model.Policy
getJob(String projectId, String jobId, String location, Map<BigQueryRpc.Option,?> options)
public abstract Job getJob ( String projectId , String jobId , String location , Map<BigQueryRpc . Option , ? > options )
Returns the requested job or null if not found.
Returns Type Description com.google.api.services.bigquery.model.Job
getModel(String projectId, String datasetId, String modelId, Map<BigQueryRpc.Option,?> options)
public abstract Model getModel ( String projectId , String datasetId , String modelId , Map<BigQueryRpc . Option , ? > options )
Returns the requested model or null if not found.
Returns Type Description com.google.api.services.bigquery.model.Model
getQueryJob(String projectId, String jobId, String location)
public abstract Job getQueryJob ( String projectId , String jobId , String location )
Returns the requested query job or null if not found.
Returns Type Description com.google.api.services.bigquery.model.Job
getQueryResults(String projectId, String jobId, String location, Map<BigQueryRpc.Option,?> options)
public abstract GetQueryResultsResponse getQueryResults ( String projectId , String jobId , String location , Map<BigQueryRpc . Option , ? > options )
Returns results of the query associated with the provided job.
Returns Type Description com.google.api.services.bigquery.model.GetQueryResultsResponse
getQueryResultsWithRowLimit(String projectId, String jobId, String location, Integer preFetchedRowLimit, Long timeoutMs)
public abstract GetQueryResultsResponse getQueryResultsWithRowLimit ( String projectId , String jobId , String location , Integer preFetchedRowLimit , Long timeoutMs )
Returns results of the query with a limit on how many rows of data to pre-fetch associated with
the provided job.
Returns Type Description com.google.api.services.bigquery.model.GetQueryResultsResponse
getRoutine(String projectId, String datasetId, String routineId, Map<BigQueryRpc.Option,?> options)
public abstract Routine getRoutine ( String projectId , String datasetId , String routineId , Map<BigQueryRpc . Option , ? > options )
Returns the requested routine or null if not found.
Returns Type Description com.google.api.services.bigquery.model.Routine
getTable(String projectId, String datasetId, String tableId, Map<BigQueryRpc.Option,?> options)
public abstract Table getTable ( String projectId , String datasetId , String tableId , Map<BigQueryRpc . Option , ? > options )
Returns the requested table or null if not found.
Returns Type Description com.google.api.services.bigquery.model.Table
insertAll(String projectId, String datasetId, String tableId, TableDataInsertAllRequest request)
public abstract TableDataInsertAllResponse insertAll ( String projectId , String datasetId , String tableId , TableDataInsertAllRequest request )
Sends an insert all request.
Parameters Name Description projectIdString datasetIdString tableIdString requestcom.google.api.services.bigquery.model.TableDataInsertAllRequest
Returns Type Description com.google.api.services.bigquery.model.TableDataInsertAllResponse
listDatasets(String projectId, Map<BigQueryRpc.Option,?> options)
public abstract Tuple<String , Iterable<Dataset> > listDatasets ( String projectId , Map<BigQueryRpc . Option , ? > options )
Lists the provided project's datasets, keyed by page token. Partial information is returned on
a dataset (datasetReference, friendlyName and id). To get full information use #getDataset(String, String, Map) .
Returns Type Description com.google.cloud.Tuple <String ,Iterable <com.google.api.services.bigquery.model.Dataset >>
listJobs(String projectId, Map<BigQueryRpc.Option,?> options)
public abstract Tuple<String , Iterable<Job> > listJobs ( String projectId , Map<BigQueryRpc . Option , ? > options )
Lists the project's jobs.
Returns Type Description com.google.cloud.Tuple <String ,Iterable <com.google.api.services.bigquery.model.Job >>
listModels(String projectId, String dataset, Map<BigQueryRpc.Option,?> options)
public abstract Tuple<String , Iterable<Model> > listModels ( String projectId , String dataset , Map<BigQueryRpc . Option , ? > options )
Lists the dataset's models, keyed by page token.
Returns Type Description com.google.cloud.Tuple <String ,Iterable <com.google.api.services.bigquery.model.Model >>
listRoutines(String projectId, String datasetId, Map<BigQueryRpc.Option,?> options)
public abstract Tuple<String , Iterable<Routine> > listRoutines ( String projectId , String datasetId , Map<BigQueryRpc . Option , ? > options )
Returns Type Description com.google.cloud.Tuple <String ,Iterable <com.google.api.services.bigquery.model.Routine >>
listTableData(String projectId, String datasetId, String tableId, Map<BigQueryRpc.Option,?> options)
public abstract TableDataList listTableData ( String projectId , String datasetId , String tableId , Map<BigQueryRpc . Option , ? > options )
Returns Type Description com.google.api.services.bigquery.model.TableDataList
listTableDataWithRowLimit(String projectId, String datasetId, String tableId, Integer rowLimit, String pageToken)
public abstract TableDataList listTableDataWithRowLimit ( String projectId , String datasetId , String tableId , Integer rowLimit , String pageToken )
Lists the table's rows with a limit on how many rows of data to pre-fetch.
Returns Type Description com.google.api.services.bigquery.model.TableDataList
listTables(String projectId, String dataset, Map<BigQueryRpc.Option,?> options)
public abstract Tuple<String , Iterable<Table> > listTables ( String projectId , String dataset , Map<BigQueryRpc . Option , ? > options )
Lists the dataset's tables, keyed by page token. Partial information is returned on a table
(tableReference, friendlyName, id and type). To get full information use #getTable(String, String, String, Map) .
Returns Type Description com.google.cloud.Tuple <String ,Iterable <com.google.api.services.bigquery.model.Table >>
open(Job job)
public abstract String open ( Job job )
Opens a resumable upload session to load data into a BigQuery table and returns an upload URI.
Parameter Name Description jobcom.google.api.services.bigquery.model.Job load job
patch(Dataset dataset, Map<BigQueryRpc.Option,?> options)
public abstract Dataset patch ( Dataset dataset , Map<BigQueryRpc . Option , ? > options )
Updates dataset information.
Parameters Name Description datasetcom.google.api.services.bigquery.model.Dataset optionsMap <Option ,? >
Returns Type Description com.google.api.services.bigquery.model.Dataset
patch(Model model, Map<BigQueryRpc.Option,?> options)
public abstract Model patch ( Model model , Map<BigQueryRpc . Option , ? > options )
Updates model information.
Parameters Name Description modelcom.google.api.services.bigquery.model.Model optionsMap <Option ,? >
Returns Type Description com.google.api.services.bigquery.model.Model
patch(Table table, Map<BigQueryRpc.Option,?> options)
public abstract Table patch ( Table table , Map<BigQueryRpc . Option , ? > options )
Updates table information.
Parameters Name Description tablecom.google.api.services.bigquery.model.Table optionsMap <Option ,? >
Returns Type Description com.google.api.services.bigquery.model.Table
queryRpc(String projectId, QueryRequest content)
public abstract QueryResponse queryRpc ( String projectId , QueryRequest content )
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 Query#execute() method to invoke the remote operation.
Parameters Name Description projectIdString Project ID of the project billed for the query
contentcom.google.api.services.bigquery.model.QueryRequest the com.google.api.services.bigquery.model.QueryRequest
Returns Type Description com.google.api.services.bigquery.model.QueryResponse the request
setIamPolicy(String resourceId, Policy policy, Map<BigQueryRpc.Option,?> options)
public abstract Policy setIamPolicy ( String resourceId , Policy policy , Map<BigQueryRpc . Option , ? > options )
Updates the IAM policy for the specified resource.
Parameters Name Description resourceIdString policycom.google.api.services.bigquery.model.Policy optionsMap <Option ,? >
Returns Type Description com.google.api.services.bigquery.model.Policy
testIamPermissions(String resourceId, List<String> permissions, Map<BigQueryRpc.Option,?> options)
public abstract TestIamPermissionsResponse testIamPermissions ( String resourceId , List<String> permissions , Map<BigQueryRpc . Option , ? > options )
Tests whether the caller holds the provided permissions for the specified resource. Returns the
subset of permissions the caller actually holds.
Returns Type Description com.google.api.services.bigquery.model.TestIamPermissionsResponse
update(Routine routine, Map<BigQueryRpc.Option,?> options)
public abstract Routine update ( Routine routine , Map<BigQueryRpc . Option , ? > options )
Updates the requested routine.
Parameters Name Description routinecom.google.api.services.bigquery.model.Routine optionsMap <Option ,? >
Returns Type Description com.google.api.services.bigquery.model.Routine
write(String uploadId, byte[] toWrite, int toWriteOffset, long destOffset, int length, boolean last)
public abstract Job 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. This
method returns the job created to insert the rows, only when last is true.
Parameters Name Description uploadIdString the resumable upload session URI
toWritebyte []a byte array of data to upload
toWriteOffsetint offset in the toWrite param to start writing from
destOffsetlong offset in the destination where to upload data to
lengthint the number of bytes to upload
lastboolean true indicates that the last chunk is being uploaded
Returns Type Description com.google.api.services.bigquery.model.Job returns the job created to insert the rows, only when last is true.
Returns null otherwise
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
