software.amazon.awssdk.services.storagegateway.model.CreateTapeWithBarcodeRequest Maven / Gradle / Ivy
/*
* Copyright 2014-2019 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.storagegateway.model;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* CreateTapeWithBarcodeInput
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateTapeWithBarcodeRequest extends StorageGatewayRequest implements
ToCopyableBuilder {
private static final SdkField GATEWAY_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateTapeWithBarcodeRequest::gatewayARN)).setter(setter(Builder::gatewayARN))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GatewayARN").build()).build();
private static final SdkField TAPE_SIZE_IN_BYTES_FIELD = SdkField. builder(MarshallingType.LONG)
.getter(getter(CreateTapeWithBarcodeRequest::tapeSizeInBytes)).setter(setter(Builder::tapeSizeInBytes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TapeSizeInBytes").build()).build();
private static final SdkField TAPE_BARCODE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateTapeWithBarcodeRequest::tapeBarcode)).setter(setter(Builder::tapeBarcode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TapeBarcode").build()).build();
private static final SdkField KMS_ENCRYPTED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.getter(getter(CreateTapeWithBarcodeRequest::kmsEncrypted)).setter(setter(Builder::kmsEncrypted))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KMSEncrypted").build()).build();
private static final SdkField KMS_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateTapeWithBarcodeRequest::kmsKey)).setter(setter(Builder::kmsKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KMSKey").build()).build();
private static final SdkField POOL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateTapeWithBarcodeRequest::poolId)).setter(setter(Builder::poolId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PoolId").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(CreateTapeWithBarcodeRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(GATEWAY_ARN_FIELD,
TAPE_SIZE_IN_BYTES_FIELD, TAPE_BARCODE_FIELD, KMS_ENCRYPTED_FIELD, KMS_KEY_FIELD, POOL_ID_FIELD, TAGS_FIELD));
private final String gatewayARN;
private final Long tapeSizeInBytes;
private final String tapeBarcode;
private final Boolean kmsEncrypted;
private final String kmsKey;
private final String poolId;
private final List tags;
private CreateTapeWithBarcodeRequest(BuilderImpl builder) {
super(builder);
this.gatewayARN = builder.gatewayARN;
this.tapeSizeInBytes = builder.tapeSizeInBytes;
this.tapeBarcode = builder.tapeBarcode;
this.kmsEncrypted = builder.kmsEncrypted;
this.kmsKey = builder.kmsKey;
this.poolId = builder.poolId;
this.tags = builder.tags;
}
/**
*
* The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the
* ListGateways operation to return a list of gateways for your account and AWS Region.
*
*
* @return The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use
* the ListGateways operation to return a list of gateways for your account and AWS Region.
*/
public String gatewayARN() {
return gatewayARN;
}
/**
*
* The size, in bytes, of the virtual tape that you want to create.
*
*
*
* The size must be aligned by gigabyte (1024*1024*1024 byte).
*
*
*
* @return The size, in bytes, of the virtual tape that you want to create.
*
* The size must be aligned by gigabyte (1024*1024*1024 byte).
*
*/
public Long tapeSizeInBytes() {
return tapeSizeInBytes;
}
/**
*
* The barcode that you want to assign to the tape.
*
*
*
* Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
*
*
*
* @return The barcode that you want to assign to the tape.
*
* Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
*
*/
public String tapeBarcode() {
return tapeBarcode;
}
/**
*
* True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon
* S3. Optional.
*
*
* @return True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by
* Amazon S3. Optional.
*/
public Boolean kmsEncrypted() {
return kmsEncrypted;
}
/**
*
* The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This value can only
* be set when KMSEncrypted is true. Optional.
*
*
* @return The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This value
* can only be set when KMSEncrypted is true. Optional.
*/
public String kmsKey() {
return kmsKey;
}
/**
*
* The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3
* storage class that is associated with the pool. When you use your backup application to eject the tape, the tape
* is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.
*
*
* Valid values: "GLACIER", "DEEP_ARCHIVE"
*
*
* @return The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in
* the S3 storage class that is associated with the pool. When you use your backup application to eject the
* tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to
* the pool.
*
* Valid values: "GLACIER", "DEEP_ARCHIVE"
*/
public String poolId() {
return poolId;
}
/**
*
* A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the
* maximum length for a tag's value is 256.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a
* key-value pair.
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and
* the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters,
* and the maximum length for a tag's value is 256.
*
*/
public List tags() {
return tags;
}
@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(gatewayARN());
hashCode = 31 * hashCode + Objects.hashCode(tapeSizeInBytes());
hashCode = 31 * hashCode + Objects.hashCode(tapeBarcode());
hashCode = 31 * hashCode + Objects.hashCode(kmsEncrypted());
hashCode = 31 * hashCode + Objects.hashCode(kmsKey());
hashCode = 31 * hashCode + Objects.hashCode(poolId());
hashCode = 31 * hashCode + Objects.hashCode(tags());
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 CreateTapeWithBarcodeRequest)) {
return false;
}
CreateTapeWithBarcodeRequest other = (CreateTapeWithBarcodeRequest) obj;
return Objects.equals(gatewayARN(), other.gatewayARN()) && Objects.equals(tapeSizeInBytes(), other.tapeSizeInBytes())
&& Objects.equals(tapeBarcode(), other.tapeBarcode()) && Objects.equals(kmsEncrypted(), other.kmsEncrypted())
&& Objects.equals(kmsKey(), other.kmsKey()) && Objects.equals(poolId(), other.poolId())
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateTapeWithBarcodeRequest").add("GatewayARN", gatewayARN())
.add("TapeSizeInBytes", tapeSizeInBytes()).add("TapeBarcode", tapeBarcode()).add("KMSEncrypted", kmsEncrypted())
.add("KMSKey", kmsKey()).add("PoolId", poolId()).add("Tags", tags()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "GatewayARN":
return Optional.ofNullable(clazz.cast(gatewayARN()));
case "TapeSizeInBytes":
return Optional.ofNullable(clazz.cast(tapeSizeInBytes()));
case "TapeBarcode":
return Optional.ofNullable(clazz.cast(tapeBarcode()));
case "KMSEncrypted":
return Optional.ofNullable(clazz.cast(kmsEncrypted()));
case "KMSKey":
return Optional.ofNullable(clazz.cast(kmsKey()));
case "PoolId":
return Optional.ofNullable(clazz.cast(poolId()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateTapeWithBarcodeRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends StorageGatewayRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the
* ListGateways operation to return a list of gateways for your account and AWS Region.
*
*
* @param gatewayARN
* The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with.
* Use the ListGateways operation to return a list of gateways for your account and AWS Region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder gatewayARN(String gatewayARN);
/**
*
* The size, in bytes, of the virtual tape that you want to create.
*
*
*
* The size must be aligned by gigabyte (1024*1024*1024 byte).
*
*
*
* @param tapeSizeInBytes
* The size, in bytes, of the virtual tape that you want to create.
*
* The size must be aligned by gigabyte (1024*1024*1024 byte).
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tapeSizeInBytes(Long tapeSizeInBytes);
/**
*
* The barcode that you want to assign to the tape.
*
*
*
* Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
*
*
*
* @param tapeBarcode
* The barcode that you want to assign to the tape.
*
* Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tapeBarcode(String tapeBarcode);
/**
*
* True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by
* Amazon S3. Optional.
*
*
* @param kmsEncrypted
* True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed
* by Amazon S3. Optional.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsEncrypted(Boolean kmsEncrypted);
/**
*
* The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This value can
* only be set when KMSEncrypted is true. Optional.
*
*
* @param kmsKey
* The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This
* value can only be set when KMSEncrypted is true. Optional.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKey(String kmsKey);
/**
*
* The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the
* S3 storage class that is associated with the pool. When you use your backup application to eject the tape,
* the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.
*
*
* Valid values: "GLACIER", "DEEP_ARCHIVE"
*
*
* @param poolId
* The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived
* in the S3 storage class that is associated with the pool. When you use your backup application to
* eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that
* corresponds to the pool.
*
* Valid values: "GLACIER", "DEEP_ARCHIVE"
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder poolId(String poolId);
/**
*
* A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value
* pair.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the
* maximum length for a tag's value is 256.
*
*
*
* @param tags
* A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a
* key-value pair.
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and
* the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128
* characters, and the maximum length for a tag's value is 256.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value
* pair.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the
* maximum length for a tag's value is 256.
*
*
*
* @param tags
* A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a
* key-value pair.
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and
* the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128
* characters, and the maximum length for a tag's value is 256.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value
* pair.
*
*
*
* Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
* following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the
* maximum length for a tag's value is 256.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends StorageGatewayRequest.BuilderImpl implements Builder {
private String gatewayARN;
private Long tapeSizeInBytes;
private String tapeBarcode;
private Boolean kmsEncrypted;
private String kmsKey;
private String poolId;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateTapeWithBarcodeRequest model) {
super(model);
gatewayARN(model.gatewayARN);
tapeSizeInBytes(model.tapeSizeInBytes);
tapeBarcode(model.tapeBarcode);
kmsEncrypted(model.kmsEncrypted);
kmsKey(model.kmsKey);
poolId(model.poolId);
tags(model.tags);
}
public final String getGatewayARN() {
return gatewayARN;
}
@Override
public final Builder gatewayARN(String gatewayARN) {
this.gatewayARN = gatewayARN;
return this;
}
public final void setGatewayARN(String gatewayARN) {
this.gatewayARN = gatewayARN;
}
public final Long getTapeSizeInBytes() {
return tapeSizeInBytes;
}
@Override
public final Builder tapeSizeInBytes(Long tapeSizeInBytes) {
this.tapeSizeInBytes = tapeSizeInBytes;
return this;
}
public final void setTapeSizeInBytes(Long tapeSizeInBytes) {
this.tapeSizeInBytes = tapeSizeInBytes;
}
public final String getTapeBarcode() {
return tapeBarcode;
}
@Override
public final Builder tapeBarcode(String tapeBarcode) {
this.tapeBarcode = tapeBarcode;
return this;
}
public final void setTapeBarcode(String tapeBarcode) {
this.tapeBarcode = tapeBarcode;
}
public final Boolean getKmsEncrypted() {
return kmsEncrypted;
}
@Override
public final Builder kmsEncrypted(Boolean kmsEncrypted) {
this.kmsEncrypted = kmsEncrypted;
return this;
}
public final void setKmsEncrypted(Boolean kmsEncrypted) {
this.kmsEncrypted = kmsEncrypted;
}
public final String getKmsKey() {
return kmsKey;
}
@Override
public final Builder kmsKey(String kmsKey) {
this.kmsKey = kmsKey;
return this;
}
public final void setKmsKey(String kmsKey) {
this.kmsKey = kmsKey;
}
public final String getPoolId() {
return poolId;
}
@Override
public final Builder poolId(String poolId) {
this.poolId = poolId;
return this;
}
public final void setPoolId(String poolId) {
this.poolId = poolId;
}
public final Collection getTags() {
return tags != null ? tags.stream().map(Tag::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setTags(Collection tags) {
this.tags = TagsCopier.copyFromBuilder(tags);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateTapeWithBarcodeRequest build() {
return new CreateTapeWithBarcodeRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}