ChangeProgressStatusDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opensearch.model.ChangeProgressStatusDetails

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ChangeProgressStatusDetails
extends Object
implements Serializable, Cloneable, StructuredPojo

The progress details of a specific domain configuration change.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

ChangeProgressStatusDetails()

Constructors
Constructor and Description
`ChangeProgressStatusDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChangeProgressStatusDetails`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getChangeId()` The unique change identifier associated with a specific domain configuration change.
`List<ChangeProgressStage>`	`getChangeProgressStages()` The specific stages that the domain is going through to perform the configuration change.
`List<String>`	`getCompletedProperties()` The list of properties involved in the domain configuration change that are completed.
`List<String>`	`getPendingProperties()` The list of properties involved in the domain configuration change that are still in pending.
`Date`	`getStartTime()` The time at which the configuration change is made on the domain.
`String`	`getStatus()` The overall status of the domain configuration change.
`Integer`	`getTotalNumberOfStages()` The total number of stages required for the configuration change.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setChangeId(String changeId)` The unique change identifier associated with a specific domain configuration change.
`void`	`setChangeProgressStages(Collection<ChangeProgressStage> changeProgressStages)` The specific stages that the domain is going through to perform the configuration change.
`void`	`setCompletedProperties(Collection<String> completedProperties)` The list of properties involved in the domain configuration change that are completed.
`void`	`setPendingProperties(Collection<String> pendingProperties)` The list of properties involved in the domain configuration change that are still in pending.
`void`	`setStartTime(Date startTime)` The time at which the configuration change is made on the domain.
`void`	`setStatus(String status)` The overall status of the domain configuration change.
`void`	`setTotalNumberOfStages(Integer totalNumberOfStages)` The total number of stages required for the configuration change.
`String`	`toString()` Returns a string representation of this object.
`ChangeProgressStatusDetails`	`withChangeId(String changeId)` The unique change identifier associated with a specific domain configuration change.
`ChangeProgressStatusDetails`	`withChangeProgressStages(ChangeProgressStage... changeProgressStages)` The specific stages that the domain is going through to perform the configuration change.
`ChangeProgressStatusDetails`	`withChangeProgressStages(Collection<ChangeProgressStage> changeProgressStages)` The specific stages that the domain is going through to perform the configuration change.
`ChangeProgressStatusDetails`	`withCompletedProperties(Collection<String> completedProperties)` The list of properties involved in the domain configuration change that are completed.
`ChangeProgressStatusDetails`	`withCompletedProperties(String... completedProperties)` The list of properties involved in the domain configuration change that are completed.
`ChangeProgressStatusDetails`	`withPendingProperties(Collection<String> pendingProperties)` The list of properties involved in the domain configuration change that are still in pending.
`ChangeProgressStatusDetails`	`withPendingProperties(String... pendingProperties)` The list of properties involved in the domain configuration change that are still in pending.
`ChangeProgressStatusDetails`	`withStartTime(Date startTime)` The time at which the configuration change is made on the domain.
`ChangeProgressStatusDetails`	`withStatus(OverallChangeStatus status)` The overall status of the domain configuration change.
`ChangeProgressStatusDetails`	`withStatus(String status)` The overall status of the domain configuration change.
`ChangeProgressStatusDetails`	`withTotalNumberOfStages(Integer totalNumberOfStages)` The total number of stages required for the configuration change.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ChangeProgressStatusDetails
```
public ChangeProgressStatusDetails()
```
- Method Detail
  - setChangeId
```
public void setChangeId(String changeId)
```
    The unique change identifier associated with a specific domain configuration change.
    
    Parameters:
    
    changeId - The unique change identifier associated with a specific domain configuration change.
  - getChangeId
```
public String getChangeId()
```
    The unique change identifier associated with a specific domain configuration change.
    
    Returns:
    
    The unique change identifier associated with a specific domain configuration change.
  - withChangeId
```
public ChangeProgressStatusDetails withChangeId(String changeId)
```
    The unique change identifier associated with a specific domain configuration change.
    
    Parameters:
    
    changeId - The unique change identifier associated with a specific domain configuration change.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The time at which the configuration change is made on the domain.
    
    Parameters:
    
    startTime - The time at which the configuration change is made on the domain.
  - getStartTime
```
public Date getStartTime()
```
    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.
  - withStartTime
```
public ChangeProgressStatusDetails withStartTime(Date startTime)
```
    The time at which the configuration change is made on the domain.
    
    Parameters:
    
    startTime - The time at which the configuration change is made on the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
    
    Parameters:
    
    status - The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
    
    See Also:
    
    OverallChangeStatus
  - getStatus
```
public String getStatus()
```
    The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
    
    Returns:
    
    The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
    
    See Also:
    
    OverallChangeStatus
  - withStatus
```
public ChangeProgressStatusDetails withStatus(String status)
```
    The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
    
    Parameters:
    
    status - The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OverallChangeStatus
  - withStatus
```
public ChangeProgressStatusDetails withStatus(OverallChangeStatus status)
```
    The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
    
    Parameters:
    
    status - The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OverallChangeStatus
  - getPendingProperties
```
public List<String> getPendingProperties()
```
    The list of properties involved in the domain configuration change that are still in pending.
    
    Returns:
    
    The list of properties involved in the domain configuration change that are still in pending.
  - setPendingProperties
```
public void setPendingProperties(Collection<String> pendingProperties)
```
    The list of properties involved in the domain configuration change that are still in pending.
    
    Parameters:
    
    pendingProperties - The list of properties involved in the domain configuration change that are still in pending.
  - withPendingProperties
```
public ChangeProgressStatusDetails withPendingProperties(String... pendingProperties)
```
    The list of properties involved in the domain configuration change that are still in pending.
    
    NOTE: This method appends the values to the existing list (if any). Use setPendingProperties(java.util.Collection) or withPendingProperties(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    pendingProperties - The list of properties involved in the domain configuration change that are still in pending.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPendingProperties
```
public ChangeProgressStatusDetails withPendingProperties(Collection<String> pendingProperties)
```
    The list of properties involved in the domain configuration change that are still in pending.
    
    Parameters:
    
    pendingProperties - The list of properties involved in the domain configuration change that are still in pending.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCompletedProperties
```
public List<String> getCompletedProperties()
```
    The list of properties involved in the domain configuration change that are completed.
    
    Returns:
    
    The list of properties involved in the domain configuration change that are completed.
  - setCompletedProperties
```
public void setCompletedProperties(Collection<String> completedProperties)
```
    The list of properties involved in the domain configuration change that are completed.
    
    Parameters:
    
    completedProperties - The list of properties involved in the domain configuration change that are completed.
  - withCompletedProperties
```
public ChangeProgressStatusDetails withCompletedProperties(String... completedProperties)
```
    The list of properties involved in the domain configuration change that are completed.
    
    NOTE: This method appends the values to the existing list (if any). Use setCompletedProperties(java.util.Collection) or withCompletedProperties(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    completedProperties - The list of properties involved in the domain configuration change that are completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCompletedProperties
```
public ChangeProgressStatusDetails withCompletedProperties(Collection<String> completedProperties)
```
    The list of properties involved in the domain configuration change that are completed.
    
    Parameters:
    
    completedProperties - The list of properties involved in the domain configuration change that are completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalNumberOfStages
```
public void setTotalNumberOfStages(Integer totalNumberOfStages)
```
    The total number of stages required for the configuration change.
    
    Parameters:
    
    totalNumberOfStages - The total number of stages required for the configuration change.
  - getTotalNumberOfStages
```
public Integer getTotalNumberOfStages()
```
    The total number of stages required for the configuration change.
    
    Returns:
    
    The total number of stages required for the configuration change.
  - withTotalNumberOfStages
```
public ChangeProgressStatusDetails withTotalNumberOfStages(Integer totalNumberOfStages)
```
    The total number of stages required for the configuration change.
    
    Parameters:
    
    totalNumberOfStages - The total number of stages required for the configuration change.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getChangeProgressStages
```
public List<ChangeProgressStage> getChangeProgressStages()
```
    The specific stages that the domain is going through to perform the configuration change.
    
    Returns:
    
    The specific stages that the domain is going through to perform the configuration change.
  - setChangeProgressStages
```
public void setChangeProgressStages(Collection<ChangeProgressStage> changeProgressStages)
```
    The specific stages that the domain is going through to perform the configuration change.
    
    Parameters:
    
    changeProgressStages - The specific stages that the domain is going through to perform the configuration change.
  - withChangeProgressStages
```
public ChangeProgressStatusDetails withChangeProgressStages(ChangeProgressStage... changeProgressStages)
```
    The specific stages that the domain is going through to perform the configuration change.
    
    NOTE: This method appends the values to the existing list (if any). Use setChangeProgressStages(java.util.Collection) or withChangeProgressStages(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    changeProgressStages - The specific stages that the domain is going through to perform the configuration change.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withChangeProgressStages
```
public ChangeProgressStatusDetails withChangeProgressStages(Collection<ChangeProgressStage> changeProgressStages)
```
    The specific stages that the domain is going through to perform the configuration change.
    
    Parameters:
    
    changeProgressStages - The specific stages that the domain is going through to perform the configuration change.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ChangeProgressStatusDetails clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ChangeProgressStatusDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChangeProgressStatusDetails

Method Detail

setChangeId

getChangeId

withChangeId

setStartTime

getStartTime

withStartTime

setStatus

getStatus

withStatus

withStatus

getPendingProperties

setPendingProperties

withPendingProperties

withPendingProperties

getCompletedProperties

setCompletedProperties

withCompletedProperties

withCompletedProperties

setTotalNumberOfStages

getTotalNumberOfStages

withTotalNumberOfStages

getChangeProgressStages

setChangeProgressStages

withChangeProgressStages

withChangeProgressStages

toString

equals

hashCode

clone

marshall