com.ibm.cos.v2.services.s3.model

Class MultipartUpload

java.lang.Object

com.ibm.cos.v2.services.s3.model.MultipartUpload

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<MultipartUpload.Builder,MultipartUpload>, Serializable

@Generated(value="com.ibm.cos.v2:codegen")
public final class MultipartUpload
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MultipartUpload.Builder,MultipartUpload>

Container for the MultipartUpload for the Amazon S3 object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MultipartUpload.Builder

Method Summary

Modifier and Type	Method and Description
static MultipartUpload.Builder	builder()
ChecksumAlgorithm	checksumAlgorithm() The algorithm that was used to create a checksum of the object.
String	checksumAlgorithmAsString() The algorithm that was used to create a checksum of the object.
ChecksumType	checksumType() The checksum type that is used to calculate the object’s checksum value.
String	checksumTypeAsString() The checksum type that is used to calculate the object’s checksum value.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	initiated() Date and time at which the multipart upload was initiated.
Initiator	initiator() Identifies who initiated the multipart upload.
String	key() Key of the object for which the multipart upload was initiated.
Owner	owner() Specifies the owner of the object that is part of the multipart upload.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MultipartUpload.Builder>	serializableBuilderClass()
StorageClass	storageClass() The class of storage used to store the object.
String	storageClassAsString() The class of storage used to store the object.
MultipartUpload.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	uploadId() Upload ID that identifies the multipart upload.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

uploadId

public final String uploadId()

Upload ID that identifies the multipart upload.

Returns:

Upload ID that identifies the multipart upload.

key

public final String key()

Key of the object for which the multipart upload was initiated.

Returns:

Key of the object for which the multipart upload was initiated.

initiated

public final Instant initiated()

Date and time at which the multipart upload was initiated.

Returns:

Date and time at which the multipart upload was initiated.

storageClass

public final StorageClass storageClass()

The class of storage used to store the object.

Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

Returns:

The class of storage used to store the object.

Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

See Also:

StorageClass

storageClassAsString

public final String storageClassAsString()

The class of storage used to store the object.

Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

Returns:

The class of storage used to store the object.

Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

See Also:

StorageClass

owner

public final Owner owner()

Specifies the owner of the object that is part of the multipart upload.

Directory buckets - The bucket owner is returned as the object owner for all the objects.

Returns:

Specifies the owner of the object that is part of the multipart upload.

Directory buckets - The bucket owner is returned as the object owner for all the objects.

initiator

public final Initiator initiator()

Identifies who initiated the multipart upload.

Returns:

Identifies who initiated the multipart upload.

checksumAlgorithm

public final ChecksumAlgorithm checksumAlgorithm()

The algorithm that was used to create a checksum of the object.

If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

Returns:

The algorithm that was used to create a checksum of the object.

See Also:

ChecksumAlgorithm

checksumAlgorithmAsString

public final String checksumAlgorithmAsString()

The algorithm that was used to create a checksum of the object.

If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

Returns:

The algorithm that was used to create a checksum of the object.

See Also:

ChecksumAlgorithm

checksumType

public final ChecksumType checksumType()

The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.

If the service returns an enum value that is not available in the current SDK version, checksumType will return ChecksumType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumTypeAsString().

Returns:

The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.

See Also:

ChecksumType

checksumTypeAsString

public final String checksumTypeAsString()

The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.

If the service returns an enum value that is not available in the current SDK version, checksumType will return ChecksumType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumTypeAsString().

Returns:

The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.

See Also:

ChecksumType

toBuilder

public MultipartUpload.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MultipartUpload.Builder,MultipartUpload>

Returns:

a builder for type T

builder

public static MultipartUpload.Builder builder()

serializableBuilderClass

public static Class<? extends MultipartUpload.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.