Class StorageConfig.TimespanConfig (3.48.0)

public static final class StorageConfig.TimespanConfig extends GeneratedMessageV3 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

Static Fields

ENABLE_AUTO_POPULATION_OF_TIMESPAN_CONFIG_FIELD_NUMBER

public static final int ENABLE_AUTO_POPULATION_OF_TIMESPAN_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

TIMESTAMP_FIELD_FIELD_NUMBER

public static final int TIMESTAMP_FIELD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StorageConfig.TimespanConfig getDefaultInstance()
Returns
Type Description
StorageConfig.TimespanConfig

getDescriptor()

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

newBuilder()

public static StorageConfig.TimespanConfig.Builder newBuilder()
Returns
Type Description
StorageConfig.TimespanConfig.Builder

newBuilder(StorageConfig.TimespanConfig prototype)

public static StorageConfig.TimespanConfig.Builder newBuilder(StorageConfig.TimespanConfig prototype)
Parameter
Name Description
prototype StorageConfig.TimespanConfig
Returns
Type Description
StorageConfig.TimespanConfig.Builder

parseDelimitedFrom(InputStream input)

public static StorageConfig.TimespanConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StorageConfig.TimespanConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StorageConfig.TimespanConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StorageConfig.TimespanConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StorageConfig.TimespanConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StorageConfig.TimespanConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StorageConfig.TimespanConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StorageConfig.TimespanConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StorageConfig.TimespanConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StorageConfig.TimespanConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StorageConfig.TimespanConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StorageConfig.TimespanConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageConfig.TimespanConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StorageConfig.TimespanConfig> parser()
Returns
Type Description
Parser<TimespanConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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.

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

getParserForType()

public Parser<StorageConfig.TimespanConfig> getParserForType()
Returns
Type Description
Parser<TimespanConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StorageConfig.TimespanConfig.Builder newBuilderForType()
Returns
Type Description
StorageConfig.TimespanConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StorageConfig.TimespanConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StorageConfig.TimespanConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public StorageConfig.TimespanConfig.Builder toBuilder()
Returns
Type Description
StorageConfig.TimespanConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException