com.amazonaws.services.cloudformation.model.ChangeSetSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.cloudformation.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* The ChangeSetSummary structure describes a change set, its status, and the stack with which it's
* associated.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ChangeSetSummary implements Serializable, Cloneable {
/**
*
* The ID of the stack with which the change set is associated.
*
*/
private String stackId;
/**
*
* The name of the stack with which the change set is associated.
*
*/
private String stackName;
/**
*
* The ID of the change set.
*
*/
private String changeSetId;
/**
*
* The name of the change set.
*
*/
private String changeSetName;
/**
*
* If the change set execution status is AVAILABLE, you can execute the change set. If you can't
* execute the change set, the status indicates why. For example, a change set might be in an
* UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state
* because the stack was already updated.
*
*/
private String executionStatus;
/**
*
* The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
* FAILED.
*
*/
private String status;
/**
*
* A description of the change set's status. For example, if your change set is in the FAILED state,
* CloudFormation shows the error message.
*
*/
private String statusReason;
/**
*
* The start time when the change set was created, in UTC.
*
*/
private java.util.Date creationTime;
/**
*
* Descriptive information about the change set.
*
*/
private String description;
/**
*
* Specifies the current setting of IncludeNestedStacks for the change set.
*
*/
private Boolean includeNestedStacks;
/**
*
* The parent change set ID.
*
*/
private String parentChangeSetId;
/**
*
* The root change set ID.
*
*/
private String rootChangeSetId;
/**
*
* Indicates if the change set imports resources that already exist.
*
*/
private Boolean importExistingResources;
/**
*
* The ID of the stack with which the change set is associated.
*
*
* @param stackId
* The ID of the stack with which the change set is associated.
*/
public void setStackId(String stackId) {
this.stackId = stackId;
}
/**
*
* The ID of the stack with which the change set is associated.
*
*
* @return The ID of the stack with which the change set is associated.
*/
public String getStackId() {
return this.stackId;
}
/**
*
* The ID of the stack with which the change set is associated.
*
*
* @param stackId
* The ID of the stack with which the change set is associated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChangeSetSummary withStackId(String stackId) {
setStackId(stackId);
return this;
}
/**
*
* The name of the stack with which the change set is associated.
*
*
* @param stackName
* The name of the stack with which the change set is associated.
*/
public void setStackName(String stackName) {
this.stackName = stackName;
}
/**
*
* The name of the stack with which the change set is associated.
*
*
* @return The name of the stack with which the change set is associated.
*/
public String getStackName() {
return this.stackName;
}
/**
*
* The name of the stack with which the change set is associated.
*
*
* @param stackName
* The name of the stack with which the change set is associated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChangeSetSummary withStackName(String stackName) {
setStackName(stackName);
return this;
}
/**
*
* The ID of the change set.
*
*
* @param changeSetId
* The ID of the change set.
*/
public void setChangeSetId(String changeSetId) {
this.changeSetId = changeSetId;
}
/**
*
* The ID of the change set.
*
*
* @return The ID of the change set.
*/
public String getChangeSetId() {
return this.changeSetId;
}
/**
*
* The ID of the change set.
*
*
* @param changeSetId
* The ID of the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChangeSetSummary withChangeSetId(String changeSetId) {
setChangeSetId(changeSetId);
return this;
}
/**
*
* The name of the change set.
*
*
* @param changeSetName
* The name of the change set.
*/
public void setChangeSetName(String changeSetName) {
this.changeSetName = changeSetName;
}
/**
*
* The name of the change set.
*
*
* @return The name of the change set.
*/
public String getChangeSetName() {
return this.changeSetName;
}
/**
*
* The name of the change set.
*
*
* @param changeSetName
* The name of the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChangeSetSummary withChangeSetName(String changeSetName) {
setChangeSetName(changeSetName);
return this;
}
/**
*
* If the change set execution status is AVAILABLE, you can execute the change set. If you can't
* execute the change set, the status indicates why. For example, a change set might be in an
* UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state
* because the stack was already updated.
*
*
* @param executionStatus
* If the change set execution status is AVAILABLE, you can execute the change set. If you can't
* execute the change set, the status indicates why. For example, a change set might be in an
* UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE
* state because the stack was already updated.
* @see ExecutionStatus
*/
public void setExecutionStatus(String executionStatus) {
this.executionStatus = executionStatus;
}
/**
*
* If the change set execution status is AVAILABLE, you can execute the change set. If you can't
* execute the change set, the status indicates why. For example, a change set might be in an
* UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state
* because the stack was already updated.
*
*
* @return If the change set execution status is AVAILABLE, you can execute the change set. If you
* can't execute the change set, the status indicates why. For example, a change set might be in an
* UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE
* state because the stack was already updated.
* @see ExecutionStatus
*/
public String getExecutionStatus() {
return this.executionStatus;
}
/**
*
* If the change set execution status is AVAILABLE, you can execute the change set. If you can't
* execute the change set, the status indicates why. For example, a change set might be in an
* UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state
* because the stack was already updated.
*
*
* @param executionStatus
* If the change set execution status is AVAILABLE, you can execute the change set. If you can't
* execute the change set, the status indicates why. For example, a change set might be in an
* UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE
* state because the stack was already updated.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExecutionStatus
*/
public ChangeSetSummary withExecutionStatus(String executionStatus) {
setExecutionStatus(executionStatus);
return this;
}
/**
*
* If the change set execution status is AVAILABLE, you can execute the change set. If you can't
* execute the change set, the status indicates why. For example, a change set might be in an
* UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state
* because the stack was already updated.
*
*
* @param executionStatus
* If the change set execution status is AVAILABLE, you can execute the change set. If you can't
* execute the change set, the status indicates why. For example, a change set might be in an
* UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE
* state because the stack was already updated.
* @see ExecutionStatus
*/
public void setExecutionStatus(ExecutionStatus executionStatus) {
withExecutionStatus(executionStatus);
}
/**
*
* If the change set execution status is AVAILABLE, you can execute the change set. If you can't
* execute the change set, the status indicates why. For example, a change set might be in an
* UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state
* because the stack was already updated.
*
*
* @param executionStatus
* If the change set execution status is AVAILABLE, you can execute the change set. If you can't
* execute the change set, the status indicates why. For example, a change set might be in an
* UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE
* state because the stack was already updated.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExecutionStatus
*/
public ChangeSetSummary withExecutionStatus(ExecutionStatus executionStatus) {
this.executionStatus = executionStatus.toString();
return this;
}
/**
*
* The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
* FAILED.
*
*
* @param status
* The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
* FAILED.
* @see ChangeSetStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
* FAILED.
*
*
* @return The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
* FAILED.
* @see ChangeSetStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
* FAILED.
*
*
* @param status
* The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
* FAILED.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChangeSetStatus
*/
public ChangeSetSummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
* FAILED.
*
*
* @param status
* The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
* FAILED.
* @see ChangeSetStatus
*/
public void setStatus(ChangeSetStatus status) {
withStatus(status);
}
/**
*
* The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
* FAILED.
*
*
* @param status
* The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
* FAILED.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChangeSetStatus
*/
public ChangeSetSummary withStatus(ChangeSetStatus status) {
this.status = status.toString();
return this;
}
/**
*
* A description of the change set's status. For example, if your change set is in the FAILED state,
* CloudFormation shows the error message.
*
*
* @param statusReason
* A description of the change set's status. For example, if your change set is in the FAILED
* state, CloudFormation shows the error message.
*/
public void setStatusReason(String statusReason) {
this.statusReason = statusReason;
}
/**
*
* A description of the change set's status. For example, if your change set is in the FAILED state,
* CloudFormation shows the error message.
*
*
* @return A description of the change set's status. For example, if your change set is in the FAILED
* state, CloudFormation shows the error message.
*/
public String getStatusReason() {
return this.statusReason;
}
/**
*
* A description of the change set's status. For example, if your change set is in the FAILED state,
* CloudFormation shows the error message.
*
*
* @param statusReason
* A description of the change set's status. For example, if your change set is in the FAILED
* state, CloudFormation shows the error message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChangeSetSummary withStatusReason(String statusReason) {
setStatusReason(statusReason);
return this;
}
/**
*
* The start time when the change set was created, in UTC.
*
*
* @param creationTime
* The start time when the change set was created, in UTC.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* The start time when the change set was created, in UTC.
*
*
* @return The start time when the change set was created, in UTC.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* The start time when the change set was created, in UTC.
*
*
* @param creationTime
* The start time when the change set was created, in UTC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChangeSetSummary withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* Descriptive information about the change set.
*
*
* @param description
* Descriptive information about the change set.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* Descriptive information about the change set.
*
*
* @return Descriptive information about the change set.
*/
public String getDescription() {
return this.description;
}
/**
*
* Descriptive information about the change set.
*
*
* @param description
* Descriptive information about the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChangeSetSummary withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Specifies the current setting of IncludeNestedStacks for the change set.
*
*
* @param includeNestedStacks
* Specifies the current setting of IncludeNestedStacks for the change set.
*/
public void setIncludeNestedStacks(Boolean includeNestedStacks) {
this.includeNestedStacks = includeNestedStacks;
}
/**
*
* Specifies the current setting of IncludeNestedStacks for the change set.
*
*
* @return Specifies the current setting of IncludeNestedStacks for the change set.
*/
public Boolean getIncludeNestedStacks() {
return this.includeNestedStacks;
}
/**
*
* Specifies the current setting of IncludeNestedStacks for the change set.
*
*
* @param includeNestedStacks
* Specifies the current setting of IncludeNestedStacks for the change set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChangeSetSummary withIncludeNestedStacks(Boolean includeNestedStacks) {
setIncludeNestedStacks(includeNestedStacks);
return this;
}
/**
*
* Specifies the current setting of IncludeNestedStacks for the change set.
*
*
* @return Specifies the current setting of IncludeNestedStacks for the change set.
*/
public Boolean isIncludeNestedStacks() {
return this.includeNestedStacks;
}
/**
*
* The parent change set ID.
*
*
* @param parentChangeSetId
* The parent change set ID.
*/
public void setParentChangeSetId(String parentChangeSetId) {
this.parentChangeSetId = parentChangeSetId;
}
/**
*
* The parent change set ID.
*
*
* @return The parent change set ID.
*/
public String getParentChangeSetId() {
return this.parentChangeSetId;
}
/**
*
* The parent change set ID.
*
*
* @param parentChangeSetId
* The parent change set ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChangeSetSummary withParentChangeSetId(String parentChangeSetId) {
setParentChangeSetId(parentChangeSetId);
return this;
}
/**
*
* The root change set ID.
*
*
* @param rootChangeSetId
* The root change set ID.
*/
public void setRootChangeSetId(String rootChangeSetId) {
this.rootChangeSetId = rootChangeSetId;
}
/**
*
* The root change set ID.
*
*
* @return The root change set ID.
*/
public String getRootChangeSetId() {
return this.rootChangeSetId;
}
/**
*
* The root change set ID.
*
*
* @param rootChangeSetId
* The root change set ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChangeSetSummary withRootChangeSetId(String rootChangeSetId) {
setRootChangeSetId(rootChangeSetId);
return this;
}
/**
*
* Indicates if the change set imports resources that already exist.
*
*
* @param importExistingResources
* Indicates if the change set imports resources that already exist.
*/
public void setImportExistingResources(Boolean importExistingResources) {
this.importExistingResources = importExistingResources;
}
/**
*
* Indicates if the change set imports resources that already exist.
*
*
* @return Indicates if the change set imports resources that already exist.
*/
public Boolean getImportExistingResources() {
return this.importExistingResources;
}
/**
*
* Indicates if the change set imports resources that already exist.
*
*
* @param importExistingResources
* Indicates if the change set imports resources that already exist.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ChangeSetSummary withImportExistingResources(Boolean importExistingResources) {
setImportExistingResources(importExistingResources);
return this;
}
/**
*
* Indicates if the change set imports resources that already exist.
*
*
* @return Indicates if the change set imports resources that already exist.
*/
public Boolean isImportExistingResources() {
return this.importExistingResources;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStackId() != null)
sb.append("StackId: ").append(getStackId()).append(",");
if (getStackName() != null)
sb.append("StackName: ").append(getStackName()).append(",");
if (getChangeSetId() != null)
sb.append("ChangeSetId: ").append(getChangeSetId()).append(",");
if (getChangeSetName() != null)
sb.append("ChangeSetName: ").append(getChangeSetName()).append(",");
if (getExecutionStatus() != null)
sb.append("ExecutionStatus: ").append(getExecutionStatus()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStatusReason() != null)
sb.append("StatusReason: ").append(getStatusReason()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getIncludeNestedStacks() != null)
sb.append("IncludeNestedStacks: ").append(getIncludeNestedStacks()).append(",");
if (getParentChangeSetId() != null)
sb.append("ParentChangeSetId: ").append(getParentChangeSetId()).append(",");
if (getRootChangeSetId() != null)
sb.append("RootChangeSetId: ").append(getRootChangeSetId()).append(",");
if (getImportExistingResources() != null)
sb.append("ImportExistingResources: ").append(getImportExistingResources());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ChangeSetSummary == false)
return false;
ChangeSetSummary other = (ChangeSetSummary) obj;
if (other.getStackId() == null ^ this.getStackId() == null)
return false;
if (other.getStackId() != null && other.getStackId().equals(this.getStackId()) == false)
return false;
if (other.getStackName() == null ^ this.getStackName() == null)
return false;
if (other.getStackName() != null && other.getStackName().equals(this.getStackName()) == false)
return false;
if (other.getChangeSetId() == null ^ this.getChangeSetId() == null)
return false;
if (other.getChangeSetId() != null && other.getChangeSetId().equals(this.getChangeSetId()) == false)
return false;
if (other.getChangeSetName() == null ^ this.getChangeSetName() == null)
return false;
if (other.getChangeSetName() != null && other.getChangeSetName().equals(this.getChangeSetName()) == false)
return false;
if (other.getExecutionStatus() == null ^ this.getExecutionStatus() == null)
return false;
if (other.getExecutionStatus() != null && other.getExecutionStatus().equals(this.getExecutionStatus()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getStatusReason() == null ^ this.getStatusReason() == null)
return false;
if (other.getStatusReason() != null && other.getStatusReason().equals(this.getStatusReason()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getIncludeNestedStacks() == null ^ this.getIncludeNestedStacks() == null)
return false;
if (other.getIncludeNestedStacks() != null && other.getIncludeNestedStacks().equals(this.getIncludeNestedStacks()) == false)
return false;
if (other.getParentChangeSetId() == null ^ this.getParentChangeSetId() == null)
return false;
if (other.getParentChangeSetId() != null && other.getParentChangeSetId().equals(this.getParentChangeSetId()) == false)
return false;
if (other.getRootChangeSetId() == null ^ this.getRootChangeSetId() == null)
return false;
if (other.getRootChangeSetId() != null && other.getRootChangeSetId().equals(this.getRootChangeSetId()) == false)
return false;
if (other.getImportExistingResources() == null ^ this.getImportExistingResources() == null)
return false;
if (other.getImportExistingResources() != null && other.getImportExistingResources().equals(this.getImportExistingResources()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStackId() == null) ? 0 : getStackId().hashCode());
hashCode = prime * hashCode + ((getStackName() == null) ? 0 : getStackName().hashCode());
hashCode = prime * hashCode + ((getChangeSetId() == null) ? 0 : getChangeSetId().hashCode());
hashCode = prime * hashCode + ((getChangeSetName() == null) ? 0 : getChangeSetName().hashCode());
hashCode = prime * hashCode + ((getExecutionStatus() == null) ? 0 : getExecutionStatus().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStatusReason() == null) ? 0 : getStatusReason().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getIncludeNestedStacks() == null) ? 0 : getIncludeNestedStacks().hashCode());
hashCode = prime * hashCode + ((getParentChangeSetId() == null) ? 0 : getParentChangeSetId().hashCode());
hashCode = prime * hashCode + ((getRootChangeSetId() == null) ? 0 : getRootChangeSetId().hashCode());
hashCode = prime * hashCode + ((getImportExistingResources() == null) ? 0 : getImportExistingResources().hashCode());
return hashCode;
}
@Override
public ChangeSetSummary clone() {
try {
return (ChangeSetSummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}