Send feedback
Class HttpBigQueryRpc (2.15.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.15.0 keyboard_arrow_down
public class HttpBigQueryRpc implements BigQueryRpc
Static Fields
DEFAULT_PROJECTION
public static final String DEFAULT_PROJECTION
Field Value
Constructors
HttpBigQueryRpc(BigQueryOptions options)
public HttpBigQueryRpc ( BigQueryOptions options )
Parameter
Methods
cancel(String projectId, String jobId, String location)
public 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.
Parameters
Returns
create(Dataset dataset, Map<BigQueryRpc.Option,?> options)
public Dataset create ( Dataset dataset , Map<BigQueryRpc . Option , ? > options )
Parameters
Name Description dataset com.google.api.services.bigquery.model.Dataset
options Map <Option ,? >
Returns
Type Description com.google.api.services.bigquery.model.Dataset
create(Job job, Map<BigQueryRpc.Option,?> options)
public Job create ( Job job , Map<BigQueryRpc . Option , ? > options )
Parameters
Name Description job com.google.api.services.bigquery.model.Job
options Map <Option ,? >
Returns
Type Description com.google.api.services.bigquery.model.Job
create(Routine routine, Map<BigQueryRpc.Option,?> options)
public Routine create ( Routine routine , Map<BigQueryRpc . Option , ? > options )
Creates the requested routine.
Parameters
Name Description routine com.google.api.services.bigquery.model.Routine
options Map <Option ,? >
Returns
Type Description com.google.api.services.bigquery.model.Routine
create(Table table, Map<BigQueryRpc.Option,?> options)
public Table create ( Table table , Map<BigQueryRpc . Option , ? > options )
Parameters
Name Description table com.google.api.services.bigquery.model.Table
options Map <Option ,? >
Returns
Type Description com.google.api.services.bigquery.model.Table
createJobForQuery(Job job)
public Job createJobForQuery ( Job job )
Parameter
Name Description job com.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 boolean deleteDataset ( String projectId , String datasetId , Map<BigQueryRpc . Option , ? > options )
Delete the requested dataset.
Parameters
Returns
deleteJob(String projectId, String jobName, String location)
public boolean deleteJob ( String projectId , String jobName , String location )
Sends a job delete request.
Parameters
Returns
deleteModel(String projectId, String datasetId, String modelId)
public boolean deleteModel ( String projectId , String datasetId , String modelId )
Delete the requested model.
Parameters
Returns
deleteRoutine(String projectId, String datasetId, String routineId)
public boolean deleteRoutine ( String projectId , String datasetId , String routineId )
Deletes the requested routine.
Parameters
Returns
deleteTable(String projectId, String datasetId, String tableId)
public boolean deleteTable ( String projectId , String datasetId , String tableId )
Delete the requested table.
Parameters
Returns
getDataset(String projectId, String datasetId, Map<BigQueryRpc.Option,?> options)
public Dataset getDataset ( String projectId , String datasetId , Map<BigQueryRpc . Option , ? > options )
Returns the requested dataset or null
if not found.
Parameters
Returns
Type Description com.google.api.services.bigquery.model.Dataset
getIamPolicy(String resourceId, Map<BigQueryRpc.Option,?> options)
public Policy getIamPolicy ( String resourceId , Map<BigQueryRpc . Option , ? > options )
Returns the IAM Policy for the specified resource, using Policy V1.
Parameters
Returns
Type Description com.google.api.services.bigquery.model.Policy
getJob(String projectId, String jobId, String location, Map<BigQueryRpc.Option,?> options)
public Job getJob ( String projectId , String jobId , String location , Map<BigQueryRpc . Option , ? > options )
Returns the requested job or null
if not found.
Parameters
Returns
Type Description com.google.api.services.bigquery.model.Job
getModel(String projectId, String datasetId, String modelId, Map<BigQueryRpc.Option,?> options)
public Model getModel ( String projectId , String datasetId , String modelId , Map<BigQueryRpc . Option , ? > options )
Returns the requested model or null
if not found.
Parameters
Returns
Type Description com.google.api.services.bigquery.model.Model
getQueryJob(String projectId, String jobId, String location)
public Job getQueryJob ( String projectId , String jobId , String location )
Returns the requested query job or null
if not found.
Parameters
Returns
Type Description com.google.api.services.bigquery.model.Job
getQueryResults(String projectId, String jobId, String location, Map<BigQueryRpc.Option,?> options)
public GetQueryResultsResponse getQueryResults ( String projectId , String jobId , String location , Map<BigQueryRpc . Option , ? > options )
Returns results of the query associated with the provided job.
Parameters
Returns
Type Description com.google.api.services.bigquery.model.GetQueryResultsResponse
getQueryResultsWithRowLimit(String projectId, String jobId, String location, Integer maxResultPerPage, Long timeoutMs)
public GetQueryResultsResponse getQueryResultsWithRowLimit ( String projectId , String jobId , String location , Integer maxResultPerPage , Long timeoutMs )
Returns results of the query with a limit on how many rows of data to pre-fetch associated with
the provided job.
Parameters
Returns
Type Description com.google.api.services.bigquery.model.GetQueryResultsResponse
getRoutine(String projectId, String datasetId, String routineId, Map<BigQueryRpc.Option,?> options)
public Routine getRoutine ( String projectId , String datasetId , String routineId , Map<BigQueryRpc . Option , ? > options )
Returns the requested routine or null
if not found.
Parameters
Returns
Type Description com.google.api.services.bigquery.model.Routine
getTable(String projectId, String datasetId, String tableId, Map<BigQueryRpc.Option,?> options)
public Table getTable ( String projectId , String datasetId , String tableId , Map<BigQueryRpc . Option , ? > options )
Returns the requested table or null
if not found.
Parameters
Returns
Type Description com.google.api.services.bigquery.model.Table
insertAll(String projectId, String datasetId, String tableId, TableDataInsertAllRequest request)
public TableDataInsertAllResponse insertAll ( String projectId , String datasetId , String tableId , TableDataInsertAllRequest request )
Sends an insert all request.
Parameters
Name Description projectId String
datasetId String
tableId String
request com.google.api.services.bigquery.model.TableDataInsertAllRequest
Returns
Type Description com.google.api.services.bigquery.model.TableDataInsertAllResponse
listDatasets(String projectId, Map<BigQueryRpc.Option,?> options)
public 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) .
Parameters
Returns
Type Description com.google.cloud.Tuple <String ,Iterable <com.google.api.services.bigquery.model.Dataset >>
listJobs(String projectId, Map<BigQueryRpc.Option,?> options)
public Tuple<String , Iterable<Job> > listJobs ( String projectId , Map<BigQueryRpc . Option , ? > options )
Lists the project's jobs.
Parameters
Returns
Type Description com.google.cloud.Tuple <String ,Iterable <com.google.api.services.bigquery.model.Job >>
listModels(String projectId, String datasetId, Map<BigQueryRpc.Option,?> options)
public Tuple<String , Iterable<Model> > listModels ( String projectId , String datasetId , Map<BigQueryRpc . Option , ? > options )
Lists the dataset's models, keyed by page token.
Parameters
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 Tuple<String , Iterable<Routine> > listRoutines ( String projectId , String datasetId , Map<BigQueryRpc . Option , ? > options )
Parameters
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 TableDataList listTableData ( String projectId , String datasetId , String tableId , Map<BigQueryRpc . Option , ? > options )
Parameters
Returns
Type Description com.google.api.services.bigquery.model.TableDataList
listTableDataWithRowLimit(String projectId, String datasetId, String tableId, Integer maxResultPerPage, String pageToken)
public TableDataList listTableDataWithRowLimit ( String projectId , String datasetId , String tableId , Integer maxResultPerPage , String pageToken )
Lists the table's rows with a limit on how many rows of data to pre-fetch.
Parameters
Returns
Type Description com.google.api.services.bigquery.model.TableDataList
listTables(String projectId, String datasetId, Map<BigQueryRpc.Option,?> options)
public Tuple<String , Iterable<Table> > listTables ( String projectId , String datasetId , 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) .
Parameters
Returns
Type Description com.google.cloud.Tuple <String ,Iterable <com.google.api.services.bigquery.model.Table >>
open(Job loadJob)
public String open ( Job loadJob )
Opens a resumable upload session to load data into a BigQuery table and returns an upload URI.
Parameter
Name Description loadJob com.google.api.services.bigquery.model.Job
Returns
patch(Dataset dataset, Map<BigQueryRpc.Option,?> options)
public Dataset patch ( Dataset dataset , Map<BigQueryRpc . Option , ? > options )
Updates dataset information.
Parameters
Name Description dataset com.google.api.services.bigquery.model.Dataset
options Map <Option ,? >
Returns
Type Description com.google.api.services.bigquery.model.Dataset
patch(Model model, Map<BigQueryRpc.Option,?> options)
public Model patch ( Model model , Map<BigQueryRpc . Option , ? > options )
Updates model information.
Parameters
Name Description model com.google.api.services.bigquery.model.Model
options Map <Option ,? >
Returns
Type Description com.google.api.services.bigquery.model.Model
patch(Table table, Map<BigQueryRpc.Option,?> options)
public Table patch ( Table table , Map<BigQueryRpc . Option , ? > options )
Updates table information.
Parameters
Name Description table com.google.api.services.bigquery.model.Table
options Map <Option ,? >
Returns
Type Description com.google.api.services.bigquery.model.Table
queryRpc(String projectId, QueryRequest content)
public 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 projectId String
content com.google.api.services.bigquery.model.QueryRequest
Returns
Type Description com.google.api.services.bigquery.model.QueryResponse
setIamPolicy(String resourceId, Policy policy, Map<BigQueryRpc.Option,?> options)
public Policy setIamPolicy ( String resourceId , Policy policy , Map<BigQueryRpc . Option , ? > options )
Updates the IAM policy for the specified resource.
Parameters
Name Description resourceId String
policy com.google.api.services.bigquery.model.Policy
options Map <Option ,? >
Returns
Type Description com.google.api.services.bigquery.model.Policy
testIamPermissions(String resourceId, List<String> permissions, Map<BigQueryRpc.Option,?> options)
public 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.
Parameters
Returns
Type Description com.google.api.services.bigquery.model.TestIamPermissionsResponse
update(Routine routine, Map<BigQueryRpc.Option,?> options)
public Routine update ( Routine routine , Map<BigQueryRpc . Option , ? > options )
Updates the requested routine.
Parameters
Name Description routine com.google.api.services.bigquery.model.Routine
options Map <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 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
Returns
Type Description com.google.api.services.bigquery.model.Job
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."],[],[]]