software.amazon.awssdk.services.osis.model

Class ChangeProgressStatus

java.lang.Object

software.amazon.awssdk.services.osis.model.ChangeProgressStatus

All Implemented Interfaces:

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

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

The progress details of a pipeline configuration change.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChangeProgressStatus.Builder

Method Summary

Modifier and Type	Method and Description
static ChangeProgressStatus.Builder	builder()
List<ChangeProgressStage>	changeProgressStages() Information about the stages that the pipeline is going through to perform the configuration change.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChangeProgressStages() For responses, this returns true if the service returned a value for the ChangeProgressStages property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ChangeProgressStatus.Builder>	serializableBuilderClass()
Instant	startTime() The time at which the configuration change is made on the pipeline.
ChangeProgressStatuses	status() The overall status of the pipeline configuration change.
String	statusAsString() The overall status of the pipeline configuration change.
ChangeProgressStatus.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	totalNumberOfStages() The total number of stages required for the pipeline configuration change.

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

startTime

public final Instant startTime()

The time at which the configuration change is made on the pipeline.

Returns:

The time at which the configuration change is made on the pipeline.

status

public final ChangeProgressStatuses status()

The overall status of the pipeline configuration change.

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

Returns:

The overall status of the pipeline configuration change.

See Also:

ChangeProgressStatuses

statusAsString

public final String statusAsString()

The overall status of the pipeline configuration change.

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

Returns:

The overall status of the pipeline configuration change.

See Also:

ChangeProgressStatuses

totalNumberOfStages

public final Integer totalNumberOfStages()

The total number of stages required for the pipeline configuration change.

Returns:

The total number of stages required for the pipeline configuration change.

hasChangeProgressStages

public final boolean hasChangeProgressStages()

For responses, this returns true if the service returned a value for the ChangeProgressStages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

changeProgressStages

public final List<ChangeProgressStage> changeProgressStages()

Information about the stages that the pipeline is going through to perform the configuration change.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChangeProgressStages() method.

Returns:

Information about the stages that the pipeline is going through to perform the configuration change.

toBuilder

public ChangeProgressStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChangeProgressStatus.Builder,ChangeProgressStatus>

builder

public static ChangeProgressStatus.Builder builder()

serializableBuilderClass

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