Package com.google.cloud.bigquery (2.56.0)
Settings Classes
Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.
| Settings | Description |
|---|---|
| com. |
ConnectionSettings for setting up a BigQuery query connection. |
Classes
| Class | Description |
|---|---|
| com. |
Access Control for a BigQuery Dataset. BigQuery uses ACLs to manage permissions on datasets. ACLs are not directly supported on tables. A table inherits its ACL from the dataset that contains it. Project roles affect your ability to run jobs or manage the project, while dataset roles affect how you can access or modify the data inside a project. |
| com. |
Class for a BigQuery DatasetAclEntity ACL entity. Objects of this class represent a DatasetAclEntity from a different DatasetAclEntity to grant access to. Only views are supported for now. The role field is not required when this field is set. If that DatasetAclEntity is deleted and re-created, its access needs to be granted again via an update operation. |
| com. |
Class for a BigQuery Domain entity. Objects of this class represent a domain to grant access to. Any users signed in with the domain specified will be granted the specified access. |
| com. |
Base class for BigQuery entities that can be grant access to the dataset. |
| com. |
Expr represents the conditional information related to dataset access policies. |
| com. |
Class for a BigQuery Group entity. Objects of this class represent a group to granted access to. A Group entity can be created given the group's email or can be a special group: #ofProjectOwners() , #ofProjectReaders() , #ofProjectWriters() or #ofAllAuthenticatedUsers() . |
| com. |
Class for a BigQuery IamMember entity. Objects of this class represent a iamMember to grant access to given the IAM Policy. |
| com. |
Dataset roles supported by BigQuery. See Also: Dataset Roles |
| com. |
Class for a BigQuery Routine entity. Objects of this class represent a routine from a different datasetAclEntity to grant access to. Queries executed against that routine will have read access to views/tables/routines in this datasetAclEntity. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, |
| com. |
Class for a BigQuery User entity. Objects of this class represent a user to grant access to given the email address. |
| com. |
Class for a BigQuery View entity. Objects of this class represent a view from a different datasetAclEntity to grant access to. Queries executed against that view will have read access to tables in this datasetAclEntity. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update |
| com. |
Google BigQuery options for AVRO format. This class wraps some properties of AVRO files used by BigQuery to parse external data. |
| com. |
|
| com. |
|
| com. |
|
| com. |
BIEngineStatistics contains query statistics specific to the use of BI Engine. |
| com. |
|
| com. |
|
| com. |
|
| com. |
Class for specifying dataset delete options. |
| com. |
Class for specifying dataset list options. |
| com. |
Class for specifying dataset get, create and update options. |
| com. |
|
| com. |
Class for specifying job list options. |
| com. |
Class for specifying table get and create options. |
| com. |
Class for specifying table list options. |
| com. |
Class for specifying model get, create and update options. |
| com. |
|
| com. |
Class for specifying query results options. |
| com. |
Class for specifying routine list options. |
| com. |
Class for specifying table get, create and update options. |
| com. |
Class for specifying table data list options. |
| com. |
Class for specifying table list options. |
| com. |
Class for specifying table get, create and update options. |
| com. |
|
| com. |
Google Cloud BigQuery Error. Objects of this class represent errors encountered by the BigQuery service while executing a request. A BigQuery Job that terminated with an error has a non-null JobStatus#getError() . A job can also encounter errors during its execution that do not cause the whole job to fail (see JobStatus#getExecutionErrors() ). Similarly, queries and |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
An implementation of BigQueryResult. This class and the ResultSet it returns is not thread-safe. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
List of column families to expose in the table schema along with their types. This list restricts
the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you |
| com. |
|
| com. |
|
| com. |
A builder for BigtableOptions
objects. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
A builder for ConnectionProperty
objects. |
| com. |
|
| com. |
Google BigQuery copy job configuration. A copy job copies an existing table to another new or existing table. Copy job configurations have JobConfiguration.Type#COPY type. |
| com. |
|
| com. |
Google BigQuery options for CSV format. This class wraps some properties of CSV files used by BigQuery to parse external data. |
| com. |
|
| com. |
A Google BigQuery Dataset. Objects of this class are immutable. Operations that modify the dataset like #update
return a new object. To get a |
| com. |
A builder for Dataset
objects. |
| com. |
Google BigQuery Dataset identity. |
| com. |
Google BigQuery Dataset information. A dataset is a grouping mechanism that holds zero or more tables. Datasets are the lowest level unit of access control; you cannot control access at the table level. See Also: Managing Jobs, Datasets, and Projects |
| com. |
A builder for DatasetInfo
objects. |
| com. |
Google BigQuery options for Cloud Datastore backup. |
| com. |
|
| com. |
Represents DML statistics information. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
Configures the access a dataset defined in an external metadata storage. |
| com. |
|
| com. |
Google BigQuery external table definition. BigQuery's external tables are tables whose data reside outside of BigQuery but can be queried as normal BigQuery tables. External tables are experimental and might be subject to change or removed. See Also: Federated Data Sources |
| com. |
|
| com. |
|
| com. |
Google BigQuery extract job configuration. An extract job exports a BigQuery table to Google Cloud Storage. The extract destination provided as URIs that point to objects in Google Cloud Storage. Extract job configurations have JobConfiguration.Type#EXTRACT type. |
| com. |
|
| com. |
Google BigQuery Table schema field. A table field has a name, a type, a mode and possibly a description. |
| com. |
|
| com. |
|
| com. |
|
| com. |
Google BigQuery Table schema fields (columns). Each field has a unique name and index. Fields with duplicate names are not allowed in BigQuery schema. |
| com. |
Google BigQuery Table Field Value class. Objects of this class represent values of a BigQuery Table Field. A list of values forms a table row. Tables rows can be gotten as the result of a query or when listing table data. |
| com. |
Google BigQuery Table Field Values class, which represents a row in returned query result (table
row). Tables rows can be retrieved as a result of a query or when listing table data. Depending on how a corresponding query was executed, each row (an instance of |
| com. |
|
| com. |
|
| com. |
Base class for Google BigQuery format options. These class define the format of external data
used by BigQuery, for either federated tables or load jobs. Load jobs support the following formats: AVRO, CSV, DATASTORE_BACKUP, GOOGLE_SHEETS, JSON, |
| com. |
Google BigQuery options for the Google Sheets format. |
| com. |
|
| com. |
HivePartitioningOptions currently supported types include: AVRO, CSV, JSON, ORC and Parquet. |
| com. |
|
| com. |
Represents Reason of why the index was not used in a SQL search. |
| com. |
|
| com. |
Google Cloud BigQuery insert all request. This class can be used to stream data into BigQuery one record at a time without needing to run a load job. This approach enables querying data without the delay of running a load job. There are several important trade-offs to consider before choosing an approach. |
| com. |
|
| com. |
A Google Big Query row to be inserted into a table. Each RowToInsert
has an associated
id used by BigQuery to detect duplicate insertion requests on a best-effort basis. To ensure proper serialization of numeric data, it is recommended to supply values using a |
| com. |
Google Cloud BigQuery insert all response. Objects of this class possibly contain errors for an InsertAllRequest . If a row failed to be inserted, the non-empty list of errors associated to that row's index can be obtained with InsertAllResponse#getErrorsFor(long) . InsertAllResponse#getInsertErrors() can be used to return all errors caused by a InsertAllRequest as a map. |
| com. |
A Google BigQuery Job. Objects of this class are immutable. To get a |
| com. |
A builder for Job
objects. |
| com. |
Base class for a BigQuery job configuration. |
| com. |
Base builder for job configurations. |
| com. |
Google BigQuery Job identity. |
| com. |
|
| com. |
Google BigQuery Job information. Jobs are objects that manage asynchronous tasks such as running queries, loading data, and exporting data. Use CopyJobConfiguration for a job that copies an existing table. Use ExtractJobConfiguration for a job that exports a table to Google Cloud Storage. Use LoadJobConfiguration for a job that loads data from Google Cloud |
| com. |
A builder for JobInfo
objects. |
| com. |
A Google BigQuery Job statistics. |
| com. |
A Google BigQuery Copy Job statistics. |
| com. |
A Google BigQuery Extract Job statistics. |
| com. |
A Google BigQuery Load Job statistics. |
| com. |
A Google BigQuery Query Job statistics. |
| com. |
Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in ExtractStatistics. |
| com. |
|
| com. |
StatementType represents possible types of SQL statements reported as part of the QueryStatistics of a BigQuery job. |
| com. |
ReservationUsage contains information about a job's usage of a single reservation. |
| com. |
|
| com. |
A Google BigQuery Script statistics. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
A Google BigQuery Job status. Objects of this class can be examined when polling an asynchronous job to see if the job completed. |
| com. |
Possible states that a BigQuery Job can assume. |
| com. |
A type used in legacy SQL contexts. NOTE: some contexts use a mix of types; for example, for queries that use standard SQL, the return types are the legacy SQL types. See Also: https://cloud.google.com/bigquery/data-types |
| com. |
Google BigQuery load job configuration. A load job loads data from one of several formats into a table. Data is provided as URIs that point to objects in Google Cloud Storage. Load job configurations have JobConfiguration.Type#LOAD type. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
Represents statistics for metadata caching in BigLake tables. See Also: BigLake Tables |
| com. |
|
| com. |
A Google BigQuery ML Model. Objects of this class are immutable. Operations that modify the table like #update
return a new object. To get a |
| com. |
|
| com. |
|
| com. |
Google BigQuery ML model information. Models are not created directly via the API, but by issuing a CREATE MODEL query. See Also: CREATE MODEL statement |
| com. |
A builder for ModelInfo
objects. |
| com. |
A Google BigQuery Model table definition. This definition is used to represent a BigQuery ML model. See Also: BigQuery ML Model |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
A builder for ParquetOptions
objects. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
Google BigQuery Query Job configuration. A Query Job runs a query against BigQuery data. Query job configurations have JobConfiguration.Type#QUERY type. |
| com. |
|
| com. |
A value for a QueryParameter along with its type. A static factory method is provided for each of the possible types (e.g. #int64(Long) for StandardSQLTypeName.INT64). Alternatively, an instance can be constructed by calling #of(Object, Class) with the value and a Class object, which will use these mappings: |
| com. |
|
| com. |
|
| com. |
BigQuery provides diagnostic information about a completed query's execution plan (or query plan for short). The query plan describes a query as a series of stages, with each stage comprising a number of steps that read from data sources, perform a series of transformations on the input, and emit an output to a future stage (or the final result). This class contains information on a |
| com. |
Each query stage is made of a number of steps. This class contains information on a query step. See Also: Steps Metadata |
| com. |
|
| com. |
|
| com. |
|
| com. |
A builder for RangePartitioning
objects. |
| com. |
|
| com. |
A builder for Range
objects. |
| com. |
Represents BigQueryStorage Read client connection information. |
| com. |
|
| com. |
Represents Remote Function Options. Options for a remote user-defined function. |
| com. |
|
| com. |
A Google BigQuery Routine. Objects of this class are immutable. Operations that modify the routine like #update
return a new object. To get a |
| com. |
|
| com. |
An argument for a BigQuery Routine. |
| com. |
|
| com. |
RoutineId represents the identifier for a given Routine. |
| com. |
Google BigQuery routine information. A Routine is an API abstraction that encapsulates several related concepts inside the BigQuery service, including scalar user defined functions (UDFS) and stored procedures. |
| com. |
|
| com. |
This class represents the schema for a Google BigQuery Table or data source. |
| com. |
Represents Search statistics information of a search query. |
| com. |
|
| com. |
|
| com. |
|
| com. |
Represents Standard SQL data type information. |
| com. |
|
| com. |
A Google BigQuery SQL Field. |
| com. |
|
| com. |
A set of fields contained within a SQL STRUCT in Google BigQuery. |
| com. |
|
| com. |
Represents Standard SQL table type information. |
| com. |
|
| com. |
A Google BigQuery default table definition. This definition is used for standard, two-dimensional tables with individual records organized in rows, and a data type assigned to each column (also called a field). Individual fields within a record may contain nested and repeated children fields. Every table is described by a schema that describes field names, types, and other |
| com. |
|
| com. |
Google BigQuery Table's Streaming Buffer information. This class contains information on a table's streaming buffer as the estimated size in number of rows/bytes. |
| com. |
A Google BigQuery Table. Objects of this class are immutable. Operations that modify the table like #update
return a new object. To get a |
| com. |
A builder for Table
objects. |
| com. |
|
| com. |
|
| com. |
WriteChannel
implementation to stream data into a BigQuery table. Use #getJob()
to get the job used to insert streamed data. Please notice that #getJob()
returns null
until the channel is closed. |
| com. |
Base class for a Google BigQuery table definition. |
| com. |
Base builder for table definitions. |
| com. |
The table type. |
| com. |
Google BigQuery Table identity. |
| com. |
Google BigQuery table information. Use StandardTableDefinition to create simple BigQuery table. Use ViewDefinition to create a BigQuery view. Use ExternalTableDefinition to create a BigQuery a table backed by external data. See Also: Managing Tables |
| com. |
A builder for TableInfo
objects. |
| com. |
Represents Table level detail on the usage of metadata caching. |
| com. |
|
| com. |
|
| com. |
|
| com. |
Objects of this class allow to configure table partitioning based on time. By dividing a large table into smaller partitions, you can improve query performance and reduce the number of bytes billed by restricting the amount of data scanned. See Also: Partitioned Tables |
| com. |
|
| com. |
A specific timeline sample. This instruments work progress at a given point in time, providing information about work units active/pending/completed as well as cumulative slot-milliseconds. |
| com. |
|
| com. |
Google BigQuery User Defined Function. BigQuery supports user-defined functions (UDFs) written in JavaScript. A UDF is similar to the "Map" function in a MapReduce: it takes a single row as input and produces zero or more rows as output. The output can potentially have a different schema than the input. |
| com. |
Google BigQuery view table definition. BigQuery's views are logical views, not materialized views, which means that the query that defines the view is re-executed every time the view is queried. See Also: Views |
| com. |
|
| com. |
Google BigQuery Configuration for a load operation. A load configuration can be used to load data into a table with a com.google.cloud.WriteChannel ( BigQuery#writer(WriteChannelConfiguration) ). |
| com. |
Interfaces
| Interface | Description |
|---|---|
| com. |
An interface for Google Cloud BigQuery. See Also: Google Cloud BigQuery |
| com. |
|
| com. |
An interface for BigQuery factories. |
| com. |
|
| com. |
|
| com. |
A Connection is a session between a Java application and BigQuery. SQL statements are executed and results are returned within the context of a connection. |
| com. |
Common interface for a load configuration. A load configuration ( WriteChannelConfiguration ) can be used to load data into a table with a com.google.cloud.WriteChannel ( BigQuery#writer(WriteChannelConfiguration) ). A load configuration ( LoadJobConfiguration ) can also be used to create a load job ( JobInfo#of(JobConfiguration) ). |
| com. |
Enums
| Enum | Description |
|---|---|
| com. |
Types of BigQuery entities. |
| com. |
Fields of a BigQuery Dataset resource. See Also: Dataset Resource |
| com. |
|
| com. |
|
| com. |
Fields of a BigQuery Job resource. See Also: Job Resource |
| com. |
Fields of a BigQuery Model resource. See Also: Model Resource |
| com. |
Fields of a BigQuery Routine resource. See Also: Routine Resource |
| com. |
Fields of a BigQuery Table resource. See Also: Table Resource |
| com. |
Metadata of a BigQuery Table. See Also: Table Resource |
| com. |
Mode for a BigQuery Table field. Mode#NULLABLE
fields can be set to null
, Mode#REQUIRED
fields must be provided. Mode#REPEATED
fields can contain more
than one value. |
| com. |
The field value's attribute, giving information on the field's content type. |
| com. |
Type of a BigQuery Job. |
| com. |
Specifies whether the job is allowed to create new tables. |
| com. |
Specifies options relating to allowing the schema of the destination table to be updated as a side effect of the load or query job. |
| com. |
Specifies the action that occurs if the destination table already exists. |
| com. |
Job Creation Mode provides different options on job creation. |
| com. |
Priority levels for a query. If not specified the priority is assumed to be Priority#INTERACTIVE . |
| com. |
A type used in standard SQL contexts. For example, these types are used in queries with query parameters, which requires usage of standard SQL. See Also: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types |
| com. |
Reason for not using metadata caching for the table. |
| com. |
[Optional] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the interval is not specified, the default behavior is DAY. |
| com. |
Type of user-defined function. User defined functions can be provided inline as code blobs ( #INLINE ) or as a Google Cloud Storage URI ( #FROM_URI ). |
Exceptions
| Exception | Description |
|---|---|
| com. |
BigQuery service exception. See Also: Google Cloud BigQuery error codes |
| com. |
|
| com. |
BigQuery service exception. See Also: Google Cloud BigQuery error codes |
| com. |
Exception describing a failure of a job. |
