software.amazon.awssdk.services.s3.model.UploadPartResponse Maven / Gradle / Ivy
Show all versions of s3 Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.s3.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class UploadPartResponse extends S3Response implements
ToCopyableBuilder {
private static final SdkField SERVER_SIDE_ENCRYPTION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ServerSideEncryption")
.getter(getter(UploadPartResponse::serverSideEncryptionAsString))
.setter(setter(Builder::serverSideEncryption))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-server-side-encryption")
.unmarshallLocationName("x-amz-server-side-encryption").build()).build();
private static final SdkField E_TAG_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ETag")
.getter(getter(UploadPartResponse::eTag))
.setter(setter(Builder::eTag))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("ETag").unmarshallLocationName("ETag")
.build()).build();
private static final SdkField CHECKSUM_CRC32_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumCRC32")
.getter(getter(UploadPartResponse::checksumCRC32))
.setter(setter(Builder::checksumCRC32))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-checksum-crc32")
.unmarshallLocationName("x-amz-checksum-crc32").build()).build();
private static final SdkField CHECKSUM_CRC32_C_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumCRC32C")
.getter(getter(UploadPartResponse::checksumCRC32C))
.setter(setter(Builder::checksumCRC32C))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-checksum-crc32c")
.unmarshallLocationName("x-amz-checksum-crc32c").build()).build();
private static final SdkField CHECKSUM_SHA1_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumSHA1")
.getter(getter(UploadPartResponse::checksumSHA1))
.setter(setter(Builder::checksumSHA1))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-checksum-sha1")
.unmarshallLocationName("x-amz-checksum-sha1").build()).build();
private static final SdkField CHECKSUM_SHA256_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumSHA256")
.getter(getter(UploadPartResponse::checksumSHA256))
.setter(setter(Builder::checksumSHA256))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-checksum-sha256")
.unmarshallLocationName("x-amz-checksum-sha256").build()).build();
private static final SdkField SSE_CUSTOMER_ALGORITHM_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SSECustomerAlgorithm")
.getter(getter(UploadPartResponse::sseCustomerAlgorithm))
.setter(setter(Builder::sseCustomerAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-server-side-encryption-customer-algorithm")
.unmarshallLocationName("x-amz-server-side-encryption-customer-algorithm").build()).build();
private static final SdkField SSE_CUSTOMER_KEY_MD5_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SSECustomerKeyMD5")
.getter(getter(UploadPartResponse::sseCustomerKeyMD5))
.setter(setter(Builder::sseCustomerKeyMD5))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-server-side-encryption-customer-key-MD5")
.unmarshallLocationName("x-amz-server-side-encryption-customer-key-MD5").build()).build();
private static final SdkField SSEKMS_KEY_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SSEKMSKeyId")
.getter(getter(UploadPartResponse::ssekmsKeyId))
.setter(setter(Builder::ssekmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-server-side-encryption-aws-kms-key-id")
.unmarshallLocationName("x-amz-server-side-encryption-aws-kms-key-id").build()).build();
private static final SdkField BUCKET_KEY_ENABLED_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("BucketKeyEnabled")
.getter(getter(UploadPartResponse::bucketKeyEnabled))
.setter(setter(Builder::bucketKeyEnabled))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-server-side-encryption-bucket-key-enabled")
.unmarshallLocationName("x-amz-server-side-encryption-bucket-key-enabled").build()).build();
private static final SdkField REQUEST_CHARGED_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("RequestCharged")
.getter(getter(UploadPartResponse::requestChargedAsString))
.setter(setter(Builder::requestCharged))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-request-charged")
.unmarshallLocationName("x-amz-request-charged").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SERVER_SIDE_ENCRYPTION_FIELD,
E_TAG_FIELD, CHECKSUM_CRC32_FIELD, CHECKSUM_CRC32_C_FIELD, CHECKSUM_SHA1_FIELD, CHECKSUM_SHA256_FIELD,
SSE_CUSTOMER_ALGORITHM_FIELD, SSE_CUSTOMER_KEY_MD5_FIELD, SSEKMS_KEY_ID_FIELD, BUCKET_KEY_ENABLED_FIELD,
REQUEST_CHARGED_FIELD));
private final String serverSideEncryption;
private final String eTag;
private final String checksumCRC32;
private final String checksumCRC32C;
private final String checksumSHA1;
private final String checksumSHA256;
private final String sseCustomerAlgorithm;
private final String sseCustomerKeyMD5;
private final String ssekmsKeyId;
private final Boolean bucketKeyEnabled;
private final String requestCharged;
private UploadPartResponse(BuilderImpl builder) {
super(builder);
this.serverSideEncryption = builder.serverSideEncryption;
this.eTag = builder.eTag;
this.checksumCRC32 = builder.checksumCRC32;
this.checksumCRC32C = builder.checksumCRC32C;
this.checksumSHA1 = builder.checksumSHA1;
this.checksumSHA256 = builder.checksumSHA256;
this.sseCustomerAlgorithm = builder.sseCustomerAlgorithm;
this.sseCustomerKeyMD5 = builder.sseCustomerKeyMD5;
this.ssekmsKeyId = builder.ssekmsKeyId;
this.bucketKeyEnabled = builder.bucketKeyEnabled;
this.requestCharged = builder.requestCharged;
}
/**
*
* 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,
* {@link #serverSideEncryption} will return {@link ServerSideEncryption#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #serverSideEncryptionAsString}.
*
*
* @return The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
* AES256
, aws:kms
).
* @see ServerSideEncryption
*/
public final ServerSideEncryption serverSideEncryption() {
return ServerSideEncryption.fromValue(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,
* {@link #serverSideEncryption} will return {@link ServerSideEncryption#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #serverSideEncryptionAsString}.
*
*
* @return The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
* AES256
, aws:kms
).
* @see ServerSideEncryption
*/
public final String serverSideEncryptionAsString() {
return serverSideEncryption;
}
/**
*
* Entity tag for the uploaded object.
*
*
* @return Entity tag for the uploaded object.
*/
public final String eTag() {
return eTag;
}
/**
*
* The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it 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.
*
*
* @return The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it 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.
*/
public final String checksumCRC32() {
return checksumCRC32;
}
/**
*
* The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it 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.
*
*
* @return The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it 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.
*/
public final String checksumCRC32C() {
return checksumCRC32C;
}
/**
*
* The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it 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.
*
*
* @return The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it 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.
*/
public final String checksumSHA1() {
return checksumSHA1;
}
/**
*
* The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it 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.
*
*
* @return The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it 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.
*/
public final String checksumSHA256() {
return checksumSHA256;
}
/**
*
* 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.
*
*
*
* @return 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.
*
*/
public final String sseCustomerAlgorithm() {
return sseCustomerAlgorithm;
}
/**
*
* 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.
*
*
*
* @return 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.
*
*/
public final String sseCustomerKeyMD5() {
return sseCustomerKeyMD5;
}
/**
*
* If present, indicates the ID of the KMS key that was used for object encryption.
*
*
* @return If present, indicates the ID of the KMS key that was used for object encryption.
*/
public final String ssekmsKeyId() {
return ssekmsKeyId;
}
/**
*
* Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management
* Service (KMS) keys (SSE-KMS).
*
*
* @return Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key
* Management Service (KMS) keys (SSE-KMS).
*/
public final Boolean bucketKeyEnabled() {
return bucketKeyEnabled;
}
/**
* 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, {@link #requestCharged}
* will return {@link RequestCharged#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #requestChargedAsString}.
*
*
* @return The value of the RequestCharged property for this object.
* @see RequestCharged
*/
public final RequestCharged requestCharged() {
return RequestCharged.fromValue(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, {@link #requestCharged}
* will return {@link RequestCharged#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #requestChargedAsString}.
*
*
* @return The value of the RequestCharged property for this object.
* @see RequestCharged
*/
public final String requestChargedAsString() {
return requestCharged;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(serverSideEncryptionAsString());
hashCode = 31 * hashCode + Objects.hashCode(eTag());
hashCode = 31 * hashCode + Objects.hashCode(checksumCRC32());
hashCode = 31 * hashCode + Objects.hashCode(checksumCRC32C());
hashCode = 31 * hashCode + Objects.hashCode(checksumSHA1());
hashCode = 31 * hashCode + Objects.hashCode(checksumSHA256());
hashCode = 31 * hashCode + Objects.hashCode(sseCustomerAlgorithm());
hashCode = 31 * hashCode + Objects.hashCode(sseCustomerKeyMD5());
hashCode = 31 * hashCode + Objects.hashCode(ssekmsKeyId());
hashCode = 31 * hashCode + Objects.hashCode(bucketKeyEnabled());
hashCode = 31 * hashCode + Objects.hashCode(requestChargedAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UploadPartResponse)) {
return false;
}
UploadPartResponse other = (UploadPartResponse) obj;
return Objects.equals(serverSideEncryptionAsString(), other.serverSideEncryptionAsString())
&& Objects.equals(eTag(), other.eTag()) && Objects.equals(checksumCRC32(), other.checksumCRC32())
&& Objects.equals(checksumCRC32C(), other.checksumCRC32C())
&& Objects.equals(checksumSHA1(), other.checksumSHA1())
&& Objects.equals(checksumSHA256(), other.checksumSHA256())
&& Objects.equals(sseCustomerAlgorithm(), other.sseCustomerAlgorithm())
&& Objects.equals(sseCustomerKeyMD5(), other.sseCustomerKeyMD5())
&& Objects.equals(ssekmsKeyId(), other.ssekmsKeyId())
&& Objects.equals(bucketKeyEnabled(), other.bucketKeyEnabled())
&& Objects.equals(requestChargedAsString(), other.requestChargedAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("UploadPartResponse").add("ServerSideEncryption", serverSideEncryptionAsString())
.add("ETag", eTag()).add("ChecksumCRC32", checksumCRC32()).add("ChecksumCRC32C", checksumCRC32C())
.add("ChecksumSHA1", checksumSHA1()).add("ChecksumSHA256", checksumSHA256())
.add("SSECustomerAlgorithm", sseCustomerAlgorithm()).add("SSECustomerKeyMD5", sseCustomerKeyMD5())
.add("SSEKMSKeyId", ssekmsKeyId() == null ? null : "*** Sensitive Data Redacted ***")
.add("BucketKeyEnabled", bucketKeyEnabled()).add("RequestCharged", requestChargedAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ServerSideEncryption":
return Optional.ofNullable(clazz.cast(serverSideEncryptionAsString()));
case "ETag":
return Optional.ofNullable(clazz.cast(eTag()));
case "ChecksumCRC32":
return Optional.ofNullable(clazz.cast(checksumCRC32()));
case "ChecksumCRC32C":
return Optional.ofNullable(clazz.cast(checksumCRC32C()));
case "ChecksumSHA1":
return Optional.ofNullable(clazz.cast(checksumSHA1()));
case "ChecksumSHA256":
return Optional.ofNullable(clazz.cast(checksumSHA256()));
case "SSECustomerAlgorithm":
return Optional.ofNullable(clazz.cast(sseCustomerAlgorithm()));
case "SSECustomerKeyMD5":
return Optional.ofNullable(clazz.cast(sseCustomerKeyMD5()));
case "SSEKMSKeyId":
return Optional.ofNullable(clazz.cast(ssekmsKeyId()));
case "BucketKeyEnabled":
return Optional.ofNullable(clazz.cast(bucketKeyEnabled()));
case "RequestCharged":
return Optional.ofNullable(clazz.cast(requestChargedAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function