software.amazon.awssdk.services.ebs.model.GetSnapshotBlockRequest 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 GetSnapshotBlockRequest extends EbsRequest implements
ToCopyableBuilder {
private static final SdkField SNAPSHOT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SnapshotId").getter(getter(GetSnapshotBlockRequest::snapshotId)).setter(setter(Builder::snapshotId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("snapshotId").build()).build();
private static final SdkField BLOCK_INDEX_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("BlockIndex").getter(getter(GetSnapshotBlockRequest::blockIndex)).setter(setter(Builder::blockIndex))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("blockIndex").build()).build();
private static final SdkField BLOCK_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("BlockToken").getter(getter(GetSnapshotBlockRequest::blockToken)).setter(setter(Builder::blockToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("blockToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SNAPSHOT_ID_FIELD,
BLOCK_INDEX_FIELD, BLOCK_TOKEN_FIELD));
private final String snapshotId;
private final Integer blockIndex;
private final String blockToken;
private GetSnapshotBlockRequest(BuilderImpl builder) {
super(builder);
this.snapshotId = builder.snapshotId;
this.blockIndex = builder.blockIndex;
this.blockToken = builder.blockToken;
}
/**
*
* The ID of the snapshot containing the block from which to get data.
*
*
*
* If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the
* snapshot. For more information, see Using encryption in
* the Amazon Elastic Compute Cloud User Guide.
*
*
*
* @return The ID of the snapshot containing the block from which to get data.
*
* If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to
* encrypt the snapshot. For more information, see Using
* encryption in the Amazon Elastic Compute Cloud User Guide.
*
*/
public final String snapshotId() {
return snapshotId;
}
/**
*
* The block index of the block in which to read the data. A block index is a logical index in units of
* 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical
* volume by the block size (logical offset of data/524288). The logical offset of the data must be
* 512 KiB aligned.
*
*
* @return The block index of the block in which to read the data. A block index is a logical index in units of
* 512 KiB blocks. To identify the block index, divide the logical offset of the data in the
* logical volume by the block size (logical offset of data/524288). The logical offset of the
* data must be 512 KiB aligned.
*/
public final Integer blockIndex() {
return blockIndex;
}
/**
*
* The block token of the block from which to get data. You can obtain the BlockToken by running the
* ListChangedBlocks or ListSnapshotBlocks operations.
*
*
* @return The block token of the block from which to get data. You can obtain the BlockToken by
* running the ListChangedBlocks or ListSnapshotBlocks operations.
*/
public final String blockToken() {
return blockToken;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(snapshotId());
hashCode = 31 * hashCode + Objects.hashCode(blockIndex());
hashCode = 31 * hashCode + Objects.hashCode(blockToken());
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 GetSnapshotBlockRequest)) {
return false;
}
GetSnapshotBlockRequest other = (GetSnapshotBlockRequest) obj;
return Objects.equals(snapshotId(), other.snapshotId()) && Objects.equals(blockIndex(), other.blockIndex())
&& Objects.equals(blockToken(), other.blockToken());
}
/**
* 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("GetSnapshotBlockRequest").add("SnapshotId", snapshotId()).add("BlockIndex", blockIndex())
.add("BlockToken", blockToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SnapshotId":
return Optional.ofNullable(clazz.cast(snapshotId()));
case "BlockIndex":
return Optional.ofNullable(clazz.cast(blockIndex()));
case "BlockToken":
return Optional.ofNullable(clazz.cast(blockToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetSnapshotBlockRequest) 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 containing the block from which to get data.
*
*
*
* If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt
* the snapshot. For more information, see Using
* encryption in the Amazon Elastic Compute Cloud User Guide.
*
*
*
* @param snapshotId
* The ID of the snapshot containing the block from which to get data.
*
* If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to
* encrypt the snapshot. For more information, see Using
* encryption in the Amazon Elastic Compute Cloud User Guide.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshotId(String snapshotId);
/**
*
* The block index of the block in which to read the data. A block index is a logical index in units of
* 512 KiB blocks. To identify the block index, divide the logical offset of the data in the
* logical volume by the block size (logical offset of data/524288). The logical offset of the data
* must be 512 KiB aligned.
*
*
* @param blockIndex
* The block index of the block in which to read the data. A block index is a logical index in units of
* 512 KiB blocks. To identify the block index, divide the logical offset of the data in the
* logical volume by the block size (logical offset of data/524288). The logical offset of
* the data must be 512 KiB aligned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder blockIndex(Integer blockIndex);
/**
*
* The block token of the block from which to get data. You can obtain the BlockToken by running
* the ListChangedBlocks or ListSnapshotBlocks operations.
*
*
* @param blockToken
* The block token of the block from which to get data. You can obtain the BlockToken by
* running the ListChangedBlocks or ListSnapshotBlocks operations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder blockToken(String blockToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EbsRequest.BuilderImpl implements Builder {
private String snapshotId;
private Integer blockIndex;
private String blockToken;
private BuilderImpl() {
}
private BuilderImpl(GetSnapshotBlockRequest model) {
super(model);
snapshotId(model.snapshotId);
blockIndex(model.blockIndex);
blockToken(model.blockToken);
}
public final String getSnapshotId() {
return snapshotId;
}
public final void setSnapshotId(String snapshotId) {
this.snapshotId = snapshotId;
}
@Override
public final Builder snapshotId(String snapshotId) {
this.snapshotId = snapshotId;
return this;
}
public final Integer getBlockIndex() {
return blockIndex;
}
public final void setBlockIndex(Integer blockIndex) {
this.blockIndex = blockIndex;
}
@Override
public final Builder blockIndex(Integer blockIndex) {
this.blockIndex = blockIndex;
return this;
}
public final String getBlockToken() {
return blockToken;
}
public final void setBlockToken(String blockToken) {
this.blockToken = blockToken;
}
@Override
public final Builder blockToken(String blockToken) {
this.blockToken = blockToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetSnapshotBlockRequest build() {
return new GetSnapshotBlockRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}