com.google.storagetransfer.v1.proto

Interface TransferTypes.ObjectConditionsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TransferTypes.ObjectConditions, TransferTypes.ObjectConditions.Builder

Enclosing class:

TransferTypes

public static interface TransferTypes.ObjectConditionsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
com.google.protobuf.ByteString	getExcludePrefixesBytes(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.
int	getExcludePrefixesCount() 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>	getExcludePrefixesList() 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.
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.
com.google.protobuf.ByteString	getIncludePrefixesBytes(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.
int	getIncludePrefixesCount() 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.
List<String>	getIncludePrefixesList() 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.
com.google.protobuf.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.
com.google.protobuf.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.
com.google.protobuf.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.
com.google.protobuf.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.
com.google.protobuf.Duration	getMaxTimeElapsedSinceLastModification() Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time".
com.google.protobuf.DurationOrBuilder	getMaxTimeElapsedSinceLastModificationOrBuilder() Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time".
com.google.protobuf.Duration	getMinTimeElapsedSinceLastModification() Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time".
com.google.protobuf.DurationOrBuilder	getMinTimeElapsedSinceLastModificationOrBuilder() Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time".
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.
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.
boolean	hasMaxTimeElapsedSinceLastModification() Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time".
boolean	hasMinTimeElapsedSinceLastModification() Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time".

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasMinTimeElapsedSinceLastModification

boolean hasMinTimeElapsedSinceLastModification()

 Ensures that objects are not transferred until a specific minimum time
 has elapsed after the "last modification time". When a
 [TransferOperation][google.storagetransfer.v1.TransferOperation] begins, objects with a "last modification time" are
 transferred only if the elapsed time between the
 [start_time][google.storagetransfer.v1.TransferOperation.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:

Whether the minTimeElapsedSinceLastModification field is set.

getMinTimeElapsedSinceLastModification

com.google.protobuf.Duration getMinTimeElapsedSinceLastModification()

 Ensures that objects are not transferred until a specific minimum time
 has elapsed after the "last modification time". When a
 [TransferOperation][google.storagetransfer.v1.TransferOperation] begins, objects with a "last modification time" are
 transferred only if the elapsed time between the
 [start_time][google.storagetransfer.v1.TransferOperation.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:

The minTimeElapsedSinceLastModification.

getMinTimeElapsedSinceLastModificationOrBuilder

com.google.protobuf.DurationOrBuilder getMinTimeElapsedSinceLastModificationOrBuilder()

 Ensures that objects are not transferred until a specific minimum time
 has elapsed after the "last modification time". When a
 [TransferOperation][google.storagetransfer.v1.TransferOperation] begins, objects with a "last modification time" are
 transferred only if the elapsed time between the
 [start_time][google.storagetransfer.v1.TransferOperation.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;

hasMaxTimeElapsedSinceLastModification

boolean hasMaxTimeElapsedSinceLastModification()

 Ensures that objects are not transferred if a specific maximum time
 has elapsed since the "last modification time".
 When a [TransferOperation][google.storagetransfer.v1.TransferOperation] begins, objects with a
 "last modification time" are transferred only if the elapsed time
 between the [start_time][google.storagetransfer.v1.TransferOperation.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.
 

.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;

Returns:

Whether the maxTimeElapsedSinceLastModification field is set.

getMaxTimeElapsedSinceLastModification

com.google.protobuf.Duration getMaxTimeElapsedSinceLastModification()

 Ensures that objects are not transferred if a specific maximum time
 has elapsed since the "last modification time".
 When a [TransferOperation][google.storagetransfer.v1.TransferOperation] begins, objects with a
 "last modification time" are transferred only if the elapsed time
 between the [start_time][google.storagetransfer.v1.TransferOperation.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.
 

.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;

Returns:

The maxTimeElapsedSinceLastModification.

getMaxTimeElapsedSinceLastModificationOrBuilder

com.google.protobuf.DurationOrBuilder getMaxTimeElapsedSinceLastModificationOrBuilder()

 Ensures that objects are not transferred if a specific maximum time
 has elapsed since the "last modification time".
 When a [TransferOperation][google.storagetransfer.v1.TransferOperation] begins, objects with a
 "last modification time" are transferred only if the elapsed time
 between the [start_time][google.storagetransfer.v1.TransferOperation.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.
 

.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;

getIncludePrefixesList

List<String> getIncludePrefixesList()

 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][google.storagetransfer.v1.ObjectConditions.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).
 

repeated string include_prefixes = 3;

Returns:

A list containing the includePrefixes.

getIncludePrefixesCount

int getIncludePrefixesCount()

 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][google.storagetransfer.v1.ObjectConditions.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).
 

repeated string include_prefixes = 3;

Returns:

The count of includePrefixes.

getIncludePrefixes

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][google.storagetransfer.v1.ObjectConditions.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).
 

repeated string include_prefixes = 3;

Parameters:

index - The index of the element to return.

Returns:

The includePrefixes at the given index.

getIncludePrefixesBytes

com.google.protobuf.ByteString getIncludePrefixesBytes(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][google.storagetransfer.v1.ObjectConditions.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).
 

repeated string include_prefixes = 3;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the includePrefixes at the given index.

getExcludePrefixesList

List<String> getExcludePrefixesList()

 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][google.storagetransfer.v1.ObjectConditions.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).
 

repeated string exclude_prefixes = 4;

Returns:

A list containing the excludePrefixes.

getExcludePrefixesCount

int getExcludePrefixesCount()

 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][google.storagetransfer.v1.ObjectConditions.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).
 

repeated string exclude_prefixes = 4;

Returns:

The count of excludePrefixes.

getExcludePrefixes

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][google.storagetransfer.v1.ObjectConditions.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).
 

repeated string exclude_prefixes = 4;

Parameters:

index - The index of the element to return.

Returns:

The excludePrefixes at the given index.

getExcludePrefixesBytes

com.google.protobuf.ByteString getExcludePrefixesBytes(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][google.storagetransfer.v1.ObjectConditions.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).
 

repeated string exclude_prefixes = 4;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the excludePrefixes at the given index.

hasLastModifiedSince

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.
 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:

Whether the lastModifiedSince field is set.

getLastModifiedSince

com.google.protobuf.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:

The lastModifiedSince.

getLastModifiedSinceOrBuilder

com.google.protobuf.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.
 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;

hasLastModifiedBefore

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:

Whether the lastModifiedBefore field is set.

getLastModifiedBefore

com.google.protobuf.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:

The lastModifiedBefore.

getLastModifiedBeforeOrBuilder

com.google.protobuf.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;