big_query_exports

Creates, updates, deletes, gets or lists a big_query_exports resource.

Overview

Name	big_query_exports
Type	Resource
Id	google.securitycenter.big_query_exports

Fields

The following fields are returned by SELECT queries:

folders_big_query_exports_get

Successful response

Name	Datatype	Description
name	string	The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
createTime	string (google-datetime)	Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
dataset	string	The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
description	string	The description of the export (max of 1024 characters).
filter	string	Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND. Restrictions have the form and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * = for all value types. * >, <, >=, <= for integer values. * :, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals true and false without quotes.
mostRecentEditor	string	Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
principal	string	Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
updateTime	string (google-datetime)	Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.

projects_big_query_exports_get

Successful response

Name	Datatype	Description
name	string	The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
createTime	string (google-datetime)	Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
dataset	string	The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
description	string	The description of the export (max of 1024 characters).
filter	string	Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND. Restrictions have the form and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * = for all value types. * >, <, >=, <= for integer values. * :, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals true and false without quotes.
mostRecentEditor	string	Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
principal	string	Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
updateTime	string (google-datetime)	Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.

organizations_big_query_exports_get

Successful response

Name	Datatype	Description
name	string	The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
createTime	string (google-datetime)	Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
dataset	string	The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
description	string	The description of the export (max of 1024 characters).
filter	string	Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND. Restrictions have the form and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * = for all value types. * >, <, >=, <= for integer values. * :, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals true and false without quotes.
mostRecentEditor	string	Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
principal	string	Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
updateTime	string (google-datetime)	Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.

folders_big_query_exports_list

Successful response

Name	Datatype	Description
name	string	The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
createTime	string (google-datetime)	Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
dataset	string	The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
description	string	The description of the export (max of 1024 characters).
filter	string	Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND. Restrictions have the form and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * = for all value types. * >, <, >=, <= for integer values. * :, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals true and false without quotes.
mostRecentEditor	string	Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
principal	string	Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
updateTime	string (google-datetime)	Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.

projects_big_query_exports_list

Successful response

Name	Datatype	Description
name	string	The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
createTime	string (google-datetime)	Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
dataset	string	The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
description	string	The description of the export (max of 1024 characters).
filter	string	Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND. Restrictions have the form and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * = for all value types. * >, <, >=, <= for integer values. * :, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals true and false without quotes.
mostRecentEditor	string	Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
principal	string	Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
updateTime	string (google-datetime)	Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.

organizations_big_query_exports_list

Successful response

Name	Datatype	Description
name	string	The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
createTime	string (google-datetime)	Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
dataset	string	The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
description	string	The description of the export (max of 1024 characters).
filter	string	Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND. Restrictions have the form and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * = for all value types. * >, <, >=, <= for integer values. * :, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals true and false without quotes.
mostRecentEditor	string	Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
principal	string	Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
updateTime	string (google-datetime)	Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
folders_big_query_exports_get	select	foldersId, bigQueryExportsId		Gets a BigQuery export.
projects_big_query_exports_get	select	projectsId, bigQueryExportsId		Gets a BigQuery export.
organizations_big_query_exports_get	select	organizationsId, bigQueryExportsId		Gets a BigQuery export.
folders_big_query_exports_list	select	foldersId	pageSize, pageToken	Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
projects_big_query_exports_list	select	projectsId	pageSize, pageToken	Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
organizations_big_query_exports_list	select	organizationsId	pageSize, pageToken	Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
folders_big_query_exports_create	insert	foldersId	bigQueryExportId	Creates a BigQuery export.
projects_big_query_exports_create	insert	projectsId	bigQueryExportId	Creates a BigQuery export.
organizations_big_query_exports_create	insert	organizationsId	bigQueryExportId	Creates a BigQuery export.
folders_big_query_exports_patch	update	foldersId, bigQueryExportsId	updateMask	Updates a BigQuery export.
projects_big_query_exports_patch	update	projectsId, bigQueryExportsId	updateMask	Updates a BigQuery export.
organizations_big_query_exports_patch	update	organizationsId, bigQueryExportsId	updateMask	Updates a BigQuery export.
folders_big_query_exports_delete	delete	foldersId, bigQueryExportsId		Deletes an existing BigQuery export.
projects_big_query_exports_delete	delete	projectsId, bigQueryExportsId		Deletes an existing BigQuery export.
organizations_big_query_exports_delete	delete	organizationsId, bigQueryExportsId		Deletes an existing BigQuery export.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bigQueryExportsId	string
foldersId	string
organizationsId	string
projectsId	string
bigQueryExportId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

folders_big_query_exports_get

Gets a BigQuery export.

SELECT
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime
FROM google.securitycenter.big_query_exports
WHERE foldersId = '{{ foldersId }}' -- required
AND bigQueryExportsId = '{{ bigQueryExportsId }}' -- required;

projects_big_query_exports_get

Gets a BigQuery export.

SELECT
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime
FROM google.securitycenter.big_query_exports
WHERE projectsId = '{{ projectsId }}' -- required
AND bigQueryExportsId = '{{ bigQueryExportsId }}' -- required;

organizations_big_query_exports_get

Gets a BigQuery export.

SELECT
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime
FROM google.securitycenter.big_query_exports
WHERE organizationsId = '{{ organizationsId }}' -- required
AND bigQueryExportsId = '{{ bigQueryExportsId }}' -- required;

folders_big_query_exports_list

Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.

SELECT
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime
FROM google.securitycenter.big_query_exports
WHERE foldersId = '{{ foldersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

projects_big_query_exports_list

Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.

SELECT
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime
FROM google.securitycenter.big_query_exports
WHERE projectsId = '{{ projectsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

organizations_big_query_exports_list

Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.

SELECT
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime
FROM google.securitycenter.big_query_exports
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

folders_big_query_exports_create

Creates a BigQuery export.

INSERT INTO google.securitycenter.big_query_exports (
data__name,
data__description,
data__filter,
data__dataset,
foldersId,
bigQueryExportId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ filter }}',
'{{ dataset }}',
'{{ foldersId }}',
'{{ bigQueryExportId }}'
RETURNING
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime
;

projects_big_query_exports_create

Creates a BigQuery export.

INSERT INTO google.securitycenter.big_query_exports (
data__name,
data__description,
data__filter,
data__dataset,
projectsId,
bigQueryExportId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ filter }}',
'{{ dataset }}',
'{{ projectsId }}',
'{{ bigQueryExportId }}'
RETURNING
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime
;

organizations_big_query_exports_create

Creates a BigQuery export.

INSERT INTO google.securitycenter.big_query_exports (
data__name,
data__description,
data__filter,
data__dataset,
organizationsId,
bigQueryExportId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ filter }}',
'{{ dataset }}',
'{{ organizationsId }}',
'{{ bigQueryExportId }}'
RETURNING
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: big_query_exports
  props:
    - name: foldersId
      value: string
      description: Required parameter for the big_query_exports resource.
    - name: projectsId
      value: string
      description: Required parameter for the big_query_exports resource.
    - name: organizationsId
      value: string
      description: Required parameter for the big_query_exports resource.
    - name: name
      value: string
      description: >
        The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
        
    - name: description
      value: string
      description: >
        The description of the export (max of 1024 characters).
        
    - name: filter
      value: string
      description: >
        Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
        
    - name: dataset
      value: string
      description: >
        The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
        
    - name: bigQueryExportId
      value: string

UPDATE examples

folders_big_query_exports_patch

Updates a BigQuery export.

UPDATE google.securitycenter.big_query_exports
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__filter = '{{ filter }}',
data__dataset = '{{ dataset }}'
WHERE 
foldersId = '{{ foldersId }}' --required
AND bigQueryExportsId = '{{ bigQueryExportsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime;

projects_big_query_exports_patch

Updates a BigQuery export.

UPDATE google.securitycenter.big_query_exports
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__filter = '{{ filter }}',
data__dataset = '{{ dataset }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND bigQueryExportsId = '{{ bigQueryExportsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime;

organizations_big_query_exports_patch

Updates a BigQuery export.

UPDATE google.securitycenter.big_query_exports
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__filter = '{{ filter }}',
data__dataset = '{{ dataset }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND bigQueryExportsId = '{{ bigQueryExportsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
dataset,
description,
filter,
mostRecentEditor,
principal,
updateTime;

DELETE examples

folders_big_query_exports_delete

Deletes an existing BigQuery export.

DELETE FROM google.securitycenter.big_query_exports
WHERE foldersId = '{{ foldersId }}' --required
AND bigQueryExportsId = '{{ bigQueryExportsId }}' --required;

projects_big_query_exports_delete

Deletes an existing BigQuery export.

DELETE FROM google.securitycenter.big_query_exports
WHERE projectsId = '{{ projectsId }}' --required
AND bigQueryExportsId = '{{ bigQueryExportsId }}' --required;

organizations_big_query_exports_delete

Deletes an existing BigQuery export.

DELETE FROM google.securitycenter.big_query_exports
WHERE organizationsId = '{{ organizationsId }}' --required
AND bigQueryExportsId = '{{ bigQueryExportsId }}' --required;