com.amazonaws.services.cloudformation.model.StackSetOperationSummary Maven / Gradle / Ivy
/*
* Copyright 2017-2022 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 structures that contain summary information about the specified operation.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StackSetOperationSummary implements Serializable, Cloneable {
/**
*
* The unique ID of the stack set operation.
*
*/
private String operationId;
/**
*
* The type of operation: CREATE, UPDATE, or DELETE. Create and delete
* operations affect only the specified stack instances that are associated with the specified stack set. Update
* operations affect both the stack set itself and all associated stack set instances.
*
*/
private String action;
/**
*
* The overall status of the operation.
*
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
* you've set for an operation is applied for each Region during stack create and update operations. If the number
* of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set
* to FAILED. This in turn sets the status of the operation as a whole to FAILED, and
* CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of
* operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has canceled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding
* the failure tolerance for the operation.
*
*
*
*/
private String status;
/**
*
* The time at which the operation was initiated. Note that the creation times for the stack set operation might
* differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to
* perform preparatory work for the operation, such as dispatching the work to the requested Regions, before
* actually creating the first stacks.
*
*/
private java.util.Date creationTimestamp;
/**
*
* The time at which the stack set operation ended, across all accounts and Regions specified. Note that this
* doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or
* Region.
*
*/
private java.util.Date endTimestamp;
/**
*
* The status of the operation in details.
*
*/
private String statusReason;
/**
*
* The unique ID of the stack set operation.
*
*
* @param operationId
* The unique ID of the stack set operation.
*/
public void setOperationId(String operationId) {
this.operationId = operationId;
}
/**
*
* The unique ID of the stack set operation.
*
*
* @return The unique ID of the stack set operation.
*/
public String getOperationId() {
return this.operationId;
}
/**
*
* The unique ID of the stack set operation.
*
*
* @param operationId
* The unique ID of the stack set operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StackSetOperationSummary withOperationId(String operationId) {
setOperationId(operationId);
return this;
}
/**
*
* The type of operation: CREATE, UPDATE, or DELETE. Create and delete
* operations affect only the specified stack instances that are associated with the specified stack set. Update
* operations affect both the stack set itself and all associated stack set instances.
*
*
* @param action
* The type of operation: CREATE, UPDATE, or DELETE. Create and delete
* operations affect only the specified stack instances that are associated with the specified stack set.
* Update operations affect both the stack set itself and all associated stack set instances.
* @see StackSetOperationAction
*/
public void setAction(String action) {
this.action = action;
}
/**
*
* The type of operation: CREATE, UPDATE, or DELETE. Create and delete
* operations affect only the specified stack instances that are associated with the specified stack set. Update
* operations affect both the stack set itself and all associated stack set instances.
*
*
* @return The type of operation: CREATE, UPDATE, or DELETE. Create and
* delete operations affect only the specified stack instances that are associated with the specified stack
* set. Update operations affect both the stack set itself and all associated stack set instances.
* @see StackSetOperationAction
*/
public String getAction() {
return this.action;
}
/**
*
* The type of operation: CREATE, UPDATE, or DELETE. Create and delete
* operations affect only the specified stack instances that are associated with the specified stack set. Update
* operations affect both the stack set itself and all associated stack set instances.
*
*
* @param action
* The type of operation: CREATE, UPDATE, or DELETE. Create and delete
* operations affect only the specified stack instances that are associated with the specified stack set.
* Update operations affect both the stack set itself and all associated stack set instances.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackSetOperationAction
*/
public StackSetOperationSummary withAction(String action) {
setAction(action);
return this;
}
/**
*
* The type of operation: CREATE, UPDATE, or DELETE. Create and delete
* operations affect only the specified stack instances that are associated with the specified stack set. Update
* operations affect both the stack set itself and all associated stack set instances.
*
*
* @param action
* The type of operation: CREATE, UPDATE, or DELETE. Create and delete
* operations affect only the specified stack instances that are associated with the specified stack set.
* Update operations affect both the stack set itself and all associated stack set instances.
* @see StackSetOperationAction
*/
public void setAction(StackSetOperationAction action) {
withAction(action);
}
/**
*
* The type of operation: CREATE, UPDATE, or DELETE. Create and delete
* operations affect only the specified stack instances that are associated with the specified stack set. Update
* operations affect both the stack set itself and all associated stack set instances.
*
*
* @param action
* The type of operation: CREATE, UPDATE, or DELETE. Create and delete
* operations affect only the specified stack instances that are associated with the specified stack set.
* Update operations affect both the stack set itself and all associated stack set instances.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackSetOperationAction
*/
public StackSetOperationSummary withAction(StackSetOperationAction action) {
this.action = action.toString();
return this;
}
/**
*
* The overall status of the operation.
*
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
* you've set for an operation is applied for each Region during stack create and update operations. If the number
* of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set
* to FAILED. This in turn sets the status of the operation as a whole to FAILED, and
* CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of
* operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has canceled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding
* the failure tolerance for the operation.
*
*
*
*
* @param status
* The overall status of the operation.
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value
* that you've set for an operation is applied for each Region during stack create and update operations. If
* the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in
* the Region is set to FAILED. This in turn sets the status of the operation as a whole to
* FAILED, and CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of
* operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has canceled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without
* exceeding the failure tolerance for the operation.
*
*
* @see StackSetOperationStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The overall status of the operation.
*
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
* you've set for an operation is applied for each Region during stack create and update operations. If the number
* of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set
* to FAILED. This in turn sets the status of the operation as a whole to FAILED, and
* CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of
* operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has canceled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding
* the failure tolerance for the operation.
*
*
*
*
* @return The overall status of the operation.
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value
* that you've set for an operation is applied for each Region during stack create and update operations. If
* the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in
* the Region is set to FAILED. This in turn sets the status of the operation as a whole to
* FAILED, and CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of
* operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has canceled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without
* exceeding the failure tolerance for the operation.
*
*
* @see StackSetOperationStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The overall status of the operation.
*
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
* you've set for an operation is applied for each Region during stack create and update operations. If the number
* of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set
* to FAILED. This in turn sets the status of the operation as a whole to FAILED, and
* CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of
* operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has canceled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding
* the failure tolerance for the operation.
*
*
*
*
* @param status
* The overall status of the operation.
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value
* that you've set for an operation is applied for each Region during stack create and update operations. If
* the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in
* the Region is set to FAILED. This in turn sets the status of the operation as a whole to
* FAILED, and CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of
* operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has canceled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without
* exceeding the failure tolerance for the operation.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackSetOperationStatus
*/
public StackSetOperationSummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The overall status of the operation.
*
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
* you've set for an operation is applied for each Region during stack create and update operations. If the number
* of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set
* to FAILED. This in turn sets the status of the operation as a whole to FAILED, and
* CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of
* operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has canceled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding
* the failure tolerance for the operation.
*
*
*
*
* @param status
* The overall status of the operation.
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value
* that you've set for an operation is applied for each Region during stack create and update operations. If
* the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in
* the Region is set to FAILED. This in turn sets the status of the operation as a whole to
* FAILED, and CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of
* operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has canceled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without
* exceeding the failure tolerance for the operation.
*
*
* @see StackSetOperationStatus
*/
public void setStatus(StackSetOperationStatus status) {
withStatus(status);
}
/**
*
* The overall status of the operation.
*
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
* you've set for an operation is applied for each Region during stack create and update operations. If the number
* of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set
* to FAILED. This in turn sets the status of the operation as a whole to FAILED, and
* CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of
* operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has canceled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding
* the failure tolerance for the operation.
*
*
*
*
* @param status
* The overall status of the operation.
*
* -
*
* FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value
* that you've set for an operation is applied for each Region during stack create and update operations. If
* the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in
* the Region is set to FAILED. This in turn sets the status of the operation as a whole to
* FAILED, and CloudFormation cancels the operation in any remaining Regions.
*
*
* -
*
* QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of
* operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.
*
*
* -
*
* RUNNING: The operation is currently being performed.
*
*
* -
*
* STOPPED: The user has canceled the operation.
*
*
* -
*
* STOPPING: The operation is in the process of stopping, at user request.
*
*
* -
*
* SUCCEEDED: The operation completed creating or updating all the specified stacks without
* exceeding the failure tolerance for the operation.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackSetOperationStatus
*/
public StackSetOperationSummary withStatus(StackSetOperationStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The time at which the operation was initiated. Note that the creation times for the stack set operation might
* differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to
* perform preparatory work for the operation, such as dispatching the work to the requested Regions, before
* actually creating the first stacks.
*
*
* @param creationTimestamp
* The time at which the operation was initiated. Note that the creation times for the stack set operation
* might differ from the creation time of the individual stacks themselves. This is because CloudFormation
* needs to perform preparatory work for the operation, such as dispatching the work to the requested
* Regions, before actually creating the first stacks.
*/
public void setCreationTimestamp(java.util.Date creationTimestamp) {
this.creationTimestamp = creationTimestamp;
}
/**
*
* The time at which the operation was initiated. Note that the creation times for the stack set operation might
* differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to
* perform preparatory work for the operation, such as dispatching the work to the requested Regions, before
* actually creating the first stacks.
*
*
* @return The time at which the operation was initiated. Note that the creation times for the stack set operation
* might differ from the creation time of the individual stacks themselves. This is because CloudFormation
* needs to perform preparatory work for the operation, such as dispatching the work to the requested
* Regions, before actually creating the first stacks.
*/
public java.util.Date getCreationTimestamp() {
return this.creationTimestamp;
}
/**
*
* The time at which the operation was initiated. Note that the creation times for the stack set operation might
* differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to
* perform preparatory work for the operation, such as dispatching the work to the requested Regions, before
* actually creating the first stacks.
*
*
* @param creationTimestamp
* The time at which the operation was initiated. Note that the creation times for the stack set operation
* might differ from the creation time of the individual stacks themselves. This is because CloudFormation
* needs to perform preparatory work for the operation, such as dispatching the work to the requested
* Regions, before actually creating the first stacks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StackSetOperationSummary withCreationTimestamp(java.util.Date creationTimestamp) {
setCreationTimestamp(creationTimestamp);
return this;
}
/**
*
* The time at which the stack set operation ended, across all accounts and Regions specified. Note that this
* doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or
* Region.
*
*
* @param endTimestamp
* The time at which the stack set operation ended, across all accounts and Regions specified. Note that this
* doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account
* or Region.
*/
public void setEndTimestamp(java.util.Date endTimestamp) {
this.endTimestamp = endTimestamp;
}
/**
*
* The time at which the stack set operation ended, across all accounts and Regions specified. Note that this
* doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or
* Region.
*
*
* @return The time at which the stack set operation ended, across all accounts and Regions specified. Note that
* this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each
* account or Region.
*/
public java.util.Date getEndTimestamp() {
return this.endTimestamp;
}
/**
*
* The time at which the stack set operation ended, across all accounts and Regions specified. Note that this
* doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or
* Region.
*
*
* @param endTimestamp
* The time at which the stack set operation ended, across all accounts and Regions specified. Note that this
* doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account
* or Region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StackSetOperationSummary withEndTimestamp(java.util.Date endTimestamp) {
setEndTimestamp(endTimestamp);
return this;
}
/**
*
* The status of the operation in details.
*
*
* @param statusReason
* The status of the operation in details.
*/
public void setStatusReason(String statusReason) {
this.statusReason = statusReason;
}
/**
*
* The status of the operation in details.
*
*
* @return The status of the operation in details.
*/
public String getStatusReason() {
return this.statusReason;
}
/**
*
* The status of the operation in details.
*
*
* @param statusReason
* The status of the operation in details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StackSetOperationSummary withStatusReason(String statusReason) {
setStatusReason(statusReason);
return this;
}
/**
* 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 (getOperationId() != null)
sb.append("OperationId: ").append(getOperationId()).append(",");
if (getAction() != null)
sb.append("Action: ").append(getAction()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getCreationTimestamp() != null)
sb.append("CreationTimestamp: ").append(getCreationTimestamp()).append(",");
if (getEndTimestamp() != null)
sb.append("EndTimestamp: ").append(getEndTimestamp()).append(",");
if (getStatusReason() != null)
sb.append("StatusReason: ").append(getStatusReason());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StackSetOperationSummary == false)
return false;
StackSetOperationSummary other = (StackSetOperationSummary) obj;
if (other.getOperationId() == null ^ this.getOperationId() == null)
return false;
if (other.getOperationId() != null && other.getOperationId().equals(this.getOperationId()) == false)
return false;
if (other.getAction() == null ^ this.getAction() == null)
return false;
if (other.getAction() != null && other.getAction().equals(this.getAction()) == 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.getCreationTimestamp() == null ^ this.getCreationTimestamp() == null)
return false;
if (other.getCreationTimestamp() != null && other.getCreationTimestamp().equals(this.getCreationTimestamp()) == false)
return false;
if (other.getEndTimestamp() == null ^ this.getEndTimestamp() == null)
return false;
if (other.getEndTimestamp() != null && other.getEndTimestamp().equals(this.getEndTimestamp()) == false)
return false;
if (other.getStatusReason() == null ^ this.getStatusReason() == null)
return false;
if (other.getStatusReason() != null && other.getStatusReason().equals(this.getStatusReason()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getOperationId() == null) ? 0 : getOperationId().hashCode());
hashCode = prime * hashCode + ((getAction() == null) ? 0 : getAction().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getCreationTimestamp() == null) ? 0 : getCreationTimestamp().hashCode());
hashCode = prime * hashCode + ((getEndTimestamp() == null) ? 0 : getEndTimestamp().hashCode());
hashCode = prime * hashCode + ((getStatusReason() == null) ? 0 : getStatusReason().hashCode());
return hashCode;
}
@Override
public StackSetOperationSummary clone() {
try {
return (StackSetOperationSummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}