Google Cloud Chronicle V1 Client - Class BigQueryExport (0.4.0)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class BigQueryExport.

This resource represents the BigQuery export configuration for a Chronicle instance which includes Google Cloud Platform resources like Cloud Storage buckets, BigQuery datasets etc and the export settings for each data source.

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the BigQueryExport. Format: projects/{project}/locations/{location}/instances/{instance}/bigQueryExport

↳ provisioned bool

Output only. Whether the BigQueryExport has been provisioned for the Chronicle instance.

↳ big_query_export_package int

Output only. The BigQueryExportPackage entitled for the Chronicle instance.

↳ entity_graph_settings DataSourceExportSettings

Optional. The export settings for the Entity Graph data source.

↳ ioc_matches_settings DataSourceExportSettings

Optional. The export settings for the IOC Matches data source.

↳ rule_detections_settings DataSourceExportSettings

Optional. The export settings for the Rule Detections data source.

↳ udm_events_aggregates_settings DataSourceExportSettings

Optional. The export settings for the UDM Events Aggregates data source.

↳ udm_events_settings DataSourceExportSettings

Optional. The export settings for the UDM Events data source.

getName

Identifier. The resource name of the BigQueryExport.

Format: projects/{project}/locations/{location}/instances/{instance}/bigQueryExport

Returns
Type Description
string

setName

Identifier. The resource name of the BigQueryExport.

Format: projects/{project}/locations/{location}/instances/{instance}/bigQueryExport

Parameter
Name Description
var string
Returns
Type Description
$this

getProvisioned

Output only. Whether the BigQueryExport has been provisioned for the Chronicle instance.

Returns
Type Description
bool

setProvisioned

Output only. Whether the BigQueryExport has been provisioned for the Chronicle instance.

Parameter
Name Description
var bool
Returns
Type Description
$this

getBigQueryExportPackage

Output only. The BigQueryExportPackage entitled for the Chronicle instance.

Returns
Type Description
int Enum of type BigQueryExportPackage.

setBigQueryExportPackage

Output only. The BigQueryExportPackage entitled for the Chronicle instance.

Parameter
Name Description
var int

Enum of type BigQueryExportPackage.

Returns
Type Description
$this

getEntityGraphSettings

Optional. The export settings for the Entity Graph data source.

Returns
Type Description
DataSourceExportSettings|null

hasEntityGraphSettings

clearEntityGraphSettings

setEntityGraphSettings

Optional. The export settings for the Entity Graph data source.

Parameter
Name Description
var DataSourceExportSettings
Returns
Type Description
$this

getIocMatchesSettings

Optional. The export settings for the IOC Matches data source.

Returns
Type Description
DataSourceExportSettings|null

hasIocMatchesSettings

clearIocMatchesSettings

setIocMatchesSettings

Optional. The export settings for the IOC Matches data source.

Parameter
Name Description
var DataSourceExportSettings
Returns
Type Description
$this

getRuleDetectionsSettings

Optional. The export settings for the Rule Detections data source.

Returns
Type Description
DataSourceExportSettings|null

hasRuleDetectionsSettings

clearRuleDetectionsSettings

setRuleDetectionsSettings

Optional. The export settings for the Rule Detections data source.

Parameter
Name Description
var DataSourceExportSettings
Returns
Type Description
$this

getUdmEventsAggregatesSettings

Optional. The export settings for the UDM Events Aggregates data source.

Returns
Type Description
DataSourceExportSettings|null

hasUdmEventsAggregatesSettings

clearUdmEventsAggregatesSettings

setUdmEventsAggregatesSettings

Optional. The export settings for the UDM Events Aggregates data source.

Parameter
Name Description
var DataSourceExportSettings
Returns
Type Description
$this

getUdmEventsSettings

Optional. The export settings for the UDM Events data source.

Returns
Type Description
DataSourceExportSettings|null

hasUdmEventsSettings

clearUdmEventsSettings

setUdmEventsSettings

Optional. The export settings for the UDM Events data source.

Parameter
Name Description
var DataSourceExportSettings
Returns
Type Description
$this