software.amazon.awssdk.services.cloudformation.model.ParameterConstraints Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudformation Show documentation
Show all versions of cloudformation Show documentation
The AWS Java SDK for AWS CloudFormation module holds the client classes that are used for communicating
with AWS CloudFormation Service
/*
* 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.cloudformation.model;
import java.io.Serializable;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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;
/**
*
* A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be defined
* in the stack template, CloudFormation returns only the AllowedValues property.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ParameterConstraints implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> ALLOWED_VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AllowedValues")
.getter(getter(ParameterConstraints::allowedValues))
.setter(setter(Builder::allowedValues))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AllowedValues").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ALLOWED_VALUES_FIELD));
private static final long serialVersionUID = 1L;
private final List allowedValues;
private ParameterConstraints(BuilderImpl builder) {
this.allowedValues = builder.allowedValues;
}
/**
* For responses, this returns true if the service returned a value for the AllowedValues 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 hasAllowedValues() {
return allowedValues != null && !(allowedValues instanceof SdkAutoConstructList);
}
/**
*
* A list of values that are permitted for a parameter.
*
*
* 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 #hasAllowedValues} method.
*
*
* @return A list of values that are permitted for a parameter.
*/
public final List allowedValues() {
return allowedValues;
}
@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 + Objects.hashCode(hasAllowedValues() ? allowedValues() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ParameterConstraints)) {
return false;
}
ParameterConstraints other = (ParameterConstraints) obj;
return hasAllowedValues() == other.hasAllowedValues() && Objects.equals(allowedValues(), other.allowedValues());
}
/**
* 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("ParameterConstraints").add("AllowedValues", hasAllowedValues() ? allowedValues() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AllowedValues":
return Optional.ofNullable(clazz.cast(allowedValues()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ParameterConstraints) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A list of values that are permitted for a parameter.
*
*
* @param allowedValues
* A list of values that are permitted for a parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedValues(Collection allowedValues);
/**
*
* A list of values that are permitted for a parameter.
*
*
* @param allowedValues
* A list of values that are permitted for a parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowedValues(String... allowedValues);
}
static final class BuilderImpl implements Builder {
private List allowedValues = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ParameterConstraints model) {
allowedValues(model.allowedValues);
}
public final Collection getAllowedValues() {
if (allowedValues instanceof SdkAutoConstructList) {
return null;
}
return allowedValues;
}
public final void setAllowedValues(Collection allowedValues) {
this.allowedValues = AllowedValuesCopier.copy(allowedValues);
}
@Override
public final Builder allowedValues(Collection allowedValues) {
this.allowedValues = AllowedValuesCopier.copy(allowedValues);
return this;
}
@Override
@SafeVarargs
public final Builder allowedValues(String... allowedValues) {
allowedValues(Arrays.asList(allowedValues));
return this;
}
@Override
public ParameterConstraints build() {
return new ParameterConstraints(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}