com.amazonaws.services.cloudformation.model.StackSetOperationResultSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* 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 structure that contains information about a specified operation's results for a given account in a given Region.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StackSetOperationResultSummary implements Serializable, Cloneable {
/**
*
* [Self-managed permissions] The name of the Amazon Web Services account for this operation result.
*
*/
private String account;
/**
*
* The name of the Amazon Web Services Region for this operation result.
*
*/
private String region;
/**
*
* The result status of the stack set operation for the given account in the given Region.
*
*
* -
*
* CANCELLED: The operation in the specified account and Region has been cancelled. This is either
* because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation
* has been exceeded.
*
*
* -
*
* FAILED: The operation in the specified account and Region failed.
*
*
* If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set
* operation as a whole might be exceeded.
*
*
* -
*
* RUNNING: The operation in the specified account and Region is currently in progress.
*
*
* -
*
* PENDING: The operation in the specified account and Region has yet to start.
*
*
* -
*
* SUCCEEDED: The operation in the specified account and Region completed successfully.
*
*
*
*/
private String status;
/**
*
* The reason for the assigned result status.
*
*/
private String statusReason;
/**
*
* The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set
* operations in an account
*
*/
private AccountGateResult accountGateResult;
/**
*
* [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for
* DeploymentTargets.
*
*/
private String organizationalUnitId;
/**
*
* [Self-managed permissions] The name of the Amazon Web Services account for this operation result.
*
*
* @param account
* [Self-managed permissions] The name of the Amazon Web Services account for this operation result.
*/
public void setAccount(String account) {
this.account = account;
}
/**
*
* [Self-managed permissions] The name of the Amazon Web Services account for this operation result.
*
*
* @return [Self-managed permissions] The name of the Amazon Web Services account for this operation result.
*/
public String getAccount() {
return this.account;
}
/**
*
* [Self-managed permissions] The name of the Amazon Web Services account for this operation result.
*
*
* @param account
* [Self-managed permissions] The name of the Amazon Web Services account for this operation result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StackSetOperationResultSummary withAccount(String account) {
setAccount(account);
return this;
}
/**
*
* The name of the Amazon Web Services Region for this operation result.
*
*
* @param region
* The name of the Amazon Web Services Region for this operation result.
*/
public void setRegion(String region) {
this.region = region;
}
/**
*
* The name of the Amazon Web Services Region for this operation result.
*
*
* @return The name of the Amazon Web Services Region for this operation result.
*/
public String getRegion() {
return this.region;
}
/**
*
* The name of the Amazon Web Services Region for this operation result.
*
*
* @param region
* The name of the Amazon Web Services Region for this operation result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StackSetOperationResultSummary withRegion(String region) {
setRegion(region);
return this;
}
/**
*
* The result status of the stack set operation for the given account in the given Region.
*
*
* -
*
* CANCELLED: The operation in the specified account and Region has been cancelled. This is either
* because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation
* has been exceeded.
*
*
* -
*
* FAILED: The operation in the specified account and Region failed.
*
*
* If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set
* operation as a whole might be exceeded.
*
*
* -
*
* RUNNING: The operation in the specified account and Region is currently in progress.
*
*
* -
*
* PENDING: The operation in the specified account and Region has yet to start.
*
*
* -
*
* SUCCEEDED: The operation in the specified account and Region completed successfully.
*
*
*
*
* @param status
* The result status of the stack set operation for the given account in the given Region.
*
* -
*
* CANCELLED: The operation in the specified account and Region has been cancelled. This is
* either because a user has stopped the stack set operation, or because the failure tolerance of the stack
* set operation has been exceeded.
*
*
* -
*
* FAILED: The operation in the specified account and Region failed.
*
*
* If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack
* set operation as a whole might be exceeded.
*
*
* -
*
* RUNNING: The operation in the specified account and Region is currently in progress.
*
*
* -
*
* PENDING: The operation in the specified account and Region has yet to start.
*
*
* -
*
* SUCCEEDED: The operation in the specified account and Region completed successfully.
*
*
* @see StackSetOperationResultStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The result status of the stack set operation for the given account in the given Region.
*
*
* -
*
* CANCELLED: The operation in the specified account and Region has been cancelled. This is either
* because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation
* has been exceeded.
*
*
* -
*
* FAILED: The operation in the specified account and Region failed.
*
*
* If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set
* operation as a whole might be exceeded.
*
*
* -
*
* RUNNING: The operation in the specified account and Region is currently in progress.
*
*
* -
*
* PENDING: The operation in the specified account and Region has yet to start.
*
*
* -
*
* SUCCEEDED: The operation in the specified account and Region completed successfully.
*
*
*
*
* @return The result status of the stack set operation for the given account in the given Region.
*
* -
*
* CANCELLED: The operation in the specified account and Region has been cancelled. This is
* either because a user has stopped the stack set operation, or because the failure tolerance of the stack
* set operation has been exceeded.
*
*
* -
*
* FAILED: The operation in the specified account and Region failed.
*
*
* If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack
* set operation as a whole might be exceeded.
*
*
* -
*
* RUNNING: The operation in the specified account and Region is currently in progress.
*
*
* -
*
* PENDING: The operation in the specified account and Region has yet to start.
*
*
* -
*
* SUCCEEDED: The operation in the specified account and Region completed successfully.
*
*
* @see StackSetOperationResultStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The result status of the stack set operation for the given account in the given Region.
*
*
* -
*
* CANCELLED: The operation in the specified account and Region has been cancelled. This is either
* because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation
* has been exceeded.
*
*
* -
*
* FAILED: The operation in the specified account and Region failed.
*
*
* If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set
* operation as a whole might be exceeded.
*
*
* -
*
* RUNNING: The operation in the specified account and Region is currently in progress.
*
*
* -
*
* PENDING: The operation in the specified account and Region has yet to start.
*
*
* -
*
* SUCCEEDED: The operation in the specified account and Region completed successfully.
*
*
*
*
* @param status
* The result status of the stack set operation for the given account in the given Region.
*
* -
*
* CANCELLED: The operation in the specified account and Region has been cancelled. This is
* either because a user has stopped the stack set operation, or because the failure tolerance of the stack
* set operation has been exceeded.
*
*
* -
*
* FAILED: The operation in the specified account and Region failed.
*
*
* If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack
* set operation as a whole might be exceeded.
*
*
* -
*
* RUNNING: The operation in the specified account and Region is currently in progress.
*
*
* -
*
* PENDING: The operation in the specified account and Region has yet to start.
*
*
* -
*
* SUCCEEDED: The operation in the specified account and Region completed successfully.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackSetOperationResultStatus
*/
public StackSetOperationResultSummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The result status of the stack set operation for the given account in the given Region.
*
*
* -
*
* CANCELLED: The operation in the specified account and Region has been cancelled. This is either
* because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation
* has been exceeded.
*
*
* -
*
* FAILED: The operation in the specified account and Region failed.
*
*
* If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set
* operation as a whole might be exceeded.
*
*
* -
*
* RUNNING: The operation in the specified account and Region is currently in progress.
*
*
* -
*
* PENDING: The operation in the specified account and Region has yet to start.
*
*
* -
*
* SUCCEEDED: The operation in the specified account and Region completed successfully.
*
*
*
*
* @param status
* The result status of the stack set operation for the given account in the given Region.
*
* -
*
* CANCELLED: The operation in the specified account and Region has been cancelled. This is
* either because a user has stopped the stack set operation, or because the failure tolerance of the stack
* set operation has been exceeded.
*
*
* -
*
* FAILED: The operation in the specified account and Region failed.
*
*
* If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack
* set operation as a whole might be exceeded.
*
*
* -
*
* RUNNING: The operation in the specified account and Region is currently in progress.
*
*
* -
*
* PENDING: The operation in the specified account and Region has yet to start.
*
*
* -
*
* SUCCEEDED: The operation in the specified account and Region completed successfully.
*
*
* @see StackSetOperationResultStatus
*/
public void setStatus(StackSetOperationResultStatus status) {
withStatus(status);
}
/**
*
* The result status of the stack set operation for the given account in the given Region.
*
*
* -
*
* CANCELLED: The operation in the specified account and Region has been cancelled. This is either
* because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation
* has been exceeded.
*
*
* -
*
* FAILED: The operation in the specified account and Region failed.
*
*
* If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set
* operation as a whole might be exceeded.
*
*
* -
*
* RUNNING: The operation in the specified account and Region is currently in progress.
*
*
* -
*
* PENDING: The operation in the specified account and Region has yet to start.
*
*
* -
*
* SUCCEEDED: The operation in the specified account and Region completed successfully.
*
*
*
*
* @param status
* The result status of the stack set operation for the given account in the given Region.
*
* -
*
* CANCELLED: The operation in the specified account and Region has been cancelled. This is
* either because a user has stopped the stack set operation, or because the failure tolerance of the stack
* set operation has been exceeded.
*
*
* -
*
* FAILED: The operation in the specified account and Region failed.
*
*
* If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack
* set operation as a whole might be exceeded.
*
*
* -
*
* RUNNING: The operation in the specified account and Region is currently in progress.
*
*
* -
*
* PENDING: The operation in the specified account and Region has yet to start.
*
*
* -
*
* SUCCEEDED: The operation in the specified account and Region completed successfully.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see StackSetOperationResultStatus
*/
public StackSetOperationResultSummary withStatus(StackSetOperationResultStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The reason for the assigned result status.
*
*
* @param statusReason
* The reason for the assigned result status.
*/
public void setStatusReason(String statusReason) {
this.statusReason = statusReason;
}
/**
*
* The reason for the assigned result status.
*
*
* @return The reason for the assigned result status.
*/
public String getStatusReason() {
return this.statusReason;
}
/**
*
* The reason for the assigned result status.
*
*
* @param statusReason
* The reason for the assigned result status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StackSetOperationResultSummary withStatusReason(String statusReason) {
setStatusReason(statusReason);
return this;
}
/**
*
* The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set
* operations in an account
*
*
* @param accountGateResult
* The results of the account gate function CloudFormation invokes, if present, before proceeding with stack
* set operations in an account
*/
public void setAccountGateResult(AccountGateResult accountGateResult) {
this.accountGateResult = accountGateResult;
}
/**
*
* The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set
* operations in an account
*
*
* @return The results of the account gate function CloudFormation invokes, if present, before proceeding with stack
* set operations in an account
*/
public AccountGateResult getAccountGateResult() {
return this.accountGateResult;
}
/**
*
* The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set
* operations in an account
*
*
* @param accountGateResult
* The results of the account gate function CloudFormation invokes, if present, before proceeding with stack
* set operations in an account
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StackSetOperationResultSummary withAccountGateResult(AccountGateResult accountGateResult) {
setAccountGateResult(accountGateResult);
return this;
}
/**
*
* [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for
* DeploymentTargets.
*
*
* @param organizationalUnitId
* [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified
* for
* DeploymentTargets.
*/
public void setOrganizationalUnitId(String organizationalUnitId) {
this.organizationalUnitId = organizationalUnitId;
}
/**
*
* [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for
* DeploymentTargets.
*
*
* @return [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified
* for DeploymentTargets.
*/
public String getOrganizationalUnitId() {
return this.organizationalUnitId;
}
/**
*
* [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for
* DeploymentTargets.
*
*
* @param organizationalUnitId
* [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified
* for
* DeploymentTargets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StackSetOperationResultSummary withOrganizationalUnitId(String organizationalUnitId) {
setOrganizationalUnitId(organizationalUnitId);
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 (getAccount() != null)
sb.append("Account: ").append(getAccount()).append(",");
if (getRegion() != null)
sb.append("Region: ").append(getRegion()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStatusReason() != null)
sb.append("StatusReason: ").append(getStatusReason()).append(",");
if (getAccountGateResult() != null)
sb.append("AccountGateResult: ").append(getAccountGateResult()).append(",");
if (getOrganizationalUnitId() != null)
sb.append("OrganizationalUnitId: ").append(getOrganizationalUnitId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StackSetOperationResultSummary == false)
return false;
StackSetOperationResultSummary other = (StackSetOperationResultSummary) obj;
if (other.getAccount() == null ^ this.getAccount() == null)
return false;
if (other.getAccount() != null && other.getAccount().equals(this.getAccount()) == false)
return false;
if (other.getRegion() == null ^ this.getRegion() == null)
return false;
if (other.getRegion() != null && other.getRegion().equals(this.getRegion()) == 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.getAccountGateResult() == null ^ this.getAccountGateResult() == null)
return false;
if (other.getAccountGateResult() != null && other.getAccountGateResult().equals(this.getAccountGateResult()) == false)
return false;
if (other.getOrganizationalUnitId() == null ^ this.getOrganizationalUnitId() == null)
return false;
if (other.getOrganizationalUnitId() != null && other.getOrganizationalUnitId().equals(this.getOrganizationalUnitId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccount() == null) ? 0 : getAccount().hashCode());
hashCode = prime * hashCode + ((getRegion() == null) ? 0 : getRegion().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStatusReason() == null) ? 0 : getStatusReason().hashCode());
hashCode = prime * hashCode + ((getAccountGateResult() == null) ? 0 : getAccountGateResult().hashCode());
hashCode = prime * hashCode + ((getOrganizationalUnitId() == null) ? 0 : getOrganizationalUnitId().hashCode());
return hashCode;
}
@Override
public StackSetOperationResultSummary clone() {
try {
return (StackSetOperationResultSummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}