software.amazon.awssdk.services.ebs.model.CompleteSnapshotRequest Maven / Gradle / Ivy
Show all versions of ebs 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.ebs.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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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 CompleteSnapshotRequest extends EbsRequest implements
ToCopyableBuilder {
private static final SdkField SNAPSHOT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SnapshotId").getter(getter(CompleteSnapshotRequest::snapshotId)).setter(setter(Builder::snapshotId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("snapshotId").build()).build();
private static final SdkField CHANGED_BLOCKS_COUNT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("ChangedBlocksCount").getter(getter(CompleteSnapshotRequest::changedBlocksCount))
.setter(setter(Builder::changedBlocksCount))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-ChangedBlocksCount").build())
.build();
private static final SdkField CHECKSUM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Checksum").getter(getter(CompleteSnapshotRequest::checksum)).setter(setter(Builder::checksum))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-Checksum").build()).build();
private static final SdkField CHECKSUM_ALGORITHM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ChecksumAlgorithm").getter(getter(CompleteSnapshotRequest::checksumAlgorithmAsString))
.setter(setter(Builder::checksumAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-Checksum-Algorithm").build())
.build();
private static final SdkField CHECKSUM_AGGREGATION_METHOD_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumAggregationMethod")
.getter(getter(CompleteSnapshotRequest::checksumAggregationMethodAsString))
.setter(setter(Builder::checksumAggregationMethod))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-Checksum-Aggregation-Method")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SNAPSHOT_ID_FIELD,
CHANGED_BLOCKS_COUNT_FIELD, CHECKSUM_FIELD, CHECKSUM_ALGORITHM_FIELD, CHECKSUM_AGGREGATION_METHOD_FIELD));
private final String snapshotId;
private final Integer changedBlocksCount;
private final String checksum;
private final String checksumAlgorithm;
private final String checksumAggregationMethod;
private CompleteSnapshotRequest(BuilderImpl builder) {
super(builder);
this.snapshotId = builder.snapshotId;
this.changedBlocksCount = builder.changedBlocksCount;
this.checksum = builder.checksum;
this.checksumAlgorithm = builder.checksumAlgorithm;
this.checksumAggregationMethod = builder.checksumAggregationMethod;
}
/**
*
* The ID of the snapshot.
*
*
* @return The ID of the snapshot.
*/
public String snapshotId() {
return snapshotId;
}
/**
*
* The number of blocks that were written to the snapshot.
*
*
* @return The number of blocks that were written to the snapshot.
*/
public Integer changedBlocksCount() {
return changedBlocksCount;
}
/**
*
* An aggregated Base-64 SHA256 checksum based on the checksums of each written block.
*
*
* To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written
* block in ascending order of their block index, concatenate them to form a single string, and then generate the
* checksum on the entire string using the SHA256 algorithm.
*
*
* @return An aggregated Base-64 SHA256 checksum based on the checksums of each written block.
*
* To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each
* written block in ascending order of their block index, concatenate them to form a single string, and then
* generate the checksum on the entire string using the SHA256 algorithm.
*/
public String checksum() {
return checksum;
}
/**
*
* The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #checksumAlgorithm}
* will return {@link ChecksumAlgorithm#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #checksumAlgorithmAsString}.
*
*
* @return The algorithm used to generate the checksum. Currently, the only supported algorithm is
* SHA256.
* @see ChecksumAlgorithm
*/
public ChecksumAlgorithm checksumAlgorithm() {
return ChecksumAlgorithm.fromValue(checksumAlgorithm);
}
/**
*
* The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #checksumAlgorithm}
* will return {@link ChecksumAlgorithm#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #checksumAlgorithmAsString}.
*
*
* @return The algorithm used to generate the checksum. Currently, the only supported algorithm is
* SHA256.
* @see ChecksumAlgorithm
*/
public String checksumAlgorithmAsString() {
return checksumAlgorithm;
}
/**
*
* The aggregation method used to generate the checksum. Currently, the only supported aggregation method is
* LINEAR.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #checksumAggregationMethod} will return {@link ChecksumAggregationMethod#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #checksumAggregationMethodAsString}.
*
*
* @return The aggregation method used to generate the checksum. Currently, the only supported aggregation method is
* LINEAR.
* @see ChecksumAggregationMethod
*/
public ChecksumAggregationMethod checksumAggregationMethod() {
return ChecksumAggregationMethod.fromValue(checksumAggregationMethod);
}
/**
*
* The aggregation method used to generate the checksum. Currently, the only supported aggregation method is
* LINEAR.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #checksumAggregationMethod} will return {@link ChecksumAggregationMethod#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #checksumAggregationMethodAsString}.
*
*
* @return The aggregation method used to generate the checksum. Currently, the only supported aggregation method is
* LINEAR.
* @see ChecksumAggregationMethod
*/
public String checksumAggregationMethodAsString() {
return checksumAggregationMethod;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(snapshotId());
hashCode = 31 * hashCode + Objects.hashCode(changedBlocksCount());
hashCode = 31 * hashCode + Objects.hashCode(checksum());
hashCode = 31 * hashCode + Objects.hashCode(checksumAlgorithmAsString());
hashCode = 31 * hashCode + Objects.hashCode(checksumAggregationMethodAsString());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CompleteSnapshotRequest)) {
return false;
}
CompleteSnapshotRequest other = (CompleteSnapshotRequest) obj;
return Objects.equals(snapshotId(), other.snapshotId())
&& Objects.equals(changedBlocksCount(), other.changedBlocksCount())
&& Objects.equals(checksum(), other.checksum())
&& Objects.equals(checksumAlgorithmAsString(), other.checksumAlgorithmAsString())
&& Objects.equals(checksumAggregationMethodAsString(), other.checksumAggregationMethodAsString());
}
/**
* 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 String toString() {
return ToString.builder("CompleteSnapshotRequest").add("SnapshotId", snapshotId())
.add("ChangedBlocksCount", changedBlocksCount()).add("Checksum", checksum())
.add("ChecksumAlgorithm", checksumAlgorithmAsString())
.add("ChecksumAggregationMethod", checksumAggregationMethodAsString()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SnapshotId":
return Optional.ofNullable(clazz.cast(snapshotId()));
case "ChangedBlocksCount":
return Optional.ofNullable(clazz.cast(changedBlocksCount()));
case "Checksum":
return Optional.ofNullable(clazz.cast(checksum()));
case "ChecksumAlgorithm":
return Optional.ofNullable(clazz.cast(checksumAlgorithmAsString()));
case "ChecksumAggregationMethod":
return Optional.ofNullable(clazz.cast(checksumAggregationMethodAsString()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CompleteSnapshotRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EbsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the snapshot.
*
*
* @param snapshotId
* The ID of the snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshotId(String snapshotId);
/**
*
* The number of blocks that were written to the snapshot.
*
*
* @param changedBlocksCount
* The number of blocks that were written to the snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder changedBlocksCount(Integer changedBlocksCount);
/**
*
* An aggregated Base-64 SHA256 checksum based on the checksums of each written block.
*
*
* To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each
* written block in ascending order of their block index, concatenate them to form a single string, and then
* generate the checksum on the entire string using the SHA256 algorithm.
*
*
* @param checksum
* An aggregated Base-64 SHA256 checksum based on the checksums of each written block.
*
* To generate the aggregated checksum using the linear aggregation method, arrange the checksums for
* each written block in ascending order of their block index, concatenate them to form a single string,
* and then generate the checksum on the entire string using the SHA256 algorithm.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder checksum(String checksum);
/**
*
* The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.
*
*
* @param checksumAlgorithm
* The algorithm used to generate the checksum. Currently, the only supported algorithm is
* SHA256.
* @see ChecksumAlgorithm
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChecksumAlgorithm
*/
Builder checksumAlgorithm(String checksumAlgorithm);
/**
*
* The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.
*
*
* @param checksumAlgorithm
* The algorithm used to generate the checksum. Currently, the only supported algorithm is
* SHA256.
* @see ChecksumAlgorithm
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChecksumAlgorithm
*/
Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm);
/**
*
* The aggregation method used to generate the checksum. Currently, the only supported aggregation method is
* LINEAR.
*
*
* @param checksumAggregationMethod
* The aggregation method used to generate the checksum. Currently, the only supported aggregation method
* is LINEAR.
* @see ChecksumAggregationMethod
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChecksumAggregationMethod
*/
Builder checksumAggregationMethod(String checksumAggregationMethod);
/**
*
* The aggregation method used to generate the checksum. Currently, the only supported aggregation method is
* LINEAR.
*
*
* @param checksumAggregationMethod
* The aggregation method used to generate the checksum. Currently, the only supported aggregation method
* is LINEAR.
* @see ChecksumAggregationMethod
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChecksumAggregationMethod
*/
Builder checksumAggregationMethod(ChecksumAggregationMethod checksumAggregationMethod);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EbsRequest.BuilderImpl implements Builder {
private String snapshotId;
private Integer changedBlocksCount;
private String checksum;
private String checksumAlgorithm;
private String checksumAggregationMethod;
private BuilderImpl() {
}
private BuilderImpl(CompleteSnapshotRequest model) {
super(model);
snapshotId(model.snapshotId);
changedBlocksCount(model.changedBlocksCount);
checksum(model.checksum);
checksumAlgorithm(model.checksumAlgorithm);
checksumAggregationMethod(model.checksumAggregationMethod);
}
public final String getSnapshotId() {
return snapshotId;
}
@Override
public final Builder snapshotId(String snapshotId) {
this.snapshotId = snapshotId;
return this;
}
public final void setSnapshotId(String snapshotId) {
this.snapshotId = snapshotId;
}
public final Integer getChangedBlocksCount() {
return changedBlocksCount;
}
@Override
public final Builder changedBlocksCount(Integer changedBlocksCount) {
this.changedBlocksCount = changedBlocksCount;
return this;
}
public final void setChangedBlocksCount(Integer changedBlocksCount) {
this.changedBlocksCount = changedBlocksCount;
}
public final String getChecksum() {
return checksum;
}
@Override
public final Builder checksum(String checksum) {
this.checksum = checksum;
return this;
}
public final void setChecksum(String checksum) {
this.checksum = checksum;
}
public final String getChecksumAlgorithm() {
return checksumAlgorithm;
}
@Override
public final Builder checksumAlgorithm(String checksumAlgorithm) {
this.checksumAlgorithm = checksumAlgorithm;
return this;
}
@Override
public final Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) {
this.checksumAlgorithm(checksumAlgorithm == null ? null : checksumAlgorithm.toString());
return this;
}
public final void setChecksumAlgorithm(String checksumAlgorithm) {
this.checksumAlgorithm = checksumAlgorithm;
}
public final String getChecksumAggregationMethod() {
return checksumAggregationMethod;
}
@Override
public final Builder checksumAggregationMethod(String checksumAggregationMethod) {
this.checksumAggregationMethod = checksumAggregationMethod;
return this;
}
@Override
public final Builder checksumAggregationMethod(ChecksumAggregationMethod checksumAggregationMethod) {
this.checksumAggregationMethod(checksumAggregationMethod == null ? null : checksumAggregationMethod.toString());
return this;
}
public final void setChecksumAggregationMethod(String checksumAggregationMethod) {
this.checksumAggregationMethod = checksumAggregationMethod;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CompleteSnapshotRequest build() {
return new CompleteSnapshotRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}