software.amazon.awssdk.services.elasticache.model.PurchaseReservedCacheNodesOfferingRequest Maven / Gradle / Ivy
Show all versions of elasticache 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.elasticache.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.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents the input of a PurchaseReservedCacheNodesOffering operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PurchaseReservedCacheNodesOfferingRequest extends ElastiCacheRequest implements
ToCopyableBuilder {
private static final SdkField RESERVED_CACHE_NODES_OFFERING_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ReservedCacheNodesOfferingId")
.getter(getter(PurchaseReservedCacheNodesOfferingRequest::reservedCacheNodesOfferingId))
.setter(setter(Builder::reservedCacheNodesOfferingId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReservedCacheNodesOfferingId")
.build()).build();
private static final SdkField RESERVED_CACHE_NODE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReservedCacheNodeId").getter(getter(PurchaseReservedCacheNodesOfferingRequest::reservedCacheNodeId))
.setter(setter(Builder::reservedCacheNodeId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReservedCacheNodeId").build())
.build();
private static final SdkField CACHE_NODE_COUNT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("CacheNodeCount").getter(getter(PurchaseReservedCacheNodesOfferingRequest::cacheNodeCount))
.setter(setter(Builder::cacheNodeCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CacheNodeCount").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(PurchaseReservedCacheNodesOfferingRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName("Tag")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Tag").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
RESERVED_CACHE_NODES_OFFERING_ID_FIELD, RESERVED_CACHE_NODE_ID_FIELD, CACHE_NODE_COUNT_FIELD, TAGS_FIELD));
private final String reservedCacheNodesOfferingId;
private final String reservedCacheNodeId;
private final Integer cacheNodeCount;
private final List tags;
private PurchaseReservedCacheNodesOfferingRequest(BuilderImpl builder) {
super(builder);
this.reservedCacheNodesOfferingId = builder.reservedCacheNodesOfferingId;
this.reservedCacheNodeId = builder.reservedCacheNodeId;
this.cacheNodeCount = builder.cacheNodeCount;
this.tags = builder.tags;
}
/**
*
* The ID of the reserved cache node offering to purchase.
*
*
* Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
*
*
* @return The ID of the reserved cache node offering to purchase.
*
* Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
*/
public final String reservedCacheNodesOfferingId() {
return reservedCacheNodesOfferingId;
}
/**
*
* A customer-specified identifier to track this reservation.
*
*
*
* The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this
* parameter is not specified, ElastiCache automatically generates an identifier for the reservation.
*
*
*
* Example: myreservationID
*
*
* @return A customer-specified identifier to track this reservation.
*
* The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this
* parameter is not specified, ElastiCache automatically generates an identifier for the reservation.
*
*
*
* Example: myreservationID
*/
public final String reservedCacheNodeId() {
return reservedCacheNodeId;
}
/**
*
* The number of cache node instances to reserve.
*
*
* Default: 1
*
*
* @return The number of cache node instances to reserve.
*
* Default: 1
*/
public final Integer cacheNodeCount() {
return cacheNodeCount;
}
/**
* 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 tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag
* value, although null is accepted.
*
*
* 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 tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by
* a tag value, although null is accepted.
*/
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(reservedCacheNodesOfferingId());
hashCode = 31 * hashCode + Objects.hashCode(reservedCacheNodeId());
hashCode = 31 * hashCode + Objects.hashCode(cacheNodeCount());
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 PurchaseReservedCacheNodesOfferingRequest)) {
return false;
}
PurchaseReservedCacheNodesOfferingRequest other = (PurchaseReservedCacheNodesOfferingRequest) obj;
return Objects.equals(reservedCacheNodesOfferingId(), other.reservedCacheNodesOfferingId())
&& Objects.equals(reservedCacheNodeId(), other.reservedCacheNodeId())
&& Objects.equals(cacheNodeCount(), other.cacheNodeCount()) && 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("PurchaseReservedCacheNodesOfferingRequest")
.add("ReservedCacheNodesOfferingId", reservedCacheNodesOfferingId())
.add("ReservedCacheNodeId", reservedCacheNodeId()).add("CacheNodeCount", cacheNodeCount())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ReservedCacheNodesOfferingId":
return Optional.ofNullable(clazz.cast(reservedCacheNodesOfferingId()));
case "ReservedCacheNodeId":
return Optional.ofNullable(clazz.cast(reservedCacheNodeId()));
case "CacheNodeCount":
return Optional.ofNullable(clazz.cast(cacheNodeCount()));
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((PurchaseReservedCacheNodesOfferingRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ElastiCacheRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The ID of the reserved cache node offering to purchase.
*
*
* Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
*
*
* @param reservedCacheNodesOfferingId
* The ID of the reserved cache node offering to purchase.
*
* Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reservedCacheNodesOfferingId(String reservedCacheNodesOfferingId);
/**
*
* A customer-specified identifier to track this reservation.
*
*
*
* The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this
* parameter is not specified, ElastiCache automatically generates an identifier for the reservation.
*
*
*
* Example: myreservationID
*
*
* @param reservedCacheNodeId
* A customer-specified identifier to track this reservation.
*
* The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If
* this parameter is not specified, ElastiCache automatically generates an identifier for the
* reservation.
*
*
*
* Example: myreservationID
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reservedCacheNodeId(String reservedCacheNodeId);
/**
*
* The number of cache node instances to reserve.
*
*
* Default: 1
*
*
* @param cacheNodeCount
* The number of cache node instances to reserve.
*
* Default: 1
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cacheNodeCount(Integer cacheNodeCount);
/**
*
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a
* tag value, although null is accepted.
*
*
* @param tags
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied
* by a tag value, although null is accepted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a
* tag value, although null is accepted.
*
*
* @param tags
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied
* by a tag value, although null is accepted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a
* tag value, although null is accepted.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.elasticache.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.elasticache.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.elasticache.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.elasticache.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);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ElastiCacheRequest.BuilderImpl implements Builder {
private String reservedCacheNodesOfferingId;
private String reservedCacheNodeId;
private Integer cacheNodeCount;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(PurchaseReservedCacheNodesOfferingRequest model) {
super(model);
reservedCacheNodesOfferingId(model.reservedCacheNodesOfferingId);
reservedCacheNodeId(model.reservedCacheNodeId);
cacheNodeCount(model.cacheNodeCount);
tags(model.tags);
}
public final String getReservedCacheNodesOfferingId() {
return reservedCacheNodesOfferingId;
}
public final void setReservedCacheNodesOfferingId(String reservedCacheNodesOfferingId) {
this.reservedCacheNodesOfferingId = reservedCacheNodesOfferingId;
}
@Override
public final Builder reservedCacheNodesOfferingId(String reservedCacheNodesOfferingId) {
this.reservedCacheNodesOfferingId = reservedCacheNodesOfferingId;
return this;
}
public final String getReservedCacheNodeId() {
return reservedCacheNodeId;
}
public final void setReservedCacheNodeId(String reservedCacheNodeId) {
this.reservedCacheNodeId = reservedCacheNodeId;
}
@Override
public final Builder reservedCacheNodeId(String reservedCacheNodeId) {
this.reservedCacheNodeId = reservedCacheNodeId;
return this;
}
public final Integer getCacheNodeCount() {
return cacheNodeCount;
}
public final void setCacheNodeCount(Integer cacheNodeCount) {
this.cacheNodeCount = cacheNodeCount;
}
@Override
public final Builder cacheNodeCount(Integer cacheNodeCount) {
this.cacheNodeCount = cacheNodeCount;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PurchaseReservedCacheNodesOfferingRequest build() {
return new PurchaseReservedCacheNodesOfferingRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}