- 1.53.0 (latest)
- 1.52.0
- 1.51.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.0.4
public static final class TransferTypes.ObjectConditions.Builder extends GeneratedMessageV3.Builder<TransferTypes.ObjectConditions.Builder> implements TransferTypes.ObjectConditionsOrBuilder
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
.
Protobuf type google.storagetransfer.v1.ObjectConditions
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferTypes.ObjectConditions.BuilderImplements
TransferTypes.ObjectConditionsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addAllExcludePrefixes(Iterable<String> values)
public TransferTypes.ObjectConditions.Builder addAllExcludePrefixes(Iterable<String> values)
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 aslogs/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 ofexclude_prefixes
is 1000. For more information, see Filtering objects from transfers.
repeated string exclude_prefixes = 4;
Name | Description |
values | Iterable<String> The excludePrefixes to add. |
Type | Description |
TransferTypes.ObjectConditions.Builder | This builder for chaining. |
addAllIncludePrefixes(Iterable<String> values)
public TransferTypes.ObjectConditions.Builder addAllIncludePrefixes(Iterable<String> values)
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 aslogs/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;
Name | Description |
values | Iterable<String> The includePrefixes to add. |
Type | Description |
TransferTypes.ObjectConditions.Builder | This builder for chaining. |
addExcludePrefixes(String value)
public TransferTypes.ObjectConditions.Builder addExcludePrefixes(String value)
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 aslogs/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 ofexclude_prefixes
is 1000. For more information, see Filtering objects from transfers.
repeated string exclude_prefixes = 4;
Name | Description |
value | String The excludePrefixes to add. |
Type | Description |
TransferTypes.ObjectConditions.Builder | This builder for chaining. |
addExcludePrefixesBytes(ByteString value)
public TransferTypes.ObjectConditions.Builder addExcludePrefixesBytes(ByteString value)
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 aslogs/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 ofexclude_prefixes
is 1000. For more information, see Filtering objects from transfers.
repeated string exclude_prefixes = 4;
Name | Description |
value | ByteString The bytes of the excludePrefixes to add. |
Type | Description |
TransferTypes.ObjectConditions.Builder | This builder for chaining. |
addIncludePrefixes(String value)
public TransferTypes.ObjectConditions.Builder addIncludePrefixes(String value)
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 aslogs/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;
Name | Description |
value | String The includePrefixes to add. |
Type | Description |
TransferTypes.ObjectConditions.Builder | This builder for chaining. |
addIncludePrefixesBytes(ByteString value)
public TransferTypes.ObjectConditions.Builder addIncludePrefixesBytes(ByteString value)
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 aslogs/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;
Name | Description |
value | ByteString The bytes of the includePrefixes to add. |
Type | Description |
TransferTypes.ObjectConditions.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TransferTypes.ObjectConditions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
TransferTypes.ObjectConditions.Builder |
build()
public TransferTypes.ObjectConditions build()
Type | Description |
TransferTypes.ObjectConditions |
buildPartial()
public TransferTypes.ObjectConditions buildPartial()
Type | Description |
TransferTypes.ObjectConditions |
clear()
public TransferTypes.ObjectConditions.Builder clear()
Type | Description |
TransferTypes.ObjectConditions.Builder |
clearExcludePrefixes()
public TransferTypes.ObjectConditions.Builder clearExcludePrefixes()
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 aslogs/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 ofexclude_prefixes
is 1000. For more information, see Filtering objects from transfers.
repeated string exclude_prefixes = 4;
Type | Description |
TransferTypes.ObjectConditions.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public TransferTypes.ObjectConditions.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
TransferTypes.ObjectConditions.Builder |
clearIncludePrefixes()
public TransferTypes.ObjectConditions.Builder clearIncludePrefixes()
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 aslogs/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;
Type | Description |
TransferTypes.ObjectConditions.Builder | This builder for chaining. |
clearLastModifiedBefore()
public TransferTypes.ObjectConditions.Builder clearLastModifiedBefore()
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;
Type | Description |
TransferTypes.ObjectConditions.Builder |
clearLastModifiedSince()
public TransferTypes.ObjectConditions.Builder clearLastModifiedSince()
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 daylast_modified_before
to the end of the day
.google.protobuf.Timestamp last_modified_since = 5;
Type | Description |
TransferTypes.ObjectConditions.Builder |
clearMaxTimeElapsedSinceLastModification()
public TransferTypes.ObjectConditions.Builder clearMaxTimeElapsedSinceLastModification()
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.
.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;
Type | Description |
TransferTypes.ObjectConditions.Builder |
clearMinTimeElapsedSinceLastModification()
public TransferTypes.ObjectConditions.Builder clearMinTimeElapsedSinceLastModification()
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;
Type | Description |
TransferTypes.ObjectConditions.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public TransferTypes.ObjectConditions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
TransferTypes.ObjectConditions.Builder |
clone()
public TransferTypes.ObjectConditions.Builder clone()
Type | Description |
TransferTypes.ObjectConditions.Builder |
getDefaultInstanceForType()
public TransferTypes.ObjectConditions getDefaultInstanceForType()
Type | Description |
TransferTypes.ObjectConditions |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getExcludePrefixes(int index)
public 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 aslogs/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 ofexclude_prefixes
is 1000. For more information, see Filtering objects from transfers.
repeated string exclude_prefixes = 4;
Name | Description |
index | int The index of the element to return. |
Type | Description |
String | The excludePrefixes at the given index. |
getExcludePrefixesBytes(int index)
public 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 aslogs/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 ofexclude_prefixes
is 1000. For more information, see Filtering objects from transfers.
repeated string exclude_prefixes = 4;
Name | Description |
index | int The index of the value to return. |
Type | Description |
ByteString | The bytes of the excludePrefixes at the given index. |
getExcludePrefixesCount()
public 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 aslogs/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 ofexclude_prefixes
is 1000. For more information, see Filtering objects from transfers.
repeated string exclude_prefixes = 4;
Type | Description |
int | The count of excludePrefixes. |
getExcludePrefixesList()
public ProtocolStringList 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 aslogs/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 ofexclude_prefixes
is 1000. For more information, see Filtering objects from transfers.
repeated string exclude_prefixes = 4;
Type | Description |
ProtocolStringList | A list containing the excludePrefixes. |
getIncludePrefixes(int index)
public 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 aslogs/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;
Name | Description |
index | int The index of the element to return. |
Type | Description |
String | The includePrefixes at the given index. |
getIncludePrefixesBytes(int index)
public 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 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 aslogs/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;
Name | Description |
index | int The index of the value to return. |
Type | Description |
ByteString | The bytes of the includePrefixes at the given index. |
getIncludePrefixesCount()
public 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 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 aslogs/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;
Type | Description |
int | The count of includePrefixes. |
getIncludePrefixesList()
public ProtocolStringList 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 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 aslogs/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;
Type | Description |
ProtocolStringList | A list containing the includePrefixes. |
getLastModifiedBefore()
public 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;
Type | Description |
Timestamp | The lastModifiedBefore. |
getLastModifiedBeforeBuilder()
public Timestamp.Builder getLastModifiedBeforeBuilder()
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;
Type | Description |
Builder |
getLastModifiedBeforeOrBuilder()
public 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;
Type | Description |
TimestampOrBuilder |
getLastModifiedSince()
public 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 daylast_modified_before
to the end of the day
.google.protobuf.Timestamp last_modified_since = 5;
Type | Description |
Timestamp | The lastModifiedSince. |
getLastModifiedSinceBuilder()
public Timestamp.Builder getLastModifiedSinceBuilder()
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 daylast_modified_before
to the end of the day
.google.protobuf.Timestamp last_modified_since = 5;
Type | Description |
Builder |
getLastModifiedSinceOrBuilder()
public 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 daylast_modified_before
to the end of the day
.google.protobuf.Timestamp last_modified_since = 5;
Type | Description |
TimestampOrBuilder |
getMaxTimeElapsedSinceLastModification()
public 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
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;
Type | Description |
Duration | The maxTimeElapsedSinceLastModification. |
getMaxTimeElapsedSinceLastModificationBuilder()
public Duration.Builder getMaxTimeElapsedSinceLastModificationBuilder()
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.
.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;
Type | Description |
Builder |
getMaxTimeElapsedSinceLastModificationOrBuilder()
public DurationOrBuilder getMaxTimeElapsedSinceLastModificationOrBuilder()
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.
.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;
Type | Description |
DurationOrBuilder |
getMinTimeElapsedSinceLastModification()
public 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;
Type | Description |
Duration | The minTimeElapsedSinceLastModification. |
getMinTimeElapsedSinceLastModificationBuilder()
public Duration.Builder getMinTimeElapsedSinceLastModificationBuilder()
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;
Type | Description |
Builder |
getMinTimeElapsedSinceLastModificationOrBuilder()
public DurationOrBuilder getMinTimeElapsedSinceLastModificationOrBuilder()
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;
Type | Description |
DurationOrBuilder |
hasLastModifiedBefore()
public 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;
Type | Description |
boolean | Whether the lastModifiedBefore field is set. |
hasLastModifiedSince()
public 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 daylast_modified_before
to the end of the day
.google.protobuf.Timestamp last_modified_since = 5;
Type | Description |
boolean | Whether the lastModifiedSince field is set. |
hasMaxTimeElapsedSinceLastModification()
public boolean hasMaxTimeElapsedSinceLastModification()
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.
.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;
Type | Description |
boolean | Whether the maxTimeElapsedSinceLastModification field is set. |
hasMinTimeElapsedSinceLastModification()
public boolean hasMinTimeElapsedSinceLastModification()
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;
Type | Description |
boolean | Whether the minTimeElapsedSinceLastModification field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TransferTypes.ObjectConditions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
TransferTypes.ObjectConditions.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public TransferTypes.ObjectConditions.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
TransferTypes.ObjectConditions.Builder |
mergeFrom(TransferTypes.ObjectConditions other)
public TransferTypes.ObjectConditions.Builder mergeFrom(TransferTypes.ObjectConditions other)
Name | Description |
other | TransferTypes.ObjectConditions |
Type | Description |
TransferTypes.ObjectConditions.Builder |
mergeLastModifiedBefore(Timestamp value)
public TransferTypes.ObjectConditions.Builder mergeLastModifiedBefore(Timestamp value)
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;
Name | Description |
value | Timestamp |
Type | Description |
TransferTypes.ObjectConditions.Builder |
mergeLastModifiedSince(Timestamp value)
public TransferTypes.ObjectConditions.Builder mergeLastModifiedSince(Timestamp value)
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 daylast_modified_before
to the end of the day
.google.protobuf.Timestamp last_modified_since = 5;
Name | Description |
value | Timestamp |
Type | Description |
TransferTypes.ObjectConditions.Builder |
mergeMaxTimeElapsedSinceLastModification(Duration value)
public TransferTypes.ObjectConditions.Builder mergeMaxTimeElapsedSinceLastModification(Duration value)
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.
.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;
Name | Description |
value | Duration |
Type | Description |
TransferTypes.ObjectConditions.Builder |
mergeMinTimeElapsedSinceLastModification(Duration value)
public TransferTypes.ObjectConditions.Builder mergeMinTimeElapsedSinceLastModification(Duration value)
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;
Name | Description |
value | Duration |
Type | Description |
TransferTypes.ObjectConditions.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TransferTypes.ObjectConditions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
TransferTypes.ObjectConditions.Builder |
setExcludePrefixes(int index, String value)
public TransferTypes.ObjectConditions.Builder setExcludePrefixes(int index, String value)
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 aslogs/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 ofexclude_prefixes
is 1000. For more information, see Filtering objects from transfers.
repeated string exclude_prefixes = 4;
Name | Description |
index | int The index to set the value at. |
value | String The excludePrefixes to set. |
Type | Description |
TransferTypes.ObjectConditions.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public TransferTypes.ObjectConditions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
TransferTypes.ObjectConditions.Builder |
setIncludePrefixes(int index, String value)
public TransferTypes.ObjectConditions.Builder setIncludePrefixes(int index, String value)
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 aslogs/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;
Name | Description |
index | int The index to set the value at. |
value | String The includePrefixes to set. |
Type | Description |
TransferTypes.ObjectConditions.Builder | This builder for chaining. |
setLastModifiedBefore(Timestamp value)
public TransferTypes.ObjectConditions.Builder setLastModifiedBefore(Timestamp value)
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;
Name | Description |
value | Timestamp |
Type | Description |
TransferTypes.ObjectConditions.Builder |
setLastModifiedBefore(Timestamp.Builder builderForValue)
public TransferTypes.ObjectConditions.Builder setLastModifiedBefore(Timestamp.Builder builderForValue)
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;
Name | Description |
builderForValue | Builder |
Type | Description |
TransferTypes.ObjectConditions.Builder |
setLastModifiedSince(Timestamp value)
public TransferTypes.ObjectConditions.Builder setLastModifiedSince(Timestamp value)
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 daylast_modified_before
to the end of the day
.google.protobuf.Timestamp last_modified_since = 5;
Name | Description |
value | Timestamp |
Type | Description |
TransferTypes.ObjectConditions.Builder |
setLastModifiedSince(Timestamp.Builder builderForValue)
public TransferTypes.ObjectConditions.Builder setLastModifiedSince(Timestamp.Builder builderForValue)
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 daylast_modified_before
to the end of the day
.google.protobuf.Timestamp last_modified_since = 5;
Name | Description |
builderForValue | Builder |
Type | Description |
TransferTypes.ObjectConditions.Builder |
setMaxTimeElapsedSinceLastModification(Duration value)
public TransferTypes.ObjectConditions.Builder setMaxTimeElapsedSinceLastModification(Duration value)
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.
.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;
Name | Description |
value | Duration |
Type | Description |
TransferTypes.ObjectConditions.Builder |
setMaxTimeElapsedSinceLastModification(Duration.Builder builderForValue)
public TransferTypes.ObjectConditions.Builder setMaxTimeElapsedSinceLastModification(Duration.Builder builderForValue)
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.
.google.protobuf.Duration max_time_elapsed_since_last_modification = 2;
Name | Description |
builderForValue | Builder |
Type | Description |
TransferTypes.ObjectConditions.Builder |
setMinTimeElapsedSinceLastModification(Duration value)
public TransferTypes.ObjectConditions.Builder setMinTimeElapsedSinceLastModification(Duration value)
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;
Name | Description |
value | Duration |
Type | Description |
TransferTypes.ObjectConditions.Builder |
setMinTimeElapsedSinceLastModification(Duration.Builder builderForValue)
public TransferTypes.ObjectConditions.Builder setMinTimeElapsedSinceLastModification(Duration.Builder builderForValue)
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;
Name | Description |
builderForValue | Builder |
Type | Description |
TransferTypes.ObjectConditions.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TransferTypes.ObjectConditions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
TransferTypes.ObjectConditions.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final TransferTypes.ObjectConditions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
TransferTypes.ObjectConditions.Builder |