software.amazon.awssdk.services.cloudformation.model

Class StackSetOperationResultSummary

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.StackSetOperationResultSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StackSetOperationResultSummary.Builder,StackSetOperationResultSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class StackSetOperationResultSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StackSetOperationResultSummary.Builder,StackSetOperationResultSummary>

The structure that contains information about a specified operation's results for a given account in a given region.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StackSetOperationResultSummary.Builder

Method Summary

Modifier and Type	Method and Description
String	account() The name of the AWS account for this operation result.
AccountGateResult	accountGateResult() The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account
static StackSetOperationResultSummary.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	region() The name of the AWS region for this operation result.
List<SdkField<?>>	sdkFields()
static Class<? extends StackSetOperationResultSummary.Builder>	serializableBuilderClass()
StackSetOperationResultStatus	status() The result status of the stack set operation for the given account in the given region.
String	statusAsString() The result status of the stack set operation for the given account in the given region.
String	statusReason() The reason for the assigned result status.
StackSetOperationResultSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

account

public String account()

The name of the AWS account for this operation result.

Returns:

The name of the AWS account for this operation result.

region

public String region()

The name of the AWS region for this operation result.

Returns:

The name of the AWS region for this operation result.

status

public StackSetOperationResultStatus 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.

If the service returns an enum value that is not available in the current SDK version, status will return StackSetOperationResultStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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 Also:

StackSetOperationResultStatus

statusAsString

public String statusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, status will return StackSetOperationResultStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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 Also:

StackSetOperationResultStatus

statusReason

public String statusReason()

The reason for the assigned result status.

Returns:

The reason for the assigned result status.

accountGateResult

public AccountGateResult accountGateResult()

The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account

Returns:

The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account

toBuilder

public StackSetOperationResultSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StackSetOperationResultSummary.Builder,StackSetOperationResultSummary>

builder

public static StackSetOperationResultSummary.Builder builder()

serializableBuilderClass

public static Class<? extends StackSetOperationResultSummary.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo