com.google.api.services.storagetransfer.v1.model

Class ObjectConditions

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storagetransfer.v1.model.ObjectConditions

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ObjectConditions
extends com.google.api.client.json.GenericJson

Conditions that determine which objects are transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage. The "last modification time" refers to the time of the last change to the object's content or metadata — specifically, this is the `updated` property of Cloud Storage objects, the `LastModified` field of S3 objects, and the `Last-Modified` header of Azure blobs. Transfers with a PosixFilesystem source or destination don't support `ObjectConditions`.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Storage Transfer API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ObjectConditions()

Method Summary

Modifier and Type	Method and Description
ObjectConditions	clone()
List<String>	getExcludePrefixes() If you specify `exclude_prefixes`, Storage Transfer Service uses the items in the `exclude_prefixes` array to determine which objects to exclude from a transfer.
List<String>	getIncludePrefixes() If you specify `include_prefixes`, Storage Transfer Service uses the items in the `include_prefixes` array to determine which objects to include in a transfer.
String	getLastModifiedBefore() If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred.
String	getLastModifiedSince() If specified, only objects with a "last modification time" on or after this timestamp and objects that don't have a "last modification time" are transferred.
String	getMaxTimeElapsedSinceLastModification() Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time".
String	getMinTimeElapsedSinceLastModification() Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time".
ObjectConditions	set(String fieldName, Object value)
ObjectConditions	setExcludePrefixes(List<String> excludePrefixes) If you specify `exclude_prefixes`, Storage Transfer Service uses the items in the `exclude_prefixes` array to determine which objects to exclude from a transfer.
ObjectConditions	setIncludePrefixes(List<String> includePrefixes) If you specify `include_prefixes`, Storage Transfer Service uses the items in the `include_prefixes` array to determine which objects to include in a transfer.
ObjectConditions	setLastModifiedBefore(String lastModifiedBefore) If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred.
ObjectConditions	setLastModifiedSince(String lastModifiedSince) If specified, only objects with a "last modification time" on or after this timestamp and objects that don't have a "last modification time" are transferred.
ObjectConditions	setMaxTimeElapsedSinceLastModification(String maxTimeElapsedSinceLastModification) Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time".
ObjectConditions	setMinTimeElapsedSinceLastModification(String minTimeElapsedSinceLastModification) Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time".

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ObjectConditions

public ObjectConditions()

Method Detail

getExcludePrefixes

public List<String> getExcludePrefixes()

If you specify `exclude_prefixes`, Storage Transfer Service uses the items in the `exclude_prefixes` array to determine which objects to exclude from a transfer. Objects must not start with one of the matching `exclude_prefixes` for inclusion in a transfer. The following are requirements of `exclude_prefixes`: * Each exclude-prefix can contain any sequence of Unicode characters, to a max length of 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each exclude-prefix must omit the leading slash. For example, to exclude the object `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the exclude-prefix as `logs/y=2015/requests.gz`. * None of the exclude-prefix values can be empty, if specified. * Each exclude-prefix must exclude a distinct portion of the object namespace. No exclude-prefix may be a prefix of another exclude-prefix. * If include_prefixes is specified, then each exclude-prefix must start with the value of a path explicitly included by `include_prefixes`. The max size of `exclude_prefixes` is 1000. For more information, see [Filtering objects from transfers](/storage-transfer/docs/filtering-objects-from-transfers).

Returns:

value or null for none

setExcludePrefixes

public ObjectConditions setExcludePrefixes(List<String> excludePrefixes)

If you specify `exclude_prefixes`, Storage Transfer Service uses the items in the `exclude_prefixes` array to determine which objects to exclude from a transfer. Objects must not start with one of the matching `exclude_prefixes` for inclusion in a transfer. The following are requirements of `exclude_prefixes`: * Each exclude-prefix can contain any sequence of Unicode characters, to a max length of 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each exclude-prefix must omit the leading slash. For example, to exclude the object `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the exclude-prefix as `logs/y=2015/requests.gz`. * None of the exclude-prefix values can be empty, if specified. * Each exclude-prefix must exclude a distinct portion of the object namespace. No exclude-prefix may be a prefix of another exclude-prefix. * If include_prefixes is specified, then each exclude-prefix must start with the value of a path explicitly included by `include_prefixes`. The max size of `exclude_prefixes` is 1000. For more information, see [Filtering objects from transfers](/storage-transfer/docs/filtering-objects-from-transfers).

Parameters:

excludePrefixes - excludePrefixes or null for none

getIncludePrefixes

public List<String> getIncludePrefixes()

If you specify `include_prefixes`, Storage Transfer Service uses the items in the `include_prefixes` array to determine which objects to include in a transfer. Objects must start with one of the matching `include_prefixes` for inclusion in the transfer. If exclude_prefixes is specified, objects must not start with any of the `exclude_prefixes` specified for inclusion in the transfer. The following are requirements of `include_prefixes`: * Each include-prefix can contain any sequence of Unicode characters, to a max length of 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each include-prefix must omit the leading slash. For example, to include the object `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include-prefix as `logs/y=2015/requests.gz`. * None of the include-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace. No include-prefix may be a prefix of another include-prefix. The max size of `include_prefixes` is 1000. For more information, see [Filtering objects from transfers](/storage-transfer/docs/filtering-objects-from-transfers).

Returns:

value or null for none

setIncludePrefixes

public ObjectConditions setIncludePrefixes(List<String> includePrefixes)

If you specify `include_prefixes`, Storage Transfer Service uses the items in the `include_prefixes` array to determine which objects to include in a transfer. Objects must start with one of the matching `include_prefixes` for inclusion in the transfer. If exclude_prefixes is specified, objects must not start with any of the `exclude_prefixes` specified for inclusion in the transfer. The following are requirements of `include_prefixes`: * Each include-prefix can contain any sequence of Unicode characters, to a max length of 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each include-prefix must omit the leading slash. For example, to include the object `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include-prefix as `logs/y=2015/requests.gz`. * None of the include-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace. No include-prefix may be a prefix of another include-prefix. The max size of `include_prefixes` is 1000. For more information, see [Filtering objects from transfers](/storage-transfer/docs/filtering-objects-from-transfers).

Parameters:

includePrefixes - includePrefixes or null for none

getLastModifiedBefore

public String getLastModifiedBefore()

If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred.

Returns:

value or null for none

setLastModifiedBefore

public ObjectConditions setLastModifiedBefore(String lastModifiedBefore)

If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred.

Parameters:

lastModifiedBefore - lastModifiedBefore or null for none

getLastModifiedSince

public String getLastModifiedSince()

If specified, only objects with a "last modification time" on or after this timestamp and objects that don't have a "last modification time" are transferred. The `last_modified_since` and `last_modified_before` fields can be used together for chunked data processing. For example, consider a script that processes each day's worth of data at a time. For that you'd set each of the fields as follows: * `last_modified_since` to the start of the day * `last_modified_before` to the end of the day

Returns:

value or null for none

setLastModifiedSince

public ObjectConditions setLastModifiedSince(String lastModifiedSince)

If specified, only objects with a "last modification time" on or after this timestamp and objects that don't have a "last modification time" are transferred. The `last_modified_since` and `last_modified_before` fields can be used together for chunked data processing. For example, consider a script that processes each day's worth of data at a time. For that you'd set each of the fields as follows: * `last_modified_since` to the start of the day * `last_modified_before` to the end of the day

Parameters:

lastModifiedSince - lastModifiedSince or null for none

getMaxTimeElapsedSinceLastModification

public String getMaxTimeElapsedSinceLastModification()

Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the `TransferOperation`and the "last modification time" of the object is less than the value of max_time_elapsed_since_last_modification`. Objects that do not have a "last modification time" are also transferred.

Returns:

value or null for none

setMaxTimeElapsedSinceLastModification

public ObjectConditions setMaxTimeElapsedSinceLastModification(String maxTimeElapsedSinceLastModification)

Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the `TransferOperation`and the "last modification time" of the object is less than the value of max_time_elapsed_since_last_modification`. Objects that do not have a "last modification time" are also transferred.

Parameters:

maxTimeElapsedSinceLastModification - maxTimeElapsedSinceLastModification or null for none

getMinTimeElapsedSinceLastModification

public String getMinTimeElapsedSinceLastModification()

Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the `TransferOperation` and the "last modification time" of the object is equal to or greater than the value of min_time_elapsed_since_last_modification`. Objects that do not have a "last modification time" are also transferred.

Returns:

value or null for none

setMinTimeElapsedSinceLastModification

public ObjectConditions setMinTimeElapsedSinceLastModification(String minTimeElapsedSinceLastModification)

Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the `TransferOperation` and the "last modification time" of the object is equal to or greater than the value of min_time_elapsed_since_last_modification`. Objects that do not have a "last modification time" are also transferred.

Parameters:

minTimeElapsedSinceLastModification - minTimeElapsedSinceLastModification or null for none

set

public ObjectConditions set(String fieldName,
                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ObjectConditions clone()

Overrides:

clone in class com.google.api.client.json.GenericJson