java.lang.Object
- software.amazon.awssdk.services.cloudformation.model.StackSetOperationSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StackSetOperationSummary.Builder,StackSetOperationSummary>
```
@Generated("software.amazon.awssdk:codegen")
public final class StackSetOperationSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StackSetOperationSummary.Builder,StackSetOperationSummary>
```
The structures that contain summary information about the specified operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StackSetOperationSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`StackSetOperationAction`	`action()`	The type of operation: `CREATE`, `UPDATE`, or `DELETE`.
`String`	`actionAsString()`	The type of operation: `CREATE`, `UPDATE`, or `DELETE`.
`static StackSetOperationSummary.Builder`	`builder()`
`Instant`	`creationTimestamp()`	The time at which the operation was initiated.
`Instant`	`endTimestamp()`	The time at which the StackSet operation ended, across all accounts and Regions specified.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`operationId()`	The unique ID of the StackSet operation.
`StackSetOperationPreferences`	`operationPreferences()`	The user-specified preferences for how CloudFormation performs a StackSet operation.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StackSetOperationSummary.Builder>`	`serializableBuilderClass()`
`StackSetOperationStatus`	`status()`	The overall status of the operation.
`String`	`statusAsString()`	The overall status of the operation.
`StackSetOperationStatusDetails`	`statusDetails()`	Detailed information about the StackSet operation.
`String`	`statusReason()`	The status of the operation in details.
`StackSetOperationSummary.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
  - operationId
```
public final String operationId()
```
    The unique ID of the StackSet operation.
    
    Returns:
    
    The unique ID of the StackSet operation.
  - action
```
public final StackSetOperationAction 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 StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.
    
    If the service returns an enum value that is not available in the current SDK version, action will return StackSetOperationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().
    
    Returns:
    
    The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.
    
    See Also:
    
    StackSetOperationAction
  - actionAsString
```
public final String actionAsString()
```
    The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.
    
    If the service returns an enum value that is not available in the current SDK version, action will return StackSetOperationAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().
    
    Returns:
    
    The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.
    
    See Also:
    
    StackSetOperationAction
  - status
```
public final StackSetOperationStatus 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 StackSet 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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return StackSetOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    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 StackSet 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 Also:
    
    StackSetOperationStatus
  - statusAsString
```
public final String statusAsString()
```
    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 StackSet 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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return StackSetOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    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 StackSet 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 Also:
    
    StackSetOperationStatus
  - creationTimestamp
```
public final Instant creationTimestamp()
```
    The time at which the operation was initiated. Note that the creation times for the StackSet 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.
    
    Returns:
    
    The time at which the operation was initiated. Note that the creation times for the StackSet 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.
  - endTimestamp
```
public final Instant endTimestamp()
```
    The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.
    
    Returns:
    
    The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.
  - statusReason
```
public final String statusReason()
```
    The status of the operation in details.
    
    Returns:
    
    The status of the operation in details.
  - statusDetails
```
public final StackSetOperationStatusDetails statusDetails()
```
    Detailed information about the StackSet operation.
    
    Returns:
    
    Detailed information about the StackSet operation.
  - operationPreferences
```
public final StackSetOperationPreferences operationPreferences()
```
    The user-specified preferences for how CloudFormation performs a StackSet operation.
    
    For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.
    
    Returns:
    
    The user-specified preferences for how CloudFormation performs a StackSet operation.
    
    For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.
  - toBuilder
```
public StackSetOperationSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StackSetOperationSummary.Builder,StackSetOperationSummary>
  - builder
```
public static StackSetOperationSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StackSetOperationSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class StackSetOperationSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

operationId

action

actionAsString

status

statusAsString

creationTimestamp

endTimestamp

statusReason

statusDetails

operationPreferences

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField