software.amazon.awssdk.services.cloudformation.model.StackSummary 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.io.Serializable;
import java.time.Instant;
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 StackSummary Data Type
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class StackSummary implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField STACK_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackId").getter(getter(StackSummary::stackId)).setter(setter(Builder::stackId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackId").build()).build();
private static final SdkField STACK_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackName").getter(getter(StackSummary::stackName)).setter(setter(Builder::stackName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackName").build()).build();
private static final SdkField TEMPLATE_DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TemplateDescription").getter(getter(StackSummary::templateDescription))
.setter(setter(Builder::templateDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateDescription").build())
.build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(StackSummary::creationTime)).setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTime").build()).build();
private static final SdkField LAST_UPDATED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastUpdatedTime").getter(getter(StackSummary::lastUpdatedTime)).setter(setter(Builder::lastUpdatedTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastUpdatedTime").build()).build();
private static final SdkField DELETION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("DeletionTime").getter(getter(StackSummary::deletionTime)).setter(setter(Builder::deletionTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeletionTime").build()).build();
private static final SdkField STACK_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackStatus").getter(getter(StackSummary::stackStatusAsString)).setter(setter(Builder::stackStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackStatus").build()).build();
private static final SdkField STACK_STATUS_REASON_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackStatusReason").getter(getter(StackSummary::stackStatusReason))
.setter(setter(Builder::stackStatusReason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackStatusReason").build()).build();
private static final SdkField PARENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ParentId").getter(getter(StackSummary::parentId)).setter(setter(Builder::parentId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParentId").build()).build();
private static final SdkField ROOT_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("RootId")
.getter(getter(StackSummary::rootId)).setter(setter(Builder::rootId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RootId").build()).build();
private static final SdkField DRIFT_INFORMATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DriftInformation")
.getter(getter(StackSummary::driftInformation)).setter(setter(Builder::driftInformation))
.constructor(StackDriftInformationSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DriftInformation").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STACK_ID_FIELD,
STACK_NAME_FIELD, TEMPLATE_DESCRIPTION_FIELD, CREATION_TIME_FIELD, LAST_UPDATED_TIME_FIELD, DELETION_TIME_FIELD,
STACK_STATUS_FIELD, STACK_STATUS_REASON_FIELD, PARENT_ID_FIELD, ROOT_ID_FIELD, DRIFT_INFORMATION_FIELD));
private static final long serialVersionUID = 1L;
private final String stackId;
private final String stackName;
private final String templateDescription;
private final Instant creationTime;
private final Instant lastUpdatedTime;
private final Instant deletionTime;
private final String stackStatus;
private final String stackStatusReason;
private final String parentId;
private final String rootId;
private final StackDriftInformationSummary driftInformation;
private StackSummary(BuilderImpl builder) {
this.stackId = builder.stackId;
this.stackName = builder.stackName;
this.templateDescription = builder.templateDescription;
this.creationTime = builder.creationTime;
this.lastUpdatedTime = builder.lastUpdatedTime;
this.deletionTime = builder.deletionTime;
this.stackStatus = builder.stackStatus;
this.stackStatusReason = builder.stackStatusReason;
this.parentId = builder.parentId;
this.rootId = builder.rootId;
this.driftInformation = builder.driftInformation;
}
/**
*
* Unique stack identifier.
*
*
* @return Unique stack identifier.
*/
public final String stackId() {
return stackId;
}
/**
*
* The name associated with the stack.
*
*
* @return The name associated with the stack.
*/
public final String stackName() {
return stackName;
}
/**
*
* The template description of the template used to create the stack.
*
*
* @return The template description of the template used to create the stack.
*/
public final String templateDescription() {
return templateDescription;
}
/**
*
* The time the stack was created.
*
*
* @return The time the stack was created.
*/
public final Instant creationTime() {
return creationTime;
}
/**
*
* The time the stack was last updated. This field will only be returned if the stack has been updated at least
* once.
*
*
* @return The time the stack was last updated. This field will only be returned if the stack has been updated at
* least once.
*/
public final Instant lastUpdatedTime() {
return lastUpdatedTime;
}
/**
*
* The time the stack was deleted.
*
*
* @return The time the stack was deleted.
*/
public final Instant deletionTime() {
return deletionTime;
}
/**
*
* The current status of the stack.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #stackStatus} will
* return {@link StackStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stackStatusAsString}.
*
*
* @return The current status of the stack.
* @see StackStatus
*/
public final StackStatus stackStatus() {
return StackStatus.fromValue(stackStatus);
}
/**
*
* The current status of the stack.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #stackStatus} will
* return {@link StackStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stackStatusAsString}.
*
*
* @return The current status of the stack.
* @see StackStatus
*/
public final String stackStatusAsString() {
return stackStatus;
}
/**
*
* Success/Failure message associated with the stack status.
*
*
* @return Success/Failure message associated with the stack status.
*/
public final String stackStatusReason() {
return stackStatusReason;
}
/**
*
* For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this
* stack. For the first level of nested stacks, the root stack is also the parent stack.
*
*
* For more information, see Working with
* Nested Stacks in the CloudFormation User Guide.
*
*
* @return For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of
* this stack. For the first level of nested stacks, the root stack is also the parent stack.
*
* For more information, see Working with Nested Stacks in the CloudFormation User Guide.
*/
public final String parentId() {
return parentId;
}
/**
*
* For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which
* the nested stack ultimately belongs.
*
*
* For more information, see Working with
* Nested Stacks in the CloudFormation User Guide.
*
*
* @return For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to
* which the nested stack ultimately belongs.
*
* For more information, see Working with Nested Stacks in the CloudFormation User Guide.
*/
public final String rootId() {
return rootId;
}
/**
*
* Summarizes information about whether a stack's actual configuration differs, or has drifted, from its
* expected configuration, as defined in the stack template and any values specified as template parameters. For
* more information, see Detecting
* Unregulated Configuration Changes to Stacks and Resources.
*
*
* @return Summarizes information about whether a stack's actual configuration differs, or has drifted, from
* its expected configuration, as defined in the stack template and any values specified as template
* parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
*/
public final StackDriftInformationSummary driftInformation() {
return driftInformation;
}
@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(stackId());
hashCode = 31 * hashCode + Objects.hashCode(stackName());
hashCode = 31 * hashCode + Objects.hashCode(templateDescription());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(lastUpdatedTime());
hashCode = 31 * hashCode + Objects.hashCode(deletionTime());
hashCode = 31 * hashCode + Objects.hashCode(stackStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(stackStatusReason());
hashCode = 31 * hashCode + Objects.hashCode(parentId());
hashCode = 31 * hashCode + Objects.hashCode(rootId());
hashCode = 31 * hashCode + Objects.hashCode(driftInformation());
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 StackSummary)) {
return false;
}
StackSummary other = (StackSummary) obj;
return Objects.equals(stackId(), other.stackId()) && Objects.equals(stackName(), other.stackName())
&& Objects.equals(templateDescription(), other.templateDescription())
&& Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(lastUpdatedTime(), other.lastUpdatedTime())
&& Objects.equals(deletionTime(), other.deletionTime())
&& Objects.equals(stackStatusAsString(), other.stackStatusAsString())
&& Objects.equals(stackStatusReason(), other.stackStatusReason()) && Objects.equals(parentId(), other.parentId())
&& Objects.equals(rootId(), other.rootId()) && Objects.equals(driftInformation(), other.driftInformation());
}
/**
* 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("StackSummary").add("StackId", stackId()).add("StackName", stackName())
.add("TemplateDescription", templateDescription()).add("CreationTime", creationTime())
.add("LastUpdatedTime", lastUpdatedTime()).add("DeletionTime", deletionTime())
.add("StackStatus", stackStatusAsString()).add("StackStatusReason", stackStatusReason())
.add("ParentId", parentId()).add("RootId", rootId()).add("DriftInformation", driftInformation()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StackId":
return Optional.ofNullable(clazz.cast(stackId()));
case "StackName":
return Optional.ofNullable(clazz.cast(stackName()));
case "TemplateDescription":
return Optional.ofNullable(clazz.cast(templateDescription()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "LastUpdatedTime":
return Optional.ofNullable(clazz.cast(lastUpdatedTime()));
case "DeletionTime":
return Optional.ofNullable(clazz.cast(deletionTime()));
case "StackStatus":
return Optional.ofNullable(clazz.cast(stackStatusAsString()));
case "StackStatusReason":
return Optional.ofNullable(clazz.cast(stackStatusReason()));
case "ParentId":
return Optional.ofNullable(clazz.cast(parentId()));
case "RootId":
return Optional.ofNullable(clazz.cast(rootId()));
case "DriftInformation":
return Optional.ofNullable(clazz.cast(driftInformation()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StackSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Unique stack identifier.
*
*
* @param stackId
* Unique stack identifier.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackId(String stackId);
/**
*
* The name associated with the stack.
*
*
* @param stackName
* The name associated with the stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackName(String stackName);
/**
*
* The template description of the template used to create the stack.
*
*
* @param templateDescription
* The template description of the template used to create the stack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder templateDescription(String templateDescription);
/**
*
* The time the stack was created.
*
*
* @param creationTime
* The time the stack was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
*
* The time the stack was last updated. This field will only be returned if the stack has been updated at least
* once.
*
*
* @param lastUpdatedTime
* The time the stack was last updated. This field will only be returned if the stack has been updated at
* least once.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastUpdatedTime(Instant lastUpdatedTime);
/**
*
* The time the stack was deleted.
*
*
* @param deletionTime
* The time the stack was deleted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deletionTime(Instant deletionTime);
/**
*
* The current status of the stack.
*
*
* @param stackStatus
* The current status of the stack.
* @see StackStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackStatus
*/
Builder stackStatus(String stackStatus);
/**
*
* The current status of the stack.
*
*
* @param stackStatus
* The current status of the stack.
* @see StackStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackStatus
*/
Builder stackStatus(StackStatus stackStatus);
/**
*
* Success/Failure message associated with the stack status.
*
*
* @param stackStatusReason
* Success/Failure message associated with the stack status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackStatusReason(String stackStatusReason);
/**
*
* For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this
* stack. For the first level of nested stacks, the root stack is also the parent stack.
*
*
* For more information, see Working
* with Nested Stacks in the CloudFormation User Guide.
*
*
* @param parentId
* For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of
* this stack. For the first level of nested stacks, the root stack is also the parent stack.
*
* For more information, see Working with Nested Stacks in the CloudFormation User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parentId(String parentId);
/**
*
* For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to
* which the nested stack ultimately belongs.
*
*
* For more information, see Working
* with Nested Stacks in the CloudFormation User Guide.
*
*
* @param rootId
* For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack
* to which the nested stack ultimately belongs.
*
* For more information, see Working with Nested Stacks in the CloudFormation User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rootId(String rootId);
/**
*
* Summarizes information about whether a stack's actual configuration differs, or has drifted, from its
* expected configuration, as defined in the stack template and any values specified as template parameters. For
* more information, see Detecting
* Unregulated Configuration Changes to Stacks and Resources.
*
*
* @param driftInformation
* Summarizes information about whether a stack's actual configuration differs, or has drifted,
* from its expected configuration, as defined in the stack template and any values specified as template
* parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder driftInformation(StackDriftInformationSummary driftInformation);
/**
*
* Summarizes information about whether a stack's actual configuration differs, or has drifted, from its
* expected configuration, as defined in the stack template and any values specified as template parameters. For
* more information, see Detecting
* Unregulated Configuration Changes to Stacks and Resources.
*
* This is a convenience method that creates an instance of the {@link StackDriftInformationSummary.Builder}
* avoiding the need to create one manually via {@link StackDriftInformationSummary#builder()}.
*
*
* When the {@link Consumer} completes, {@link StackDriftInformationSummary.Builder#build()} is called
* immediately and its result is passed to {@link #driftInformation(StackDriftInformationSummary)}.
*
* @param driftInformation
* a consumer that will call methods on {@link StackDriftInformationSummary.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #driftInformation(StackDriftInformationSummary)
*/
default Builder driftInformation(Consumer driftInformation) {
return driftInformation(StackDriftInformationSummary.builder().applyMutation(driftInformation).build());
}
}
static final class BuilderImpl implements Builder {
private String stackId;
private String stackName;
private String templateDescription;
private Instant creationTime;
private Instant lastUpdatedTime;
private Instant deletionTime;
private String stackStatus;
private String stackStatusReason;
private String parentId;
private String rootId;
private StackDriftInformationSummary driftInformation;
private BuilderImpl() {
}
private BuilderImpl(StackSummary model) {
stackId(model.stackId);
stackName(model.stackName);
templateDescription(model.templateDescription);
creationTime(model.creationTime);
lastUpdatedTime(model.lastUpdatedTime);
deletionTime(model.deletionTime);
stackStatus(model.stackStatus);
stackStatusReason(model.stackStatusReason);
parentId(model.parentId);
rootId(model.rootId);
driftInformation(model.driftInformation);
}
public final String getStackId() {
return stackId;
}
public final void setStackId(String stackId) {
this.stackId = stackId;
}
@Override
public final Builder stackId(String stackId) {
this.stackId = stackId;
return this;
}
public final String getStackName() {
return stackName;
}
public final void setStackName(String stackName) {
this.stackName = stackName;
}
@Override
public final Builder stackName(String stackName) {
this.stackName = stackName;
return this;
}
public final String getTemplateDescription() {
return templateDescription;
}
public final void setTemplateDescription(String templateDescription) {
this.templateDescription = templateDescription;
}
@Override
public final Builder templateDescription(String templateDescription) {
this.templateDescription = templateDescription;
return this;
}
public final Instant getCreationTime() {
return creationTime;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
public final Instant getLastUpdatedTime() {
return lastUpdatedTime;
}
public final void setLastUpdatedTime(Instant lastUpdatedTime) {
this.lastUpdatedTime = lastUpdatedTime;
}
@Override
public final Builder lastUpdatedTime(Instant lastUpdatedTime) {
this.lastUpdatedTime = lastUpdatedTime;
return this;
}
public final Instant getDeletionTime() {
return deletionTime;
}
public final void setDeletionTime(Instant deletionTime) {
this.deletionTime = deletionTime;
}
@Override
public final Builder deletionTime(Instant deletionTime) {
this.deletionTime = deletionTime;
return this;
}
public final String getStackStatus() {
return stackStatus;
}
public final void setStackStatus(String stackStatus) {
this.stackStatus = stackStatus;
}
@Override
public final Builder stackStatus(String stackStatus) {
this.stackStatus = stackStatus;
return this;
}
@Override
public final Builder stackStatus(StackStatus stackStatus) {
this.stackStatus(stackStatus == null ? null : stackStatus.toString());
return this;
}
public final String getStackStatusReason() {
return stackStatusReason;
}
public final void setStackStatusReason(String stackStatusReason) {
this.stackStatusReason = stackStatusReason;
}
@Override
public final Builder stackStatusReason(String stackStatusReason) {
this.stackStatusReason = stackStatusReason;
return this;
}
public final String getParentId() {
return parentId;
}
public final void setParentId(String parentId) {
this.parentId = parentId;
}
@Override
public final Builder parentId(String parentId) {
this.parentId = parentId;
return this;
}
public final String getRootId() {
return rootId;
}
public final void setRootId(String rootId) {
this.rootId = rootId;
}
@Override
public final Builder rootId(String rootId) {
this.rootId = rootId;
return this;
}
public final StackDriftInformationSummary.Builder getDriftInformation() {
return driftInformation != null ? driftInformation.toBuilder() : null;
}
public final void setDriftInformation(StackDriftInformationSummary.BuilderImpl driftInformation) {
this.driftInformation = driftInformation != null ? driftInformation.build() : null;
}
@Override
public final Builder driftInformation(StackDriftInformationSummary driftInformation) {
this.driftInformation = driftInformation;
return this;
}
@Override
public StackSummary build() {
return new StackSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}