Class StorageConfig.TimespanConfig

  • All Implemented Interfaces:
    StorageConfig.TimespanConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    StorageConfig

    public static final class StorageConfig.TimespanConfig
    extends com.google.protobuf.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
    See Also:
    Serialized Form
    • Field Detail

      • START_TIME_FIELD_NUMBER

        public static final int START_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TIMESTAMP_FIELD_FIELD_NUMBER

        public static final int TIMESTAMP_FIELD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ENABLE_AUTO_POPULATION_OF_TIMESPAN_CONFIG_FIELD_NUMBER

        public static final int ENABLE_AUTO_POPULATION_OF_TIMESPAN_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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;
        Specified by:
        hasStartTime in interface StorageConfig.TimespanConfigOrBuilder
        Returns:
        Whether the startTime field is set.
      • getStartTime

        public com.google.protobuf.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;
        Specified by:
        getStartTime in interface StorageConfig.TimespanConfigOrBuilder
        Returns:
        The startTime.
      • getStartTimeOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getStartTimeOrBuilder in interface StorageConfig.TimespanConfigOrBuilder
      • 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;
        Specified by:
        hasEndTime in interface StorageConfig.TimespanConfigOrBuilder
        Returns:
        Whether the endTime field is set.
      • getEndTime

        public com.google.protobuf.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;
        Specified by:
        getEndTime in interface StorageConfig.TimespanConfigOrBuilder
        Returns:
        The endTime.
      • getEndTimeOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getEndTimeOrBuilder in interface StorageConfig.TimespanConfigOrBuilder
      • 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](https://cloud.google.com/bigquery/docs/partitioned-tables#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](https://cloud.google.com/dlp/docs/known-issues#bq-timespan)
         related to this operation.
         
        .google.privacy.dlp.v2.FieldId timestamp_field = 3;
        Specified by:
        hasTimestampField in interface StorageConfig.TimespanConfigOrBuilder
        Returns:
        Whether the timestampField field is set.
      • 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](https://cloud.google.com/bigquery/docs/partitioned-tables#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](https://cloud.google.com/dlp/docs/known-issues#bq-timespan)
         related to this operation.
         
        .google.privacy.dlp.v2.FieldId timestamp_field = 3;
        Specified by:
        getTimestampField in interface StorageConfig.TimespanConfigOrBuilder
        Returns:
        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](https://cloud.google.com/bigquery/docs/partitioned-tables#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](https://cloud.google.com/dlp/docs/known-issues#bq-timespan)
         related to this operation.
         
        .google.privacy.dlp.v2.FieldId timestamp_field = 3;
        Specified by:
        getTimestampFieldOrBuilder in interface StorageConfig.TimespanConfigOrBuilder
      • 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.
         
        bool enable_auto_population_of_timespan_config = 4;
        Specified by:
        getEnableAutoPopulationOfTimespanConfig in interface StorageConfig.TimespanConfigOrBuilder
        Returns:
        The enableAutoPopulationOfTimespanConfig.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static StorageConfig.TimespanConfig parseFrom​(ByteBuffer data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static StorageConfig.TimespanConfig parseFrom​(ByteBuffer data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static StorageConfig.TimespanConfig parseFrom​(com.google.protobuf.ByteString data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static StorageConfig.TimespanConfig parseFrom​(com.google.protobuf.ByteString data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static StorageConfig.TimespanConfig parseFrom​(byte[] data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static StorageConfig.TimespanConfig parseFrom​(byte[] data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public StorageConfig.TimespanConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public StorageConfig.TimespanConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected StorageConfig.TimespanConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<StorageConfig.TimespanConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public StorageConfig.TimespanConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder