software.amazon.awssdk.services.cloudformation.model.ResourceTargetDefinition Maven / Gradle / Ivy
Show all versions of cloudformation 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.cloudformation.model;
import java.beans.Transient;
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.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 field that CloudFormation will change, such as the name of a resource's property, and whether the resource will
* be recreated.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ResourceTargetDefinition implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ATTRIBUTE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Attribute").getter(getter(ResourceTargetDefinition::attributeAsString))
.setter(setter(Builder::attribute))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Attribute").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(ResourceTargetDefinition::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField REQUIRES_RECREATION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RequiresRecreation").getter(getter(ResourceTargetDefinition::requiresRecreationAsString))
.setter(setter(Builder::requiresRecreation))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RequiresRecreation").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ATTRIBUTE_FIELD, NAME_FIELD,
REQUIRES_RECREATION_FIELD));
private static final long serialVersionUID = 1L;
private final String attribute;
private final String name;
private final String requiresRecreation;
private ResourceTargetDefinition(BuilderImpl builder) {
this.attribute = builder.attribute;
this.name = builder.name;
this.requiresRecreation = builder.requiresRecreation;
}
/**
*
* Indicates which resource attribute is triggering this update, such as a change in the resource attribute's
* Metadata, Properties, or Tags.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #attribute} will
* return {@link ResourceAttribute#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #attributeAsString}.
*
*
* @return Indicates which resource attribute is triggering this update, such as a change in the resource
* attribute's Metadata, Properties, or Tags.
* @see ResourceAttribute
*/
public final ResourceAttribute attribute() {
return ResourceAttribute.fromValue(attribute);
}
/**
*
* Indicates which resource attribute is triggering this update, such as a change in the resource attribute's
* Metadata, Properties, or Tags.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #attribute} will
* return {@link ResourceAttribute#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #attributeAsString}.
*
*
* @return Indicates which resource attribute is triggering this update, such as a change in the resource
* attribute's Metadata, Properties, or Tags.
* @see ResourceAttribute
*/
public final String attributeAsString() {
return attribute;
}
/**
*
* If the Attribute value is Properties, the name of the property. For all other
* attributes, the value is null.
*
*
* @return If the Attribute value is Properties, the name of the property. For all other
* attributes, the value is null.
*/
public final String name() {
return name;
}
/**
*
* If the Attribute value is Properties, indicates whether a change to this property
* causes the resource to be recreated. The value can be Never, Always, or
* Conditionally. To determine the conditions for a Conditionally recreation, see the
* update behavior for that property in the CloudFormation User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #requiresRecreation} will return {@link RequiresRecreation#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #requiresRecreationAsString}.
*
*
* @return If the Attribute value is Properties, indicates whether a change to this
* property causes the resource to be recreated. The value can be Never, Always,
* or Conditionally. To determine the conditions for a Conditionally recreation,
* see the update behavior for that property in the CloudFormation User Guide.
* @see RequiresRecreation
*/
public final RequiresRecreation requiresRecreation() {
return RequiresRecreation.fromValue(requiresRecreation);
}
/**
*
* If the Attribute value is Properties, indicates whether a change to this property
* causes the resource to be recreated. The value can be Never, Always, or
* Conditionally. To determine the conditions for a Conditionally recreation, see the
* update behavior for that property in the CloudFormation User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #requiresRecreation} will return {@link RequiresRecreation#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #requiresRecreationAsString}.
*
*
* @return If the Attribute value is Properties, indicates whether a change to this
* property causes the resource to be recreated. The value can be Never, Always,
* or Conditionally. To determine the conditions for a Conditionally recreation,
* see the update behavior for that property in the CloudFormation User Guide.
* @see RequiresRecreation
*/
public final String requiresRecreationAsString() {
return requiresRecreation;
}
@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(attributeAsString());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(requiresRecreationAsString());
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 ResourceTargetDefinition)) {
return false;
}
ResourceTargetDefinition other = (ResourceTargetDefinition) obj;
return Objects.equals(attributeAsString(), other.attributeAsString()) && Objects.equals(name(), other.name())
&& Objects.equals(requiresRecreationAsString(), other.requiresRecreationAsString());
}
/**
* 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("ResourceTargetDefinition").add("Attribute", attributeAsString()).add("Name", name())
.add("RequiresRecreation", requiresRecreationAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Attribute":
return Optional.ofNullable(clazz.cast(attributeAsString()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "RequiresRecreation":
return Optional.ofNullable(clazz.cast(requiresRecreationAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ResourceTargetDefinition) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Indicates which resource attribute is triggering this update, such as a change in the resource attribute's
* Metadata, Properties, or Tags.
*
*
* @param attribute
* Indicates which resource attribute is triggering this update, such as a change in the resource
* attribute's Metadata, Properties, or Tags.
* @see ResourceAttribute
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceAttribute
*/
Builder attribute(String attribute);
/**
*
* Indicates which resource attribute is triggering this update, such as a change in the resource attribute's
* Metadata, Properties, or Tags.
*
*
* @param attribute
* Indicates which resource attribute is triggering this update, such as a change in the resource
* attribute's Metadata, Properties, or Tags.
* @see ResourceAttribute
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceAttribute
*/
Builder attribute(ResourceAttribute attribute);
/**
*
* If the Attribute value is Properties, the name of the property. For all other
* attributes, the value is null.
*
*
* @param name
* If the Attribute value is Properties, the name of the property. For all
* other attributes, the value is null.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* If the Attribute value is Properties, indicates whether a change to this property
* causes the resource to be recreated. The value can be Never, Always, or
* Conditionally. To determine the conditions for a Conditionally recreation, see the
* update behavior for that property in the CloudFormation User Guide.
*
*
* @param requiresRecreation
* If the Attribute value is Properties, indicates whether a change to this
* property causes the resource to be recreated. The value can be Never, Always
* , or Conditionally. To determine the conditions for a Conditionally
* recreation, see the update behavior for that property in the CloudFormation User Guide.
* @see RequiresRecreation
* @return Returns a reference to this object so that method calls can be chained together.
* @see RequiresRecreation
*/
Builder requiresRecreation(String requiresRecreation);
/**
*
* If the Attribute value is Properties, indicates whether a change to this property
* causes the resource to be recreated. The value can be Never, Always, or
* Conditionally. To determine the conditions for a Conditionally recreation, see the
* update behavior for that property in the CloudFormation User Guide.
*
*
* @param requiresRecreation
* If the Attribute value is Properties, indicates whether a change to this
* property causes the resource to be recreated. The value can be Never, Always
* , or Conditionally. To determine the conditions for a Conditionally
* recreation, see the update behavior for that property in the CloudFormation User Guide.
* @see RequiresRecreation
* @return Returns a reference to this object so that method calls can be chained together.
* @see RequiresRecreation
*/
Builder requiresRecreation(RequiresRecreation requiresRecreation);
}
static final class BuilderImpl implements Builder {
private String attribute;
private String name;
private String requiresRecreation;
private BuilderImpl() {
}
private BuilderImpl(ResourceTargetDefinition model) {
attribute(model.attribute);
name(model.name);
requiresRecreation(model.requiresRecreation);
}
public final String getAttribute() {
return attribute;
}
public final void setAttribute(String attribute) {
this.attribute = attribute;
}
@Override
@Transient
public final Builder attribute(String attribute) {
this.attribute = attribute;
return this;
}
@Override
@Transient
public final Builder attribute(ResourceAttribute attribute) {
this.attribute(attribute == null ? null : attribute.toString());
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
@Transient
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getRequiresRecreation() {
return requiresRecreation;
}
public final void setRequiresRecreation(String requiresRecreation) {
this.requiresRecreation = requiresRecreation;
}
@Override
@Transient
public final Builder requiresRecreation(String requiresRecreation) {
this.requiresRecreation = requiresRecreation;
return this;
}
@Override
@Transient
public final Builder requiresRecreation(RequiresRecreation requiresRecreation) {
this.requiresRecreation(requiresRecreation == null ? null : requiresRecreation.toString());
return this;
}
@Override
public ResourceTargetDefinition build() {
return new ResourceTargetDefinition(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}