PutObjectResponse (IBM COS Java SDK

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<PutObjectResponse.Builder,PutObjectResponse>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutObjectResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PutObjectResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`bucketKeyEnabled()` Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
`static PutObjectResponse.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()` The Base64 encoded, 64-bit `CRC64NVME` checksum of the object.
`String`	`checksumSHA1()` The Base64 encoded, 160-bit `SHA1` digest of the object.
`String`	`checksumSHA256()` The Base64 encoded, 256-bit `SHA256` digest of the object.
`ChecksumType`	`checksumType()` This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
`String`	`checksumTypeAsString()` This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
`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.
`String`	`expiration()` If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header.
`<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 PutObjectResponse.Builder>`	`serializableBuilderClass()`
`ServerSideEncryption`	`serverSideEncryption()` The server-side encryption algorithm used when you store this object in Amazon S3.
`String`	`serverSideEncryptionAsString()` The server-side encryption algorithm used when you store this object in Amazon S3.
`Long`	`size()` The size of the object in bytes.
`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`	`ssekmsEncryptionContext()` If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption.
`String`	`ssekmsKeyId()` If present, indicates the ID of the KMS key that was used for object encryption.
`PutObjectResponse.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`	`versionId()` Version ID of the 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
  - expiration
```
public final String expiration()
```
    If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.
    
    Object expiration information is not returned in directory buckets and this header returns the value " NotImplemented" in all responses for directory buckets.
    
    Returns:
    
    If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.
    
    Object expiration information is not returned in directory buckets and this header returns the value " NotImplemented" in all responses for directory buckets.
  - eTag
```
public final String eTag()
```
    Entity tag for the uploaded object.
    
    General purpose buckets - To ensure that data is not corrupted traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
    
    Directory buckets - The ETag for the object in a directory bucket isn't the MD5 digest of the object.
    
    Returns:
    
    Entity tag for the uploaded object.
    
    General purpose buckets - To ensure that data is not corrupted traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
    
    Directory buckets - The ETag for the object in a directory bucket isn't the MD5 digest of the 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()
```
    The Base64 encoded, 64-bit CRC64NVME checksum of the object. This header is present if the object was uploaded with the CRC64NVME checksum algorithm, or if it was uploaded without a checksum (and Amazon S3 added the default checksum, CRC64NVME, to the uploaded object). 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, 64-bit CRC64NVME checksum of the object. This header is present if the object was uploaded with the CRC64NVME checksum algorithm, or if it was uploaded without a checksum (and Amazon S3 added the default checksum, CRC64NVME, to the uploaded object). For more information about how checksums are calculated with multipart uploads, 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.
  - checksumType
```
public final ChecksumType checksumType()
```
    This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. For PutObject uploads, the checksum type is always FULL_OBJECT. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. 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:
    
    This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. For PutObject uploads, the checksum type is always FULL_OBJECT. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    See Also:
    
    ChecksumType
  - checksumTypeAsString
```
public final String checksumTypeAsString()
```
    This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. For PutObject uploads, the checksum type is always FULL_OBJECT. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. 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:
    
    This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. For PutObject uploads, the checksum type is always FULL_OBJECT. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    See Also:
    
    ChecksumType
  - serverSideEncryption
```
public final ServerSideEncryption serverSideEncryption()
```
    The server-side encryption algorithm used when you store this object in Amazon S3.
    
    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.
    
    See Also:
    
    ServerSideEncryption
  - serverSideEncryptionAsString
```
public final String serverSideEncryptionAsString()
```
    The server-side encryption algorithm used when you store this object in Amazon S3.
    
    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.
    
    See Also:
    
    ServerSideEncryption
  - versionId
```
public final String versionId()
```
    Version ID of the object.
    
    If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Version ID of the object.
    
    If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.
    
    This functionality is not supported for directory buckets.
  - 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.
  - ssekmsEncryptionContext
```
public final String ssekmsEncryptionContext()
```
    If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.
    
    Returns:
    
    If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.
  - bucketKeyEnabled
```
public final Boolean bucketKeyEnabled()
```
    Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
    
    Returns:
    
    Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
  - size
```
public final Long size()
```
    The size of the object in bytes. This value is only be present if you append to an object.
    
    This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.
    
    Returns:
    
    The size of the object in bytes. This value is only be present if you append to an object.
    
    This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.
  - 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 PutObjectResponse.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<PutObjectResponse.Builder,PutObjectResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static PutObjectResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutObjectResponse.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.

Class PutObjectResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

expiration

eTag

checksumCRC32

checksumCRC32C

checksumCRC64NVME

checksumSHA1

checksumSHA256

checksumType

checksumTypeAsString

serverSideEncryption

serverSideEncryptionAsString

versionId

sseCustomerAlgorithm

sseCustomerKeyMD5

ssekmsKeyId

ssekmsEncryptionContext

bucketKeyEnabled

size

requestCharged

requestChargedAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField