software.amazon.awssdk.services.s3.model.ObjectPart 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.io.Serializable;
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;
/**
*
* A container for elements related to an individual part.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ObjectPart implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField PART_NUMBER_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("PartNumber")
.getter(getter(ObjectPart::partNumber))
.setter(setter(Builder::partNumber))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PartNumber")
.unmarshallLocationName("PartNumber").build()).build();
private static final SdkField SIZE_FIELD = SdkField
. builder(MarshallingType.LONG)
.memberName("Size")
.getter(getter(ObjectPart::size))
.setter(setter(Builder::size))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Size")
.unmarshallLocationName("Size").build()).build();
private static final SdkField CHECKSUM_CRC32_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumCRC32")
.getter(getter(ObjectPart::checksumCRC32))
.setter(setter(Builder::checksumCRC32))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChecksumCRC32")
.unmarshallLocationName("ChecksumCRC32").build()).build();
private static final SdkField CHECKSUM_CRC32_C_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumCRC32C")
.getter(getter(ObjectPart::checksumCRC32C))
.setter(setter(Builder::checksumCRC32C))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChecksumCRC32C")
.unmarshallLocationName("ChecksumCRC32C").build()).build();
private static final SdkField CHECKSUM_SHA1_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumSHA1")
.getter(getter(ObjectPart::checksumSHA1))
.setter(setter(Builder::checksumSHA1))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChecksumSHA1")
.unmarshallLocationName("ChecksumSHA1").build()).build();
private static final SdkField CHECKSUM_SHA256_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumSHA256")
.getter(getter(ObjectPart::checksumSHA256))
.setter(setter(Builder::checksumSHA256))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChecksumSHA256")
.unmarshallLocationName("ChecksumSHA256").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PART_NUMBER_FIELD, SIZE_FIELD,
CHECKSUM_CRC32_FIELD, CHECKSUM_CRC32_C_FIELD, CHECKSUM_SHA1_FIELD, CHECKSUM_SHA256_FIELD));
private static final long serialVersionUID = 1L;
private final Integer partNumber;
private final Long size;
private final String checksumCRC32;
private final String checksumCRC32C;
private final String checksumSHA1;
private final String checksumSHA256;
private ObjectPart(BuilderImpl builder) {
this.partNumber = builder.partNumber;
this.size = builder.size;
this.checksumCRC32 = builder.checksumCRC32;
this.checksumCRC32C = builder.checksumCRC32C;
this.checksumSHA1 = builder.checksumSHA1;
this.checksumSHA256 = builder.checksumSHA256;
}
/**
*
* The part number identifying the part. This value is a positive integer between 1 and 10,000.
*
*
* @return The part number identifying the part. This value is a positive integer between 1 and 10,000.
*/
public final Integer partNumber() {
return partNumber;
}
/**
*
* The size of the uploaded part in bytes.
*
*
* @return The size of the uploaded part in bytes.
*/
public final Long size() {
return size;
}
/**
*
* 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, 32-bit CRC32 checksum of the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* @return 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, 32-bit CRC32 checksum of the object. For
* more information, 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;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(partNumber());
hashCode = 31 * hashCode + Objects.hashCode(size());
hashCode = 31 * hashCode + Objects.hashCode(checksumCRC32());
hashCode = 31 * hashCode + Objects.hashCode(checksumCRC32C());
hashCode = 31 * hashCode + Objects.hashCode(checksumSHA1());
hashCode = 31 * hashCode + Objects.hashCode(checksumSHA256());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ObjectPart)) {
return false;
}
ObjectPart other = (ObjectPart) obj;
return Objects.equals(partNumber(), other.partNumber()) && Objects.equals(size(), other.size())
&& Objects.equals(checksumCRC32(), other.checksumCRC32())
&& Objects.equals(checksumCRC32C(), other.checksumCRC32C())
&& Objects.equals(checksumSHA1(), other.checksumSHA1())
&& Objects.equals(checksumSHA256(), other.checksumSHA256());
}
/**
* 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("ObjectPart").add("PartNumber", partNumber()).add("Size", size())
.add("ChecksumCRC32", checksumCRC32()).add("ChecksumCRC32C", checksumCRC32C())
.add("ChecksumSHA1", checksumSHA1()).add("ChecksumSHA256", checksumSHA256()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PartNumber":
return Optional.ofNullable(clazz.cast(partNumber()));
case "Size":
return Optional.ofNullable(clazz.cast(size()));
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()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ObjectPart) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The part number identifying the part. This value is a positive integer between 1 and 10,000.
*
*
* @param partNumber
* The part number identifying the part. This value is a positive integer between 1 and 10,000.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder partNumber(Integer partNumber);
/**
*
* The size of the uploaded part in bytes.
*
*
* @param size
* The size of the uploaded part in bytes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder size(Long size);
/**
*
* 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, 32-bit CRC32 checksum of the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* @param checksumCRC32
* 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, 32-bit CRC32 checksum of the
* object. For more information, see Checking
* object integrity in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder checksumCRC32(String 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.
*
*
* @param checksumCRC32C
* 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 Returns a reference to this object so that method calls can be chained together.
*/
Builder checksumCRC32C(String 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.
*
*
* @param checksumSHA1
* 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 Returns a reference to this object so that method calls can be chained together.
*/
Builder checksumSHA1(String 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.
*
*
* @param checksumSHA256
* 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 Returns a reference to this object so that method calls can be chained together.
*/
Builder checksumSHA256(String checksumSHA256);
}
static final class BuilderImpl implements Builder {
private Integer partNumber;
private Long size;
private String checksumCRC32;
private String checksumCRC32C;
private String checksumSHA1;
private String checksumSHA256;
private BuilderImpl() {
}
private BuilderImpl(ObjectPart model) {
partNumber(model.partNumber);
size(model.size);
checksumCRC32(model.checksumCRC32);
checksumCRC32C(model.checksumCRC32C);
checksumSHA1(model.checksumSHA1);
checksumSHA256(model.checksumSHA256);
}
public final Integer getPartNumber() {
return partNumber;
}
public final void setPartNumber(Integer partNumber) {
this.partNumber = partNumber;
}
@Override
public final Builder partNumber(Integer partNumber) {
this.partNumber = partNumber;
return this;
}
public final Long getSize() {
return size;
}
public final void setSize(Long size) {
this.size = size;
}
@Override
public final Builder size(Long size) {
this.size = size;
return this;
}
public final String getChecksumCRC32() {
return checksumCRC32;
}
public final void setChecksumCRC32(String checksumCRC32) {
this.checksumCRC32 = checksumCRC32;
}
@Override
public final Builder checksumCRC32(String checksumCRC32) {
this.checksumCRC32 = checksumCRC32;
return this;
}
public final String getChecksumCRC32C() {
return checksumCRC32C;
}
public final void setChecksumCRC32C(String checksumCRC32C) {
this.checksumCRC32C = checksumCRC32C;
}
@Override
public final Builder checksumCRC32C(String checksumCRC32C) {
this.checksumCRC32C = checksumCRC32C;
return this;
}
public final String getChecksumSHA1() {
return checksumSHA1;
}
public final void setChecksumSHA1(String checksumSHA1) {
this.checksumSHA1 = checksumSHA1;
}
@Override
public final Builder checksumSHA1(String checksumSHA1) {
this.checksumSHA1 = checksumSHA1;
return this;
}
public final String getChecksumSHA256() {
return checksumSHA256;
}
public final void setChecksumSHA256(String checksumSHA256) {
this.checksumSHA256 = checksumSHA256;
}
@Override
public final Builder checksumSHA256(String checksumSHA256) {
this.checksumSHA256 = checksumSHA256;
return this;
}
@Override
public ObjectPart build() {
return new ObjectPart(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}