Reference documentation and code samples for the Data Loss Prevention V2 Client class TimespanConfig.
Configuration of the timespan of the items to include in scanning.
Currently only supported when inspecting Cloud Storage and BigQuery.
Generated from protobuf message google.privacy.dlp.v2.StorageConfig.TimespanConfig
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ start_time |
Google\Protobuf\Timestamp
Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. |
↳ end_time |
Google\Protobuf\Timestamp
Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. |
↳ timestamp_field |
Google\Cloud\Dlp\V2\FieldId
Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a
TIMESTAMP. See the known issue related to this operation.
|
↳ enable_auto_population_of_timespan_config |
bool
When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. |
getStartTime
Exclude files, tables, or rows older than this value.
If not set, no lower time limit is applied.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
Exclude files, tables, or rows older than this value.
If not set, no lower time limit is applied.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Exclude files, tables, or rows newer than this value.
If not set, no upper time limit is applied.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
Exclude files, tables, or rows newer than this value.
If not set, no upper time limit is applied.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTimestampField
Specification of the field containing the timestamp of scanned items.
Used for data sources like Datastore and BigQuery.
For BigQuery
If this value is not specified and the table was modified between the
given start and end times, the entire table will be scanned. If this
value is specified, then rows are filtered based on the given start and
end times. Rows with a NULL value in the provided BigQuery column are
skipped.
Valid data types of the provided BigQuery column are: INTEGER, DATE,
TIMESTAMP, and DATETIME.
If your BigQuery table is partitioned at ingestion
time,
you can use any of the following pseudo-columns as your timestamp field.
When used with Cloud DLP, these pseudo-column names are case sensitive.
_PARTITIONTIME_PARTITIONDATE_PARTITION_LOAD_TIME
TIMESTAMP.
See the
known issue
related to this operation.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\FieldId|null | |
hasTimestampField
clearTimestampField
setTimestampField
Specification of the field containing the timestamp of scanned items.
Used for data sources like Datastore and BigQuery.
For BigQuery
If this value is not specified and the table was modified between the
given start and end times, the entire table will be scanned. If this
value is specified, then rows are filtered based on the given start and
end times. Rows with a NULL value in the provided BigQuery column are
skipped.
Valid data types of the provided BigQuery column are: INTEGER, DATE,
TIMESTAMP, and DATETIME.
If your BigQuery table is partitioned at ingestion
time,
you can use any of the following pseudo-columns as your timestamp field.
When used with Cloud DLP, these pseudo-column names are case sensitive.
_PARTITIONTIME_PARTITIONDATE_PARTITION_LOAD_TIME
TIMESTAMP.
See the
known issue
related to this operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\FieldId
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableAutoPopulationOfTimespanConfig
When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger.
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnableAutoPopulationOfTimespanConfig
When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |