Google Cloud Security Command Center V1 Client - Class BigQueryExport (1.13.1)

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

Configures how to deliver Findings to BigQuery Instance.

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ 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.
`↳ 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 big query 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 big 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 big query 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, upload data to the big query dataset.

getName

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.

Generated from protobuf field string name = 1;

Returns
Type	Description
`string`

setName

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

Generated from protobuf field string name = 1;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

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

Generated from protobuf field string description = 2;

Returns
Type	Description
`string`

setDescription

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

Generated from protobuf field string description = 2;

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.

Generated from protobuf field string filter = 3;

Returns
Type	Description
`string`

setFilter

= 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.

Generated from protobuf field string filter = 3;

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

Generated from protobuf field string dataset = 4;

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

Generated from protobuf field string dataset = 4;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time at which the big query export was created.

This field is set by the server and will be ignored if provided on export on creation.

Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which the big query export was created.

This field is set by the server and will be ignored if provided on export on creation.

Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The most recent time at which the big export was updated.

This field is set by the server and will be ignored if provided on export creation or update.

Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The most recent time at which the big export was updated.

This field is set by the server and will be ignored if provided on export creation or update.

Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getMostRecentEditor

Output only. Email address of the user who last edited the big query export.

This field is set by the server and will be ignored if provided on export creation or update.

Generated from protobuf field string most_recent_editor = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`string`

setMostRecentEditor

Output only. Email address of the user who last edited the big query export.

This field is set by the server and will be ignored if provided on export creation or update.

Generated from protobuf field string most_recent_editor = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPrincipal

Output only. The service account that needs permission to create table, upload data to the big query dataset.

Generated from protobuf field string principal = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`string`

setPrincipal

Output only. The service account that needs permission to create table, upload data to the big query dataset.

Generated from protobuf field string principal = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`