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

Class UploadPartResponse

java.lang.Object

com.ibm.cos.v2.core.SdkResponse

com.ibm.cos.v2.awscore.AwsResponse

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

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UploadPartResponse.Builder,UploadPartResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UploadPartResponse.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	bucketKeyEnabled() Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
static UploadPartResponse.Builder	builder()
String	checksumCRC32() The Base64 encoded, 32-bit CRC32 checksum of the object.
String	checksumCRC32C() The Base64 encoded, 32-bit CRC32C checksum of the object.
String	checksumCRC64NVME() This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
String	checksumSHA1() The Base64 encoded, 160-bit SHA1 digest of the object.
String	checksumSHA256() The Base64 encoded, 256-bit SHA256 digest of the object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	eTag() Entity tag for the uploaded object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
RequestCharged	requestCharged() Returns the value of the RequestCharged property for this object.
String	requestChargedAsString() Returns the value of the RequestCharged property for this object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UploadPartResponse.Builder>	serializableBuilderClass()
ServerSideEncryption	serverSideEncryption() The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).
String	serverSideEncryptionAsString() The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).
String	sseCustomerAlgorithm() If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
String	sseCustomerKeyMD5() If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
String	ssekmsKeyId() If present, indicates the ID of the KMS key that was used for object encryption.
UploadPartResponse.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.

Methods inherited from class com.ibm.cos.v2.services.s3.model.S3Response

responseMetadata

Methods inherited from class com.ibm.cos.v2.core.SdkResponse

sdkHttpResponse

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

serverSideEncryption

public final ServerSideEncryption serverSideEncryption()

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

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

Returns:

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

See Also:

ServerSideEncryption

serverSideEncryptionAsString

public final String serverSideEncryptionAsString()

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

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

Returns:

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

See Also:

ServerSideEncryption

eTag

public final String eTag()

Entity tag for the uploaded object.

Returns:

Entity tag for the uploaded object.

checksumCRC32

public final String checksumCRC32()

The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

Returns:

The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

checksumCRC32C

public final String checksumCRC32C()

The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

Returns:

The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

checksumCRC64NVME

public final String checksumCRC64NVME()

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit CRC64NVME checksum of the part. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit CRC64NVME checksum of the part. For more information, see Checking object integrity in the Amazon S3 User Guide.

checksumSHA1

public final String checksumSHA1()

The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

Returns:

The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

checksumSHA256

public final String checksumSHA256()

The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

Returns:

The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

sseCustomerAlgorithm

public final String sseCustomerAlgorithm()

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

Returns:

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

sseCustomerKeyMD5

public final String sseCustomerKeyMD5()

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

Returns:

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

ssekmsKeyId

public final String ssekmsKeyId()

If present, indicates the ID of the KMS key that was used for object encryption.

Returns:

If present, indicates the ID of the KMS key that was used for object encryption.

bucketKeyEnabled

public final Boolean bucketKeyEnabled()

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

Returns:

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

requestCharged

public final RequestCharged requestCharged()

Returns the value of the RequestCharged property for this object.

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

Returns:

The value of the RequestCharged property for this object.

See Also:

RequestCharged

requestChargedAsString

public final String requestChargedAsString()

Returns the value of the RequestCharged property for this object.

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

Returns:

The value of the RequestCharged property for this object.

See Also:

RequestCharged

toBuilder

public UploadPartResponse.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<UploadPartResponse.Builder,UploadPartResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static UploadPartResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.