software.amazon.awssdk.services.cloudformation.model.ParameterDeclaration 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 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.cloudformation.model;
import java.io.Serializable;
import java.util.Arrays;
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 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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The ParameterDeclaration data type.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ParameterDeclaration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField PARAMETER_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(ParameterDeclaration::parameterKey)).setter(setter(Builder::parameterKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParameterKey").build()).build();
private static final SdkField DEFAULT_VALUE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(ParameterDeclaration::defaultValue)).setter(setter(Builder::defaultValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultValue").build()).build();
private static final SdkField PARAMETER_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(ParameterDeclaration::parameterType)).setter(setter(Builder::parameterType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParameterType").build()).build();
private static final SdkField NO_ECHO_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.getter(getter(ParameterDeclaration::noEcho)).setter(setter(Builder::noEcho))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NoEcho").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(ParameterDeclaration::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField PARAMETER_CONSTRAINTS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).getter(getter(ParameterDeclaration::parameterConstraints))
.setter(setter(Builder::parameterConstraints)).constructor(ParameterConstraints::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParameterConstraints").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PARAMETER_KEY_FIELD,
DEFAULT_VALUE_FIELD, PARAMETER_TYPE_FIELD, NO_ECHO_FIELD, DESCRIPTION_FIELD, PARAMETER_CONSTRAINTS_FIELD));
private static final long serialVersionUID = 1L;
private final String parameterKey;
private final String defaultValue;
private final String parameterType;
private final Boolean noEcho;
private final String description;
private final ParameterConstraints parameterConstraints;
private ParameterDeclaration(BuilderImpl builder) {
this.parameterKey = builder.parameterKey;
this.defaultValue = builder.defaultValue;
this.parameterType = builder.parameterType;
this.noEcho = builder.noEcho;
this.description = builder.description;
this.parameterConstraints = builder.parameterConstraints;
}
/**
*
* The name that is associated with the parameter.
*
*
* @return The name that is associated with the parameter.
*/
public String parameterKey() {
return parameterKey;
}
/**
*
* The default value of the parameter.
*
*
* @return The default value of the parameter.
*/
public String defaultValue() {
return defaultValue;
}
/**
*
* The type of parameter.
*
*
* @return The type of parameter.
*/
public String parameterType() {
return parameterType;
}
/**
*
* Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
*
*
* @return Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management
* Console.
*/
public Boolean noEcho() {
return noEcho;
}
/**
*
* The description that is associate with the parameter.
*
*
* @return The description that is associate with the parameter.
*/
public String description() {
return description;
}
/**
*
* The criteria that AWS CloudFormation uses to validate parameter values.
*
*
* @return The criteria that AWS CloudFormation uses to validate parameter values.
*/
public ParameterConstraints parameterConstraints() {
return parameterConstraints;
}
@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 + Objects.hashCode(parameterKey());
hashCode = 31 * hashCode + Objects.hashCode(defaultValue());
hashCode = 31 * hashCode + Objects.hashCode(parameterType());
hashCode = 31 * hashCode + Objects.hashCode(noEcho());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(parameterConstraints());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ParameterDeclaration)) {
return false;
}
ParameterDeclaration other = (ParameterDeclaration) obj;
return Objects.equals(parameterKey(), other.parameterKey()) && Objects.equals(defaultValue(), other.defaultValue())
&& Objects.equals(parameterType(), other.parameterType()) && Objects.equals(noEcho(), other.noEcho())
&& Objects.equals(description(), other.description())
&& Objects.equals(parameterConstraints(), other.parameterConstraints());
}
/**
* 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("ParameterDeclaration").add("ParameterKey", parameterKey()).add("DefaultValue", defaultValue())
.add("ParameterType", parameterType()).add("NoEcho", noEcho()).add("Description", description())
.add("ParameterConstraints", parameterConstraints()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ParameterKey":
return Optional.ofNullable(clazz.cast(parameterKey()));
case "DefaultValue":
return Optional.ofNullable(clazz.cast(defaultValue()));
case "ParameterType":
return Optional.ofNullable(clazz.cast(parameterType()));
case "NoEcho":
return Optional.ofNullable(clazz.cast(noEcho()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "ParameterConstraints":
return Optional.ofNullable(clazz.cast(parameterConstraints()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ParameterDeclaration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name that is associated with the parameter.
*
*
* @param parameterKey
* The name that is associated with the parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameterKey(String parameterKey);
/**
*
* The default value of the parameter.
*
*
* @param defaultValue
* The default value of the parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultValue(String defaultValue);
/**
*
* The type of parameter.
*
*
* @param parameterType
* The type of parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameterType(String parameterType);
/**
*
* Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management
* Console.
*
*
* @param noEcho
* Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS
* Management Console.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder noEcho(Boolean noEcho);
/**
*
* The description that is associate with the parameter.
*
*
* @param description
* The description that is associate with the parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The criteria that AWS CloudFormation uses to validate parameter values.
*
*
* @param parameterConstraints
* The criteria that AWS CloudFormation uses to validate parameter values.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameterConstraints(ParameterConstraints parameterConstraints);
/**
*
* The criteria that AWS CloudFormation uses to validate parameter values.
*
* This is a convenience that creates an instance of the {@link ParameterConstraints.Builder} avoiding the need
* to create one manually via {@link ParameterConstraints#builder()}.
*
* When the {@link Consumer} completes, {@link ParameterConstraints.Builder#build()} is called immediately and
* its result is passed to {@link #parameterConstraints(ParameterConstraints)}.
*
* @param parameterConstraints
* a consumer that will call methods on {@link ParameterConstraints.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #parameterConstraints(ParameterConstraints)
*/
default Builder parameterConstraints(Consumer parameterConstraints) {
return parameterConstraints(ParameterConstraints.builder().applyMutation(parameterConstraints).build());
}
}
static final class BuilderImpl implements Builder {
private String parameterKey;
private String defaultValue;
private String parameterType;
private Boolean noEcho;
private String description;
private ParameterConstraints parameterConstraints;
private BuilderImpl() {
}
private BuilderImpl(ParameterDeclaration model) {
parameterKey(model.parameterKey);
defaultValue(model.defaultValue);
parameterType(model.parameterType);
noEcho(model.noEcho);
description(model.description);
parameterConstraints(model.parameterConstraints);
}
public final String getParameterKey() {
return parameterKey;
}
@Override
public final Builder parameterKey(String parameterKey) {
this.parameterKey = parameterKey;
return this;
}
public final void setParameterKey(String parameterKey) {
this.parameterKey = parameterKey;
}
public final String getDefaultValue() {
return defaultValue;
}
@Override
public final Builder defaultValue(String defaultValue) {
this.defaultValue = defaultValue;
return this;
}
public final void setDefaultValue(String defaultValue) {
this.defaultValue = defaultValue;
}
public final String getParameterType() {
return parameterType;
}
@Override
public final Builder parameterType(String parameterType) {
this.parameterType = parameterType;
return this;
}
public final void setParameterType(String parameterType) {
this.parameterType = parameterType;
}
public final Boolean getNoEcho() {
return noEcho;
}
@Override
public final Builder noEcho(Boolean noEcho) {
this.noEcho = noEcho;
return this;
}
public final void setNoEcho(Boolean noEcho) {
this.noEcho = noEcho;
}
public final String getDescription() {
return description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final void setDescription(String description) {
this.description = description;
}
public final ParameterConstraints.Builder getParameterConstraints() {
return parameterConstraints != null ? parameterConstraints.toBuilder() : null;
}
@Override
public final Builder parameterConstraints(ParameterConstraints parameterConstraints) {
this.parameterConstraints = parameterConstraints;
return this;
}
public final void setParameterConstraints(ParameterConstraints.BuilderImpl parameterConstraints) {
this.parameterConstraints = parameterConstraints != null ? parameterConstraints.build() : null;
}
@Override
public ParameterDeclaration build() {
return new ParameterDeclaration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy