Interface TransferTypes.ObjectConditionsOrBuilder (1.53.0)

public static interface TransferTypes.ObjectConditionsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExcludePrefixes(int index)

public abstract String getExcludePrefixes(int index)

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.

repeated string exclude_prefixes = 4;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The excludePrefixes at the given index.

getExcludePrefixesBytes(int index)

public abstract ByteString getExcludePrefixesBytes(int index)

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.

repeated string exclude_prefixes = 4;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the excludePrefixes at the given index.

getExcludePrefixesCount()

public abstract int getExcludePrefixesCount()

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.

repeated string exclude_prefixes = 4;

Returns
Type	Description
`int`	The count of excludePrefixes.

getExcludePrefixesList()

public abstract List<String> getExcludePrefixesList()

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.

repeated string exclude_prefixes = 4;

Returns
Type	Description
`List<String>`	A list containing the excludePrefixes.

getIncludePrefixes(int index)

public abstract String getIncludePrefixes(int index)

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.

repeated string include_prefixes = 3;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The includePrefixes at the given index.

getIncludePrefixesBytes(int index)

public abstract ByteString getIncludePrefixesBytes(int index)

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.

repeated string include_prefixes = 3;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the includePrefixes at the given index.

getIncludePrefixesCount()

public abstract int getIncludePrefixesCount()

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.

repeated string include_prefixes = 3;

Returns
Type	Description
`int`	The count of includePrefixes.

getIncludePrefixesList()

public abstract List<String> getIncludePrefixesList()

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.

repeated string include_prefixes = 3;

Returns
Type	Description
`List<String>`	A list containing the includePrefixes.

getLastModifiedBefore()

public abstract Timestamp 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.

.google.protobuf.Timestamp last_modified_before = 6;

Returns
Type	Description
`Timestamp`	The lastModifiedBefore.

getLastModifiedBeforeOrBuilder()

public abstract TimestampOrBuilder getLastModifiedBeforeOrBuilder()

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

.google.protobuf.Timestamp last_modified_before = 6;

Returns
Type	Description
`TimestampOrBuilder`

getLastModifiedSince()

public abstract Timestamp 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

.google.protobuf.Timestamp last_modified_since = 5;

Returns
Type	Description
`Timestamp`	The lastModifiedSince.

getLastModifiedSinceOrBuilder()

public abstract TimestampOrBuilder getLastModifiedSinceOrBuilder()

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.

last_modified_since to the start of the day
last_modified_before to the end of the day

.google.protobuf.Timestamp last_modified_since = 5;

Returns
Type	Description
`TimestampOrBuilder`

getMaxTimeElapsedSinceLastModification()

public abstract Duration 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 TransferOperationand 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.

.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;

Returns
Type	Description
`Duration`	The maxTimeElapsedSinceLastModification.

getMaxTimeElapsedSinceLastModificationOrBuilder()

public abstract DurationOrBuilder getMaxTimeElapsedSinceLastModificationOrBuilder()

.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;

Returns
Type	Description
`DurationOrBuilder`

getMinTimeElapsedSinceLastModification()

public abstract Duration 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.

.google.protobuf.Duration min_time_elapsed_since_last_modification = 1;

Returns
Type	Description
`Duration`	The minTimeElapsedSinceLastModification.

getMinTimeElapsedSinceLastModificationOrBuilder()

public abstract DurationOrBuilder getMinTimeElapsedSinceLastModificationOrBuilder()

.google.protobuf.Duration min_time_elapsed_since_last_modification = 1;

Returns
Type	Description
`DurationOrBuilder`

hasLastModifiedBefore()

public abstract boolean hasLastModifiedBefore()

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

.google.protobuf.Timestamp last_modified_before = 6;

Returns
Type	Description
`boolean`	Whether the lastModifiedBefore field is set.

hasLastModifiedSince()

public abstract boolean hasLastModifiedSince()

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.

last_modified_since to the start of the day
last_modified_before to the end of the day

.google.protobuf.Timestamp last_modified_since = 5;

Returns
Type	Description
`boolean`	Whether the lastModifiedSince field is set.

hasMaxTimeElapsedSinceLastModification()

public abstract boolean hasMaxTimeElapsedSinceLastModification()

.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;

Returns
Type	Description
`boolean`	Whether the maxTimeElapsedSinceLastModification field is set.

hasMinTimeElapsedSinceLastModification()

public abstract boolean hasMinTimeElapsedSinceLastModification()

.google.protobuf.Duration min_time_elapsed_since_last_modification = 1;

Returns
Type	Description
`boolean`	Whether the minTimeElapsedSinceLastModification field is set.