software.amazon.awssdk.services.fsx.model.CreateVolumeRequest Maven / Gradle / Ivy
Show all versions of fsx 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.fsx.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.DefaultValueTrait;
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 CreateVolumeRequest extends FSxRequest implements
ToCopyableBuilder {
private static final SdkField CLIENT_REQUEST_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ClientRequestToken")
.getter(getter(CreateVolumeRequest::clientRequestToken))
.setter(setter(Builder::clientRequestToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientRequestToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField VOLUME_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("VolumeType").getter(getter(CreateVolumeRequest::volumeTypeAsString)).setter(setter(Builder::volumeType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VolumeType").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateVolumeRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField ONTAP_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("OntapConfiguration")
.getter(getter(CreateVolumeRequest::ontapConfiguration)).setter(setter(Builder::ontapConfiguration))
.constructor(CreateOntapVolumeConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OntapConfiguration").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateVolumeRequest::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 SdkField OPEN_ZFS_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("OpenZFSConfiguration")
.getter(getter(CreateVolumeRequest::openZFSConfiguration)).setter(setter(Builder::openZFSConfiguration))
.constructor(CreateOpenZFSVolumeConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OpenZFSConfiguration").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_REQUEST_TOKEN_FIELD,
VOLUME_TYPE_FIELD, NAME_FIELD, ONTAP_CONFIGURATION_FIELD, TAGS_FIELD, OPEN_ZFS_CONFIGURATION_FIELD));
private final String clientRequestToken;
private final String volumeType;
private final String name;
private final CreateOntapVolumeConfiguration ontapConfiguration;
private final List tags;
private final CreateOpenZFSVolumeConfiguration openZFSConfiguration;
private CreateVolumeRequest(BuilderImpl builder) {
super(builder);
this.clientRequestToken = builder.clientRequestToken;
this.volumeType = builder.volumeType;
this.name = builder.name;
this.ontapConfiguration = builder.ontapConfiguration;
this.tags = builder.tags;
this.openZFSConfiguration = builder.openZFSConfiguration;
}
/**
* Returns the value of the ClientRequestToken property for this object.
*
* @return The value of the ClientRequestToken property for this object.
*/
public final String clientRequestToken() {
return clientRequestToken;
}
/**
*
* Specifies the type of volume to create; ONTAP and OPENZFS are the only valid volume
* types.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #volumeType} will
* return {@link VolumeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #volumeTypeAsString}.
*
*
* @return Specifies the type of volume to create; ONTAP and OPENZFS are the only valid
* volume types.
* @see VolumeType
*/
public final VolumeType volumeType() {
return VolumeType.fromValue(volumeType);
}
/**
*
* Specifies the type of volume to create; ONTAP and OPENZFS are the only valid volume
* types.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #volumeType} will
* return {@link VolumeType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #volumeTypeAsString}.
*
*
* @return Specifies the type of volume to create; ONTAP and OPENZFS are the only valid
* volume types.
* @see VolumeType
*/
public final String volumeTypeAsString() {
return volumeType;
}
/**
*
* Specifies the name of the volume that you're creating.
*
*
* @return Specifies the name of the volume that you're creating.
*/
public final String name() {
return name;
}
/**
*
* Specifies the configuration to use when creating the ONTAP volume.
*
*
* @return Specifies the configuration to use when creating the ONTAP volume.
*/
public final CreateOntapVolumeConfiguration ontapConfiguration() {
return ontapConfiguration;
}
/**
* 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);
}
/**
* Returns the value of the Tags property for this object.
*
* 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 The value of the Tags property for this object.
*/
public final List tags() {
return tags;
}
/**
*
* Specifies the configuration to use when creating the OpenZFS volume.
*
*
* @return Specifies the configuration to use when creating the OpenZFS volume.
*/
public final CreateOpenZFSVolumeConfiguration openZFSConfiguration() {
return openZFSConfiguration;
}
@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(clientRequestToken());
hashCode = 31 * hashCode + Objects.hashCode(volumeTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(ontapConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(openZFSConfiguration());
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 CreateVolumeRequest)) {
return false;
}
CreateVolumeRequest other = (CreateVolumeRequest) obj;
return Objects.equals(clientRequestToken(), other.clientRequestToken())
&& Objects.equals(volumeTypeAsString(), other.volumeTypeAsString()) && Objects.equals(name(), other.name())
&& Objects.equals(ontapConfiguration(), other.ontapConfiguration()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(openZFSConfiguration(), other.openZFSConfiguration());
}
/**
* 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("CreateVolumeRequest").add("ClientRequestToken", clientRequestToken())
.add("VolumeType", volumeTypeAsString()).add("Name", name()).add("OntapConfiguration", ontapConfiguration())
.add("Tags", hasTags() ? tags() : null).add("OpenZFSConfiguration", openZFSConfiguration()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ClientRequestToken":
return Optional.ofNullable(clazz.cast(clientRequestToken()));
case "VolumeType":
return Optional.ofNullable(clazz.cast(volumeTypeAsString()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "OntapConfiguration":
return Optional.ofNullable(clazz.cast(ontapConfiguration()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "OpenZFSConfiguration":
return Optional.ofNullable(clazz.cast(openZFSConfiguration()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateVolumeRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends FSxRequest.Builder, SdkPojo, CopyableBuilder {
/**
* Sets the value of the ClientRequestToken property for this object.
*
* @param clientRequestToken
* The new value for the ClientRequestToken property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientRequestToken(String clientRequestToken);
/**
*
* Specifies the type of volume to create; ONTAP and OPENZFS are the only valid volume
* types.
*
*
* @param volumeType
* Specifies the type of volume to create; ONTAP and OPENZFS are the only valid
* volume types.
* @see VolumeType
* @return Returns a reference to this object so that method calls can be chained together.
* @see VolumeType
*/
Builder volumeType(String volumeType);
/**
*
* Specifies the type of volume to create; ONTAP and OPENZFS are the only valid volume
* types.
*
*
* @param volumeType
* Specifies the type of volume to create; ONTAP and OPENZFS are the only valid
* volume types.
* @see VolumeType
* @return Returns a reference to this object so that method calls can be chained together.
* @see VolumeType
*/
Builder volumeType(VolumeType volumeType);
/**
*
* Specifies the name of the volume that you're creating.
*
*
* @param name
* Specifies the name of the volume that you're creating.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* Specifies the configuration to use when creating the ONTAP volume.
*
*
* @param ontapConfiguration
* Specifies the configuration to use when creating the ONTAP volume.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ontapConfiguration(CreateOntapVolumeConfiguration ontapConfiguration);
/**
*
* Specifies the configuration to use when creating the ONTAP volume.
*
* This is a convenience method that creates an instance of the {@link CreateOntapVolumeConfiguration.Builder}
* avoiding the need to create one manually via {@link CreateOntapVolumeConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link CreateOntapVolumeConfiguration.Builder#build()} is called
* immediately and its result is passed to {@link #ontapConfiguration(CreateOntapVolumeConfiguration)}.
*
* @param ontapConfiguration
* a consumer that will call methods on {@link CreateOntapVolumeConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #ontapConfiguration(CreateOntapVolumeConfiguration)
*/
default Builder ontapConfiguration(Consumer ontapConfiguration) {
return ontapConfiguration(CreateOntapVolumeConfiguration.builder().applyMutation(ontapConfiguration).build());
}
/**
* Sets the value of the Tags property for this object.
*
* @param tags
* The new value for the Tags property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
* Sets the value of the Tags property for this object.
*
* @param tags
* The new value for the Tags property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
* Sets the value of the Tags property for this object.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.fsx.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.fsx.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.fsx.model.Tag.Builder#build()} is
* called immediately and its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link software.amazon.awssdk.services.fsx.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
/**
*
* Specifies the configuration to use when creating the OpenZFS volume.
*
*
* @param openZFSConfiguration
* Specifies the configuration to use when creating the OpenZFS volume.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder openZFSConfiguration(CreateOpenZFSVolumeConfiguration openZFSConfiguration);
/**
*
* Specifies the configuration to use when creating the OpenZFS volume.
*
* This is a convenience method that creates an instance of the {@link CreateOpenZFSVolumeConfiguration.Builder}
* avoiding the need to create one manually via {@link CreateOpenZFSVolumeConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link CreateOpenZFSVolumeConfiguration.Builder#build()} is called
* immediately and its result is passed to {@link #openZFSConfiguration(CreateOpenZFSVolumeConfiguration)}.
*
* @param openZFSConfiguration
* a consumer that will call methods on {@link CreateOpenZFSVolumeConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #openZFSConfiguration(CreateOpenZFSVolumeConfiguration)
*/
default Builder openZFSConfiguration(Consumer openZFSConfiguration) {
return openZFSConfiguration(CreateOpenZFSVolumeConfiguration.builder().applyMutation(openZFSConfiguration).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends FSxRequest.BuilderImpl implements Builder {
private String clientRequestToken;
private String volumeType;
private String name;
private CreateOntapVolumeConfiguration ontapConfiguration;
private List tags = DefaultSdkAutoConstructList.getInstance();
private CreateOpenZFSVolumeConfiguration openZFSConfiguration;
private BuilderImpl() {
}
private BuilderImpl(CreateVolumeRequest model) {
super(model);
clientRequestToken(model.clientRequestToken);
volumeType(model.volumeType);
name(model.name);
ontapConfiguration(model.ontapConfiguration);
tags(model.tags);
openZFSConfiguration(model.openZFSConfiguration);
}
public final String getClientRequestToken() {
return clientRequestToken;
}
public final void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
@Override
public final Builder clientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
return this;
}
public final String getVolumeType() {
return volumeType;
}
public final void setVolumeType(String volumeType) {
this.volumeType = volumeType;
}
@Override
public final Builder volumeType(String volumeType) {
this.volumeType = volumeType;
return this;
}
@Override
public final Builder volumeType(VolumeType volumeType) {
this.volumeType(volumeType == null ? null : volumeType.toString());
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final CreateOntapVolumeConfiguration.Builder getOntapConfiguration() {
return ontapConfiguration != null ? ontapConfiguration.toBuilder() : null;
}
public final void setOntapConfiguration(CreateOntapVolumeConfiguration.BuilderImpl ontapConfiguration) {
this.ontapConfiguration = ontapConfiguration != null ? ontapConfiguration.build() : null;
}
@Override
public final Builder ontapConfiguration(CreateOntapVolumeConfiguration ontapConfiguration) {
this.ontapConfiguration = ontapConfiguration;
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
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 CreateOpenZFSVolumeConfiguration.Builder getOpenZFSConfiguration() {
return openZFSConfiguration != null ? openZFSConfiguration.toBuilder() : null;
}
public final void setOpenZFSConfiguration(CreateOpenZFSVolumeConfiguration.BuilderImpl openZFSConfiguration) {
this.openZFSConfiguration = openZFSConfiguration != null ? openZFSConfiguration.build() : null;
}
@Override
public final Builder openZFSConfiguration(CreateOpenZFSVolumeConfiguration openZFSConfiguration) {
this.openZFSConfiguration = openZFSConfiguration;
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 CreateVolumeRequest build() {
return new CreateVolumeRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}