- JSON representation
- TableInsertRequest
- Table
- TableName
- TableInfo
- TableViewDefinition
- EncryptionInfo
- TableUpdateRequest
- DatasetListRequest
- DatasetInsertRequest
- Dataset
- DatasetName
- DatasetInfo
- BigQueryAcl
- Entry
- DatasetUpdateRequest
- JobInsertRequest
- Job
- JobName
- JobConfiguration
- Query
- TableDefinition
- Load
- Extract
- TableCopy
- JobStatus
- Status
- JobStatistics
- ReservationResourceUsage
- JobQueryRequest
- JobGetQueryResultsRequest
- TableDataListRequest
- SetIamPolicyRequest
- Policy
- Binding
- Expr
- AuditConfig
- AuditLogConfig
- TableInsertResponse
- TableUpdateResponse
- DatasetInsertResponse
- DatasetUpdateResponse
- JobInsertResponse
- JobQueryResponse
- JobGetQueryResultsResponse
- JobQueryDoneResponse
- JobCompletedEvent
- TableDataReadEvent
BigQuery request and response messages for audit log. Note: Table.schema
has been deprecated in favor of Table.schemaJson
. Table.schema
may continue to be present in your logs during this transition.
JSON representation | |
---|---|
{ "jobCompletedEvent": { object( |
Fields | ||
---|---|---|
jobCompletedEvent |
A job completion event. |
|
tableDataReadEvents[] |
Information about the table access events. |
|
Union field request . Request data for each BigQuery method. request can be only one of the following: |
||
tableInsertRequest |
Table insert request. |
|
tableUpdateRequest |
Table update request. |
|
datasetListRequest |
Dataset list request. |
|
datasetInsertRequest |
Dataset insert request. |
|
datasetUpdateRequest |
Dataset update request. |
|
jobInsertRequest |
Job insert request. |
|
jobQueryRequest |
Job query request. |
|
jobGetQueryResultsRequest |
Job get query results request. |
|
tableDataListRequest |
Table data-list request. |
|
setIamPolicyRequest |
Iam policy request. |
|
Union field response . Response data for each BigQuery method. response can be only one of the following: |
||
tableInsertResponse |
Table insert response. |
|
tableUpdateResponse |
Table update response. |
|
datasetInsertResponse |
Dataset insert response. |
|
datasetUpdateResponse |
Dataset update response. |
|
jobInsertResponse |
Job insert response. |
|
jobQueryResponse |
Job query response. |
|
jobGetQueryResultsResponse |
Job get query results response. |
|
jobQueryDoneResponse |
Deprecated: Job query-done response. Use this information for usage analysis. |
|
policyResponse |
Iam Policy. |
TableInsertRequest
Table insert request.
JSON representation | |
---|---|
{
"resource": {
object( |
Fields | |
---|---|
resource |
The new table. |
Table
Describes a BigQuery table. See the Table API resource for more details on individual fields. Note: Table.schema
has been deprecated in favor of Table.schemaJson
. Table.schema
may continue to be present in your logs during this transition.
JSON representation | |
---|---|
{ "tableName": { object( |
Fields | |
---|---|
tableName |
The name of the table. |
info |
User-provided metadata for the table. |
schemaJson |
A JSON representation of the table's schema. |
view |
If present, this is a virtual table defined by a SQL query. |
expireTime |
The expiration date for the table, after which the table is deleted and the storage reclaimed. If not present, the table persists indefinitely. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
createTime |
The time the table was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
truncateTime |
The time the table was last truncated by an operation with a A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
updateTime |
The time the table was last modified. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
encryption |
The table encryption information. Set when non-default encryption is used. |
TableName
The fully-qualified name for a table.
JSON representation | |
---|---|
{ "projectId": string, "datasetId": string, "tableId": string } |
Fields | |
---|---|
projectId |
The project ID. |
datasetId |
The dataset ID within the project. |
tableId |
The table ID of the table within the dataset. |
TableInfo
User-provided metadata for a table.
JSON representation | |
---|---|
{ "friendlyName": string, "description": string, "labels": { string: string, ... } } |
Fields | |
---|---|
friendlyName |
A short name for the table, such as |
description |
A long description, perhaps several paragraphs, describing the table contents in detail. |
labels |
Labels provided for the table. An object containing a list of |
TableViewDefinition
Describes a virtual table defined by a SQL query.
JSON representation | |
---|---|
{ "query": string } |
Fields | |
---|---|
query |
SQL query defining the view. |
EncryptionInfo
Describes encryption properties for a table or a job
JSON representation | |
---|---|
{ "kmsKeyName": string } |
Fields | |
---|---|
kmsKeyName |
unique identifier for cloud kms key |
TableUpdateRequest
Table update request.
JSON representation | |
---|---|
{
"resource": {
object( |
Fields | |
---|---|
resource |
The table to be updated. |
DatasetListRequest
Dataset list request.
JSON representation | |
---|---|
{ "listAll": boolean } |
Fields | |
---|---|
listAll |
Whether to list all datasets, including hidden ones. |
DatasetInsertRequest
Dataset insert request.
JSON representation | |
---|---|
{
"resource": {
object( |
Fields | |
---|---|
resource |
The dataset to be inserted. |
Dataset
BigQuery dataset information. See the Dataset API resource for more details on individual fields.
JSON representation | |
---|---|
{ "datasetName": { object( |
Fields | |
---|---|
datasetName |
The name of the dataset. |
info |
User-provided metadata for the dataset. |
createTime |
The time the dataset was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
updateTime |
The time the dataset was last modified. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
acl |
The access control list for the dataset. |
defaultTableExpireDuration |
If this field is present, each table that does not specify an expiration time is assigned an expiration time by adding this duration to the table's A duration in seconds with up to nine fractional digits, terminated by ' |
DatasetName
The fully-qualified name for a dataset.
JSON representation | |
---|---|
{ "projectId": string, "datasetId": string } |
Fields | |
---|---|
projectId |
The project ID. |
datasetId |
The dataset ID within the project. |
DatasetInfo
User-provided metadata for a dataset.
JSON representation | |
---|---|
{ "friendlyName": string, "description": string, "labels": { string: string, ... } } |
Fields | |
---|---|
friendlyName |
A short name for the dataset, such as |
description |
A long description, perhaps several paragraphs, describing the dataset contents in detail. |
labels |
Labels provided for the dataset. An object containing a list of |
BigQueryAcl
An access control list.
JSON representation | |
---|---|
{
"entries": [
{
object( |
Fields | |
---|---|
entries[] |
Access control entry list. |
Entry
Access control entry.
JSON representation | |
---|---|
{
"role": string,
"groupEmail": string,
"userEmail": string,
"domain": string,
"specialGroup": string,
"viewName": {
object( |
Fields | |
---|---|
role |
The granted role, which can be |
groupEmail |
Grants access to a group identified by an email address. |
userEmail |
Grants access to a user identified by an email address. |
domain |
Grants access to all members of a domain. |
specialGroup |
Grants access to special groups. Valid groups are |
viewName |
Grants access to a BigQuery View. |
DatasetUpdateRequest
Dataset update request.
JSON representation | |
---|---|
{
"resource": {
object( |
Fields | |
---|---|
resource |
The dataset to be updated. |
JobInsertRequest
Job insert request.
JSON representation | |
---|---|
{
"resource": {
object( |
Fields | |
---|---|
resource |
Job insert request. |
Job
Describes a job.
JSON representation | |
---|---|
{ "jobName": { object( |
Fields | |
---|---|
jobName |
Job name. |
jobConfiguration |
Job configuration. |
jobStatus |
Job status. |
jobStatistics |
Job statistics. |
JobName
The fully-qualified name for a job.
JSON representation | |
---|---|
{ "projectId": string, "jobId": string, "location": string } |
Fields | |
---|---|
projectId |
The project ID. |
jobId |
The job ID within the project. |
location |
The job location. |
JobConfiguration
Job configuration information. See the Jobs API resource for more details on individual fields.
JSON representation | |
---|---|
{ "dryRun": boolean, "labels": { string: string, ... }, // Union field |
Fields | ||
---|---|---|
dryRun |
If true, don't actually run the job. Just check that it would run. |
|
labels |
Labels provided for the job. An object containing a list of |
|
Union field configuration . Job configuration information. configuration can be only one of the following: |
||
query |
Query job information. |
|
load |
Load job information. |
|
extract |
Extract job information. |
|
tableCopy |
TableCopy job information. |
Query
Describes a query job, which executes a SQL-like query.
JSON representation | |
---|---|
{ "query": string, "destinationTable": { object( |
Fields | |
---|---|
query |
The SQL query to run. |
destinationTable |
The table where results are written. |
createDisposition |
Describes when a job is allowed to create a table: |
writeDisposition |
Describes how writes affect existing tables: |
defaultDataset |
If a table name is specified without a dataset in a query, this dataset will be added to table name. |
tableDefinitions[] |
Describes data sources outside BigQuery, if needed. |
queryPriority |
Describes the priority given to the query: |
destinationTableEncryption |
Result table encryption information. Set when non-default encryption is used. |
statementType |
Type of the statement (e.g. SELECT, INSERT, CREATE_TABLE, CREATE_MODEL..) |
TableDefinition
Describes an external data source used in a query.
JSON representation | |
---|---|
{ "name": string, "sourceUris": [ string ] } |
Fields | |
---|---|
name |
Name of the table, used in queries. |
sourceUris[] |
Google Cloud Storage URIs for the data to be imported. |
Load
Describes a load job, which loads data from an external source via the import pipeline.
JSON representation | |
---|---|
{ "sourceUris": [ string ], "schemaJson": string, "destinationTable": { object( |
Fields | |
---|---|
sourceUris[] |
URIs for the data to be imported. Only Google Cloud Storage URIs are supported. |
schemaJson |
The table schema in JSON format representation of a TableSchema. |
destinationTable |
The table where the imported data is written. |
createDisposition |
Describes when a job is allowed to create a table: |
writeDisposition |
Describes how writes affect existing tables: |
destinationTableEncryption |
Result table encryption information. Set when non-default encryption is used. |
Extract
Describes an extract job, which exports data to an external source via the export pipeline.
JSON representation | |
---|---|
{
"destinationUris": [
string
],
"sourceTable": {
object( |
Fields | |
---|---|
destinationUris[] |
Google Cloud Storage URIs where extracted data should be written. |
sourceTable |
The source table. |
TableCopy
Describes a copy job, which copies an existing table to another table.
JSON representation | |
---|---|
{ "sourceTables": [ { object( |
Fields | |
---|---|
sourceTables[] |
Source tables. |
destinationTable |
Destination table. |
createDisposition |
Describes when a job is allowed to create a table: |
writeDisposition |
Describes how writes affect existing tables: |
destinationTableEncryption |
Result table encryption information. Set when non-default encryption is used. |
JobStatus
Running state of a job.
JSON representation | |
---|---|
{ "state": string, "error": { object( |
Fields | |
---|---|
state |
State of a job: |
error |
If the job did not complete successfully, this field describes why. |
additionalErrors[] |
Errors encountered during the running of the job. Do not necessarily mean that the job has completed or was unsuccessful. |
Status
The Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be:
- Simple to use and understand for most users
- Flexible enough to meet unexpected needs
Overview
The Status
message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code
, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc
that can be used for common error conditions.
Language mapping
The Status
message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status
message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.
Other uses
The error model and the Status
message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.
Example uses of this error model include:
Partial errors. If a service needs to return partial errors to the client, it may embed the
Status
in the normal response to indicate the partial errors.Workflow errors. A typical workflow has multiple steps. Each step may have a
Status
message for error reporting.Batch operations. If a client uses batch request and batch response, the
Status
message should be used directly inside batch response, one for each error sub-response.Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the
Status
message.Logging. If some API errors are stored in logs, the message
Status
could be used directly after any stripping needed for security/privacy reasons.
JSON representation | |
---|---|
{ "code": number, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Fields | |
---|---|
code |
The status code, which should be an enum value of |
message |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
details[] |
A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field |
JobStatistics
Job statistics that may change after a job starts. NEXT ID: 16
JSON representation | |
---|---|
{ "createTime": string, "startTime": string, "endTime": string, "totalProcessedBytes": string, "totalBilledBytes": string, "billingTier": number, "totalSlotMs": string, "reservationUsage": [ { object( |
Fields | |
---|---|
createTime |
Time when the job was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
startTime |
Time when the job started. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
endTime |
Time when the job ended. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
totalProcessedBytes |
Total bytes processed for a job. |
totalBilledBytes |
Processed bytes, adjusted by the job's CPU usage. |
billingTier |
The tier assigned by CPU-based billing. |
totalSlotMs |
The total number of slot-ms consumed by the query job. |
reservationUsage[] |
Reservation usage. |
referencedTables[] |
The first N tables accessed by the query job. Older queries that reference a large number of tables may not have all of their tables in this list. You can use the totalTablesProcessed count to know how many total tables were read in the query. For new queries, there is currently no limit. |
totalTablesProcessed |
Total number of unique tables referenced in the query. |
referencedViews[] |
The first N views accessed by the query job. Older queries that reference a large number of views may not have all of their views in this list. You can use the totalTablesProcessed count to know how many total tables were read in the query. For new queries, there is currently no limit. |
totalViewsProcessed |
Total number of unique views referenced in the query. |
queryOutputRowCount |
Number of output rows produces by the query job. |
totalLoadOutputBytes |
Total bytes loaded for an import job. |
ReservationResourceUsage
Job resource usage breakdown by reservation.
JSON representation | |
---|---|
{ "name": string, "slotMs": string } |
Fields | |
---|---|
name |
Reservation name or "unreserved" for on-demand resources usage. |
slotMs |
Total slot milliseconds used by the reservation for a particular job. |
JobQueryRequest
Job query request.
JSON representation | |
---|---|
{
"query": string,
"maxResults": number,
"defaultDataset": {
object( |
Fields | |
---|---|
query |
The query. |
maxResults |
The maximum number of results. |
defaultDataset |
The default dataset for tables that do not have a dataset specified. |
projectId |
Project that the query should be charged to. |
dryRun |
If true, don't actually run the job. Just check that it would run. |
JobGetQueryResultsRequest
Job getQueryResults request.
JSON representation | |
---|---|
{ "maxResults": number, "startRow": string } |
Fields | |
---|---|
maxResults |
Maximum number of results to return. |
startRow |
Zero-based row number at which to start. |
TableDataListRequest
Table data-list request.
JSON representation | |
---|---|
{ "startRow": string, "maxResults": number } |
Fields | |
---|---|
startRow |
Starting row offset. |
maxResults |
Maximum number of results to return. |
SetIamPolicyRequest
Request message for SetIamPolicy
method.
JSON representation | |
---|---|
{
"resource": string,
"policy": {
object( |
Fields | |
---|---|
resource |
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
REQUIRED: The complete policy to be applied to the |
updateMask |
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. A comma-separated list of fully qualified names of fields. Example: |
Policy
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
A Policy
consists of a list of bindings
. A binding
binds a list of members
to a role
, where the members can be user accounts, Google groups, Google domains, and service accounts. A role
is a named list of permissions defined by IAM.
JSON Example
{
"bindings": [
{
"role": "roles/owner",
"members": [
"user:mike@example.com",
"group:admins@example.com",
"domain:google.com",
"serviceAccount:my-other-app@appspot.gserviceaccount.com"
]
},
{
"role": "roles/viewer",
"members": ["user:sean@example.com"]
}
]
}
YAML Example
bindings:
- members:
- user:mike@example.com
- group:admins@example.com
- domain:google.com
- serviceAccount:my-other-app@appspot.gserviceaccount.com
role: roles/owner
- members:
- user:sean@example.com
role: roles/viewer
For a description of IAM and its features, see the IAM developer's guide.
JSON representation | |
---|---|
{ "version": number, "bindings": [ { object( |
Fields | |
---|---|
version |
Deprecated. |
bindings[] |
Associates a list of |
auditConfigs[] |
Specifies cloud audit logging configuration for this policy. |
etag |
If no A base64-encoded string. |
Binding
Associates members
with a role
.
JSON representation | |
---|---|
{
"role": string,
"members": [
string
],
"condition": {
object( |
Fields | |
---|---|
role |
Role that is assigned to |
members[] |
Specifies the identities requesting access for a Cloud Platform resource.
|
condition |
Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. |
Expr
Represents an expression text. Example:
title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"
JSON representation | |
---|---|
{ "expression": string, "title": string, "description": string, "location": string } |
Fields | |
---|---|
expression |
Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. |
title |
An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
description |
An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
location |
An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
AuditConfig
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
If there are AuditConfigs for both allServices
and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exemptedMembers in each AuditLogConfig are exempted.
Example Policy with multiple AuditConfigs:
{
"auditConfigs": [
{
"service": "allServices"
"auditLogConfigs": [
{
"logType": "DATA_READ",
"exemptedMembers": [
"user:foo@gmail.com"
]
},
{
"logType": "DATA_WRITE",
},
{
"logType": "ADMIN_READ",
}
]
},
{
"service": "fooservice.googleapis.com"
"auditLogConfigs": [
{
"logType": "DATA_READ",
},
{
"logType": "DATA_WRITE",
"exemptedMembers": [
"user:bar@gmail.com"
]
}
]
}
]
}
For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
JSON representation | |
---|---|
{
"service": string,
"auditLogConfigs": [
{
object( |
Fields | |
---|---|
service |
Specifies a service that will be enabled for audit logging. For example, |
auditLogConfigs[] |
The configuration for logging of each type of permission. |
AuditLogConfig
Provides the configuration for logging a type of permissions. Example:
{
"auditLogConfigs": [
{
"logType": "DATA_READ",
"exemptedMembers": [
"user:foo@gmail.com"
]
},
{
"logType": "DATA_WRITE",
}
]
}
This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging.
JSON representation | |
---|---|
{
"logType": enum( |
Fields | |
---|---|
logType |
The log type that this config enables. |
exemptedMembers[] |
Specifies the identities that do not cause logging for this type of permission. Follows the same format of |
TableInsertResponse
Table insert response.
JSON representation | |
---|---|
{
"resource": {
object( |
Fields | |
---|---|
resource |
Final state of the inserted table. |
TableUpdateResponse
Table update response.
JSON representation | |
---|---|
{
"resource": {
object( |
Fields | |
---|---|
resource |
Final state of the updated table. |
DatasetInsertResponse
Dataset insert response.
JSON representation | |
---|---|
{
"resource": {
object( |
Fields | |
---|---|
resource |
Final state of the inserted dataset. |
DatasetUpdateResponse
Dataset update response.
JSON representation | |
---|---|
{
"resource": {
object( |
Fields | |
---|---|
resource |
Final state of the updated dataset. |
JobInsertResponse
Job insert response.
JSON representation | |
---|---|
{
"resource": {
object( |
Fields | |
---|---|
resource |
Job insert response. |
JobQueryResponse
Job query response.
JSON representation | |
---|---|
{
"totalResults": string,
"job": {
object( |
Fields | |
---|---|
totalResults |
The total number of rows in the full query result set. |
job |
Information about the queried job. |
JobGetQueryResultsResponse
Job getQueryResults response.
JSON representation | |
---|---|
{
"totalResults": string,
"job": {
object( |
Fields | |
---|---|
totalResults |
Total number of results in query results. |
job |
The job that was created to run the query. It completed if |
JobQueryDoneResponse
Job getQueryDone response.
JSON representation | |
---|---|
{
"job": {
object( |
Fields | |
---|---|
job |
The job and status information. The job completed if |
JobCompletedEvent
Query job completed event.
JSON representation | |
---|---|
{
"eventName": string,
"job": {
object( |
Fields | |
---|---|
eventName |
Name of the event. |
job |
Job information. |
TableDataReadEvent
Table data read event. Only present for tables, not views, and is only included in the log record for the project that owns the table.
JSON representation | |
---|---|
{
"tableName": {
object( |
Fields | |
---|---|
tableName |
Name of the accessed table. |
referencedFields[] |
A list of referenced fields. This information is not included by default. To enable this in the logs, please contact BigQuery support or open a bug in the BigQuery issue tracker. |