software.amazon.awssdk.services.ssm.model

Class ProgressCounters

java.lang.Object

software.amazon.awssdk.services.ssm.model.ProgressCounters

All Implemented Interfaces:

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

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

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProgressCounters.Builder

Method Summary

Modifier and Type	Method and Description
static ProgressCounters.Builder	builder()
Integer	cancelledSteps() The total number of steps that the system cancelled in all specified Regions and accounts for the current Automation execution.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
Integer	failedSteps() The total number of steps that failed to run in all specified Regions and accounts for the current Automation execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ProgressCounters.Builder>	serializableBuilderClass()
Integer	successSteps() The total number of steps that successfully completed in all specified Regions and accounts for the current Automation execution.
Integer	timedOutSteps() The total number of steps that timed out in all specified Regions and accounts for the current Automation execution.
ProgressCounters.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
Integer	totalSteps() The total number of steps run in all specified Regions and accounts for the current Automation execution.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

totalSteps

public final Integer totalSteps()

The total number of steps run in all specified Regions and accounts for the current Automation execution.

Returns:

The total number of steps run in all specified Regions and accounts for the current Automation execution.

successSteps

public final Integer successSteps()

The total number of steps that successfully completed in all specified Regions and accounts for the current Automation execution.

Returns:

The total number of steps that successfully completed in all specified Regions and accounts for the current Automation execution.

failedSteps

public final Integer failedSteps()

The total number of steps that failed to run in all specified Regions and accounts for the current Automation execution.

Returns:

The total number of steps that failed to run in all specified Regions and accounts for the current Automation execution.

cancelledSteps

public final Integer cancelledSteps()

The total number of steps that the system cancelled in all specified Regions and accounts for the current Automation execution.

Returns:

The total number of steps that the system cancelled in all specified Regions and accounts for the current Automation execution.

timedOutSteps

public final Integer timedOutSteps()

The total number of steps that timed out in all specified Regions and accounts for the current Automation execution.

Returns:

The total number of steps that timed out in all specified Regions and accounts for the current Automation execution.

toBuilder

public ProgressCounters.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ProgressCounters.Builder,ProgressCounters>

Returns:

a builder for type T

builder

public static ProgressCounters.Builder builder()

serializableBuilderClass

public static Class<? extends ProgressCounters.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.