Class TransferTypes.ObjectConditions (1.40.0) 

public static final class TransferTypes.ObjectConditions extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferTypes.ObjectConditions

Static Fields

EXCLUDE_PREFIXES_FIELD_NUMBER

public static final int EXCLUDE_PREFIXES_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_PREFIXES_FIELD_NUMBER

public static final int INCLUDE_PREFIXES_FIELD_NUMBER
Field Value
Type Description
int

LAST_MODIFIED_BEFORE_FIELD_NUMBER

public static final int LAST_MODIFIED_BEFORE_FIELD_NUMBER
Field Value
Type Description
int

LAST_MODIFIED_SINCE_FIELD_NUMBER

public static final int LAST_MODIFIED_SINCE_FIELD_NUMBER
Field Value
Type Description
int

MAX_TIME_ELAPSED_SINCE_LAST_MODIFICATION_FIELD_NUMBER

public static final int MAX_TIME_ELAPSED_SINCE_LAST_MODIFICATION_FIELD_NUMBER
Field Value
Type Description
int

MIN_TIME_ELAPSED_SINCE_LAST_MODIFICATION_FIELD_NUMBER

public static final int MIN_TIME_ELAPSED_SINCE_LAST_MODIFICATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TransferTypes.ObjectConditions getDefaultInstance()
Returns
Type Description
TransferTypes.ObjectConditions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TransferTypes.ObjectConditions.Builder newBuilder()
Returns
Type Description
TransferTypes.ObjectConditions.Builder

newBuilder(TransferTypes.ObjectConditions prototype)

public static TransferTypes.ObjectConditions.Builder newBuilder(TransferTypes.ObjectConditions prototype)
Parameter
Name Description
prototype TransferTypes.ObjectConditions
Returns
Type Description
TransferTypes.ObjectConditions.Builder

parseDelimitedFrom(InputStream input)

public static TransferTypes.ObjectConditions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.ObjectConditions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TransferTypes.ObjectConditions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.ObjectConditions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferTypes.ObjectConditions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.ObjectConditions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferTypes.ObjectConditions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.ObjectConditions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TransferTypes.ObjectConditions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.ObjectConditions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TransferTypes.ObjectConditions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.ObjectConditions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.ObjectConditions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TransferTypes.ObjectConditions> parser()
Returns
Type Description
Parser<ObjectConditions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TransferTypes.ObjectConditions getDefaultInstanceForType()
Returns
Type Description
TransferTypes.ObjectConditions

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 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 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 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 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 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 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 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
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 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 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 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 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 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 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 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
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;

Returns
Type Description
Timestamp

The lastModifiedBefore.

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;

Returns
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 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 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;

Returns
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 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 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 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
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;

Returns
Type Description
Duration

The minTimeElapsedSinceLastModification.

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;

Returns
Type Description
DurationOrBuilder

getParserForType()

public Parser<TransferTypes.ObjectConditions> getParserForType()
Returns
Type Description
Parser<ObjectConditions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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;

Returns
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 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 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 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
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;

Returns
Type Description
boolean

Whether the minTimeElapsedSinceLastModification field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TransferTypes.ObjectConditions.Builder newBuilderForType()
Returns
Type Description
TransferTypes.ObjectConditions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.ObjectConditions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransferTypes.ObjectConditions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TransferTypes.ObjectConditions.Builder toBuilder()
Returns
Type Description
TransferTypes.ObjectConditions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException