Google Cloud Security Command Center V2 Client - Class BigQueryExport (2.0.3)

Reference documentation and code samples for the Google Cloud Security Command Center V2 Client class BigQueryExport.

Configures how to deliver Findings to BigQuery Instance.

Generated from protobuf message google.cloud.securitycenter.v2.BigQueryExport

Namespace

Google \ Cloud \ SecurityCenter \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id} + folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id} + projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id} This field is provided in responses, and is ignored when provided in create requests.
↳ 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 <field> <operator> <value> 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.
↳ 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 (_).
↳ create_time Google\Protobuf\Timestamp

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.
↳ update_time Google\Protobuf\Timestamp

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.
↳ most_recent_editor 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.

getName

Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name.

The following list shows some examples: + organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}

  • folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id} + projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id} This field is provided in responses, and is ignored when provided in create requests.
Returns
Type Description
string

setName

Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name.

The following list shows some examples: + organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}

  • folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id} + projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id} This field is provided in responses, and is ignored when provided in create requests.
Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

The description of the export (max of 1024 characters).

Returns
Type Description
string

setDescription

The description of the export (max of 1024 characters).

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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 <field> <operator> <value> 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.
Returns
Type Description
string

setFilter

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 <field> <operator> <value> 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.
Parameter
Name Description
var string
Returns
Type Description
$this

getDataset

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 (_).

Returns
Type Description
string

setDataset

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 (_).

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

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.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getMostRecentEditor

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.

Returns
Type Description
string

setMostRecentEditor

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getPrincipal

Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.

Returns
Type Description
string

setPrincipal

Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.

Parameter
Name Description
var string
Returns
Type Description
$this