ChangeProgressStatusDetails (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.opensearch.model.ChangeProgressStatusDetails

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ChangeProgressStatusDetails.Builder,ChangeProgressStatusDetails>

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

The progress details of a specific domain configuration change.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ChangeProgressStatusDetails.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ChangeProgressStatusDetails.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ChangeProgressStatusDetails.Builder`	`builder()`
`String`	`changeId()` The unique change identifier associated with a specific domain configuration change.
`List<ChangeProgressStage>`	`changeProgressStages()` The specific stages that the domain is going through to perform the configuration change.
`List<String>`	`completedProperties()` The list of properties in the domain configuration change that have completed.
`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.
`boolean`	`hasCompletedProperties()` For responses, this returns true if the service returned a value for the CompletedProperties property.
`int`	`hashCode()`
`boolean`	`hasPendingProperties()` For responses, this returns true if the service returned a value for the PendingProperties property.
`List<String>`	`pendingProperties()` The list of properties in the domain configuration change that are still pending.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ChangeProgressStatusDetails.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The time at which the configuration change is made on the domain.
`OverallChangeStatus`	`status()` The overall status of the domain configuration change.
`String`	`statusAsString()` The overall status of the domain configuration change.
`ChangeProgressStatusDetails.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Integer`	`totalNumberOfStages()` The total number of stages required for the 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
  - changeId
```
public final String changeId()
```
    The unique change identifier associated with a specific domain configuration change.
    
    Returns:
    
    The unique change identifier associated with a specific domain configuration change.
  - startTime
```
public final Instant startTime()
```
    The time at which the configuration change is made on the domain.
    
    Returns:
    
    The time at which the configuration change is made on the domain.
  - status
```
public final OverallChangeStatus status()
```
    The overall status of the domain configuration change.
    
    If the service returns an enum value that is not available in the current SDK version, status will return OverallChangeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The overall status of the domain configuration change.
    
    See Also:
    
    OverallChangeStatus
  - statusAsString
```
public final String statusAsString()
```
    The overall status of the domain configuration change.
    
    If the service returns an enum value that is not available in the current SDK version, status will return OverallChangeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The overall status of the domain configuration change.
    
    See Also:
    
    OverallChangeStatus
  - hasPendingProperties
```
public final boolean hasPendingProperties()
```
    For responses, this returns true if the service returned a value for the PendingProperties 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.
  - pendingProperties
```
public final List<String> pendingProperties()
```
    The list of properties in the domain configuration change that are still pending.
    
    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 hasPendingProperties() method.
    
    Returns:
    
    The list of properties in the domain configuration change that are still pending.
  - hasCompletedProperties
```
public final boolean hasCompletedProperties()
```
    For responses, this returns true if the service returned a value for the CompletedProperties 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.
  - completedProperties
```
public final List<String> completedProperties()
```
    The list of properties in the domain configuration change that have completed.
    
    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 hasCompletedProperties() method.
    
    Returns:
    
    The list of properties in the domain configuration change that have completed.
  - totalNumberOfStages
```
public final Integer totalNumberOfStages()
```
    The total number of stages required for the configuration change.
    
    Returns:
    
    The total number of stages required for the 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()
```
    The specific stages that the domain 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:
    
    The specific stages that the domain is going through to perform the configuration change.
  - toBuilder
```
public ChangeProgressStatusDetails.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ChangeProgressStatusDetails.Builder,ChangeProgressStatusDetails>
  - builder
```
public static ChangeProgressStatusDetails.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ChangeProgressStatusDetails.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

Class ChangeProgressStatusDetails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

changeId

startTime

status

statusAsString

hasPendingProperties

pendingProperties

hasCompletedProperties

completedProperties

totalNumberOfStages

hasChangeProgressStages

changeProgressStages

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields