Class StorageConfig.TimespanConfig.Builder (3.49.0) 

public static final class StorageConfig.TimespanConfig.Builder extends GeneratedMessageV3.Builder<StorageConfig.TimespanConfig.Builder> implements StorageConfig.TimespanConfigOrBuilder

Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery.

Protobuf type google.privacy.dlp.v2.StorageConfig.TimespanConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StorageConfig.TimespanConfig.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StorageConfig.TimespanConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides

build()

public StorageConfig.TimespanConfig build()
Returns
Type Description
StorageConfig.TimespanConfig

buildPartial()

public StorageConfig.TimespanConfig buildPartial()
Returns
Type Description
StorageConfig.TimespanConfig

clear()

public StorageConfig.TimespanConfig.Builder clear()
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides

clearEnableAutoPopulationOfTimespanConfig()

public StorageConfig.TimespanConfig.Builder clearEnableAutoPopulationOfTimespanConfig()

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.

For BigQuery

Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows.

See the known issue related to this operation.

bool enable_auto_population_of_timespan_config = 4;

Returns
Type Description
StorageConfig.TimespanConfig.Builder

This builder for chaining.

clearEndTime()

public StorageConfig.TimespanConfig.Builder clearEndTime()

Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
StorageConfig.TimespanConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public StorageConfig.TimespanConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StorageConfig.TimespanConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides

clearStartTime()

public StorageConfig.TimespanConfig.Builder clearStartTime()

Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
StorageConfig.TimespanConfig.Builder

clearTimestampField()

public StorageConfig.TimespanConfig.Builder clearTimestampField()

Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery.

<b>For BigQuery</b>

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.

<ul> <li><code>_PARTITIONTIME</code></li> <li><code>_PARTITIONDATE</code></li> <li><code>_PARTITION_LOAD_TIME</code></li> </ul>

<b>For Datastore</b>

If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: TIMESTAMP.

See the known issue related to this operation.

.google.privacy.dlp.v2.FieldId timestamp_field = 3;

Returns
Type Description
StorageConfig.TimespanConfig.Builder

clone()

public StorageConfig.TimespanConfig.Builder clone()
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides

getDefaultInstanceForType()

public StorageConfig.TimespanConfig getDefaultInstanceForType()
Returns
Type Description
StorageConfig.TimespanConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnableAutoPopulationOfTimespanConfig()

public boolean 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.

For BigQuery

Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows.

See the known issue related to this operation.

bool enable_auto_population_of_timespan_config = 4;

Returns
Type Description
boolean

The enableAutoPopulationOfTimespanConfig.

getEndTime()

public Timestamp getEndTime()

Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
TimestampOrBuilder

getStartTime()

public Timestamp getStartTime()

Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
TimestampOrBuilder

getTimestampField()

public FieldId getTimestampField()

Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery.

<b>For BigQuery</b>

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.

<ul> <li><code>_PARTITIONTIME</code></li> <li><code>_PARTITIONDATE</code></li> <li><code>_PARTITION_LOAD_TIME</code></li> </ul>

<b>For Datastore</b>

If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: TIMESTAMP.

See the known issue related to this operation.

.google.privacy.dlp.v2.FieldId timestamp_field = 3;

Returns
Type Description
FieldId

The timestampField.

getTimestampFieldBuilder()

public FieldId.Builder getTimestampFieldBuilder()

Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery.

<b>For BigQuery</b>

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.

<ul> <li><code>_PARTITIONTIME</code></li> <li><code>_PARTITIONDATE</code></li> <li><code>_PARTITION_LOAD_TIME</code></li> </ul>

<b>For Datastore</b>

If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: TIMESTAMP.

See the known issue related to this operation.

.google.privacy.dlp.v2.FieldId timestamp_field = 3;

Returns
Type Description
FieldId.Builder

getTimestampFieldOrBuilder()

public FieldIdOrBuilder getTimestampFieldOrBuilder()

Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery.

<b>For BigQuery</b>

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.

<ul> <li><code>_PARTITIONTIME</code></li> <li><code>_PARTITIONDATE</code></li> <li><code>_PARTITION_LOAD_TIME</code></li> </ul>

<b>For Datastore</b>

If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: TIMESTAMP.

See the known issue related to this operation.

.google.privacy.dlp.v2.FieldId timestamp_field = 3;

Returns
Type Description
FieldIdOrBuilder

hasEndTime()

public boolean hasEndTime()

Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
boolean

Whether the startTime field is set.

hasTimestampField()

public boolean hasTimestampField()

Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery.

<b>For BigQuery</b>

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.

<ul> <li><code>_PARTITIONTIME</code></li> <li><code>_PARTITIONDATE</code></li> <li><code>_PARTITION_LOAD_TIME</code></li> </ul>

<b>For Datastore</b>

If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: TIMESTAMP.

See the known issue related to this operation.

.google.privacy.dlp.v2.FieldId timestamp_field = 3;

Returns
Type Description
boolean

Whether the timestampField field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public StorageConfig.TimespanConfig.Builder mergeEndTime(Timestamp value)

Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
StorageConfig.TimespanConfig.Builder

mergeFrom(StorageConfig.TimespanConfig other)

public StorageConfig.TimespanConfig.Builder mergeFrom(StorageConfig.TimespanConfig other)
Parameter
Name Description
other StorageConfig.TimespanConfig
Returns
Type Description
StorageConfig.TimespanConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StorageConfig.TimespanConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StorageConfig.TimespanConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides

mergeStartTime(Timestamp value)

public StorageConfig.TimespanConfig.Builder mergeStartTime(Timestamp value)

Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
StorageConfig.TimespanConfig.Builder

mergeTimestampField(FieldId value)

public StorageConfig.TimespanConfig.Builder mergeTimestampField(FieldId value)

Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery.

<b>For BigQuery</b>

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.

<ul> <li><code>_PARTITIONTIME</code></li> <li><code>_PARTITIONDATE</code></li> <li><code>_PARTITION_LOAD_TIME</code></li> </ul>

<b>For Datastore</b>

If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: TIMESTAMP.

See the known issue related to this operation.

.google.privacy.dlp.v2.FieldId timestamp_field = 3;

Parameter
Name Description
value FieldId
Returns
Type Description
StorageConfig.TimespanConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StorageConfig.TimespanConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides

setEnableAutoPopulationOfTimespanConfig(boolean value)

public StorageConfig.TimespanConfig.Builder setEnableAutoPopulationOfTimespanConfig(boolean value)

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.

For BigQuery

Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows.

See the known issue related to this operation.

bool enable_auto_population_of_timespan_config = 4;

Parameter
Name Description
value boolean

The enableAutoPopulationOfTimespanConfig to set.
Returns
Type Description
StorageConfig.TimespanConfig.Builder

This builder for chaining.

setEndTime(Timestamp value)

public StorageConfig.TimespanConfig.Builder setEndTime(Timestamp value)

Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
StorageConfig.TimespanConfig.Builder

setEndTime(Timestamp.Builder builderForValue)

public StorageConfig.TimespanConfig.Builder setEndTime(Timestamp.Builder builderForValue)

Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
StorageConfig.TimespanConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StorageConfig.TimespanConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StorageConfig.TimespanConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides

setStartTime(Timestamp value)

public StorageConfig.TimespanConfig.Builder setStartTime(Timestamp value)

Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
StorageConfig.TimespanConfig.Builder

setStartTime(Timestamp.Builder builderForValue)

public StorageConfig.TimespanConfig.Builder setStartTime(Timestamp.Builder builderForValue)

Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
StorageConfig.TimespanConfig.Builder

setTimestampField(FieldId value)

public StorageConfig.TimespanConfig.Builder setTimestampField(FieldId value)

Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery.

<b>For BigQuery</b>

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.

<ul> <li><code>_PARTITIONTIME</code></li> <li><code>_PARTITIONDATE</code></li> <li><code>_PARTITION_LOAD_TIME</code></li> </ul>

<b>For Datastore</b>

If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: TIMESTAMP.

See the known issue related to this operation.

.google.privacy.dlp.v2.FieldId timestamp_field = 3;

Parameter
Name Description
value FieldId
Returns
Type Description
StorageConfig.TimespanConfig.Builder

setTimestampField(FieldId.Builder builderForValue)

public StorageConfig.TimespanConfig.Builder setTimestampField(FieldId.Builder builderForValue)

Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery.

<b>For BigQuery</b>

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.

<ul> <li><code>_PARTITIONTIME</code></li> <li><code>_PARTITIONDATE</code></li> <li><code>_PARTITION_LOAD_TIME</code></li> </ul>

<b>For Datastore</b>

If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: TIMESTAMP.

See the known issue related to this operation.

.google.privacy.dlp.v2.FieldId timestamp_field = 3;

Parameter
Name Description
builderForValue FieldId.Builder
Returns
Type Description
StorageConfig.TimespanConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final StorageConfig.TimespanConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides