software.amazon.awssdk.services.storagegateway.model.CreateSnapshotFromVolumeRecoveryPointRequest Maven / Gradle / Ivy
/*
* 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.storagegateway.model;
import java.beans.Transient;
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.core.util.SdkAutoConstructList;
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 CreateSnapshotFromVolumeRecoveryPointRequest extends StorageGatewayRequest implements
ToCopyableBuilder {
private static final SdkField VOLUME_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("VolumeARN").getter(getter(CreateSnapshotFromVolumeRecoveryPointRequest::volumeARN))
.setter(setter(Builder::volumeARN))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VolumeARN").build()).build();
private static final SdkField SNAPSHOT_DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SnapshotDescription").getter(getter(CreateSnapshotFromVolumeRecoveryPointRequest::snapshotDescription))
.setter(setter(Builder::snapshotDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SnapshotDescription").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateSnapshotFromVolumeRecoveryPointRequest::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(VOLUME_ARN_FIELD,
SNAPSHOT_DESCRIPTION_FIELD, TAGS_FIELD));
private final String volumeARN;
private final String snapshotDescription;
private final List tags;
private CreateSnapshotFromVolumeRecoveryPointRequest(BuilderImpl builder) {
super(builder);
this.volumeARN = builder.volumeARN;
this.snapshotDescription = builder.snapshotDescription;
this.tags = builder.tags;
}
/**
*
* The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to
* return to retrieve the TargetARN for specified VolumeARN.
*
*
* @return The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes
* operation to return to retrieve the TargetARN for specified VolumeARN.
*/
public final String volumeARN() {
return volumeARN;
}
/**
*
* Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel
* in the Description field, and in the Storage Gateway snapshot Details pane, Description
* field.
*
*
* @return Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots
* panel in the Description field, and in the Storage Gateway snapshot Details pane,
* Description field.
*/
public final String snapshotDescription() {
return snapshotDescription;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of up to 50 tags that can be assigned to a snapshot. 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.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return A list of up to 50 tags that can be assigned to a snapshot. 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 final 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 final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(volumeARN());
hashCode = 31 * hashCode + Objects.hashCode(snapshotDescription());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 CreateSnapshotFromVolumeRecoveryPointRequest)) {
return false;
}
CreateSnapshotFromVolumeRecoveryPointRequest other = (CreateSnapshotFromVolumeRecoveryPointRequest) obj;
return Objects.equals(volumeARN(), other.volumeARN())
&& Objects.equals(snapshotDescription(), other.snapshotDescription()) && hasTags() == other.hasTags()
&& 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 final String toString() {
return ToString.builder("CreateSnapshotFromVolumeRecoveryPointRequest").add("VolumeARN", volumeARN())
.add("SnapshotDescription", snapshotDescription()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "VolumeARN":
return Optional.ofNullable(clazz.cast(volumeARN()));
case "SnapshotDescription":
return Optional.ofNullable(clazz.cast(snapshotDescription()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateSnapshotFromVolumeRecoveryPointRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends StorageGatewayRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes
* operation to return to retrieve the TargetARN for specified VolumeARN.
*
*
* @param volumeARN
* The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes
* operation to return to retrieve the TargetARN for specified VolumeARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder volumeARN(String volumeARN);
/**
*
* Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots
* panel in the Description field, and in the Storage Gateway snapshot Details pane,
* Description field.
*
*
* @param snapshotDescription
* Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store
* snapshots panel in the Description field, and in the Storage Gateway snapshot Details
* pane, Description field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshotDescription(String snapshotDescription);
/**
*
* A list of up to 50 tags that can be assigned to a snapshot. 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 snapshot. 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 snapshot. 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 snapshot. 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 snapshot. 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 volumeARN;
private String snapshotDescription;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateSnapshotFromVolumeRecoveryPointRequest model) {
super(model);
volumeARN(model.volumeARN);
snapshotDescription(model.snapshotDescription);
tags(model.tags);
}
public final String getVolumeARN() {
return volumeARN;
}
public final void setVolumeARN(String volumeARN) {
this.volumeARN = volumeARN;
}
@Override
@Transient
public final Builder volumeARN(String volumeARN) {
this.volumeARN = volumeARN;
return this;
}
public final String getSnapshotDescription() {
return snapshotDescription;
}
public final void setSnapshotDescription(String snapshotDescription) {
this.snapshotDescription = snapshotDescription;
}
@Override
@Transient
public final Builder snapshotDescription(String snapshotDescription) {
this.snapshotDescription = snapshotDescription;
return this;
}
public final List getTags() {
List result = TagsCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagsCopier.copyFromBuilder(tags);
}
@Override
@Transient
public final Builder tags(Collection tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
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 CreateSnapshotFromVolumeRecoveryPointRequest build() {
return new CreateSnapshotFromVolumeRecoveryPointRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}