Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DataSourceExportSettings.
The export settings for a data source.
Generated from protobuf message google.cloud.chronicle.v1.DataSourceExportSettings
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ enabled |
bool
Required. Whether the data source is enabled for export. |
↳ retention_days |
int
Required. The retention period for the data source in days. |
↳ latest_export_job_state |
int
Output only. The state of the latest data source export job. |
↳ data_freshness_time |
Google\Protobuf\Timestamp
Output only. The data freshness of the given export which represents the time bucket at which the latest event was exported. |
↳ data_volume |
int|string
Output only. The stored data volume of all the exports. |
getEnabled
Required. Whether the data source is enabled for export.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnabled
Required. Whether the data source is enabled for export.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRetentionDays
Required. The retention period for the data source in days.
| Returns | |
|---|---|
| Type | Description |
int |
|
setRetentionDays
Required. The retention period for the data source in days.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLatestExportJobState
Output only. The state of the latest data source export job.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type LatestExportJobState. |
setLatestExportJobState
Output only. The state of the latest data source export job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type LatestExportJobState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataFreshnessTime
Output only. The data freshness of the given export which represents the time bucket at which the latest event was exported.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasDataFreshnessTime
clearDataFreshnessTime
setDataFreshnessTime
Output only. The data freshness of the given export which represents the time bucket at which the latest event was exported.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataVolume
Output only. The stored data volume of all the exports.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setDataVolume
Output only. The stored data volume of all the exports.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|