UpgradeStepItem (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpgradeStepItem
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents a single step of the upgrade or upgrade eligibility check workflow.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpgradeStepItem()

Constructors
Constructor and Description
`UpgradeStepItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpgradeStepItem`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getIssues()` A list of strings containing detailed information about the errors encountered in a particular step.
`Double`	`getProgressPercent()` The floating point value representing the progress percentage of a particular step.
`String`	`getUpgradeStep()` One of three steps an upgrade or upgrade eligibility check goes through: PreUpgradeCheck Snapshot Upgrade
`String`	`getUpgradeStepStatus()` The current status of the upgrade.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setIssues(Collection<String> issues)` A list of strings containing detailed information about the errors encountered in a particular step.
`void`	`setProgressPercent(Double progressPercent)` The floating point value representing the progress percentage of a particular step.
`void`	`setUpgradeStep(String upgradeStep)` One of three steps an upgrade or upgrade eligibility check goes through: PreUpgradeCheck Snapshot Upgrade
`void`	`setUpgradeStepStatus(String upgradeStepStatus)` The current status of the upgrade.
`String`	`toString()` Returns a string representation of this object.
`UpgradeStepItem`	`withIssues(Collection<String> issues)` A list of strings containing detailed information about the errors encountered in a particular step.
`UpgradeStepItem`	`withIssues(String... issues)` A list of strings containing detailed information about the errors encountered in a particular step.
`UpgradeStepItem`	`withProgressPercent(Double progressPercent)` The floating point value representing the progress percentage of a particular step.
`UpgradeStepItem`	`withUpgradeStep(String upgradeStep)` One of three steps an upgrade or upgrade eligibility check goes through: PreUpgradeCheck Snapshot Upgrade
`UpgradeStepItem`	`withUpgradeStep(UpgradeStep upgradeStep)` One of three steps an upgrade or upgrade eligibility check goes through: PreUpgradeCheck Snapshot Upgrade
`UpgradeStepItem`	`withUpgradeStepStatus(String upgradeStepStatus)` The current status of the upgrade.
`UpgradeStepItem`	`withUpgradeStepStatus(UpgradeStatus upgradeStepStatus)` The current status of the upgrade.

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

- Constructor Detail
  - UpgradeStepItem
```
public UpgradeStepItem()
```
- Method Detail
  - setUpgradeStep
```
public void setUpgradeStep(String upgradeStep)
```
    One of three steps an upgrade or upgrade eligibility check goes through:
    - PreUpgradeCheck
    - Snapshot
    - Upgrade
    Parameters:
    upgradeStep - One of three steps an upgrade or upgrade eligibility check goes through:
    
    PreUpgradeCheck
    
    Snapshot
    
    Upgrade
    See Also:
    
    UpgradeStep
  - getUpgradeStep
```
public String getUpgradeStep()
```
    One of three steps an upgrade or upgrade eligibility check goes through:
    - PreUpgradeCheck
    - Snapshot
    - Upgrade
    Returns:
    One of three steps an upgrade or upgrade eligibility check goes through:
    
    PreUpgradeCheck
    
    Snapshot
    
    Upgrade
    See Also:
    
    UpgradeStep
  - withUpgradeStep
```
public UpgradeStepItem withUpgradeStep(String upgradeStep)
```
    One of three steps an upgrade or upgrade eligibility check goes through:
    - PreUpgradeCheck
    - Snapshot
    - Upgrade
    Parameters:
    upgradeStep - One of three steps an upgrade or upgrade eligibility check goes through:
    
    PreUpgradeCheck
    
    Snapshot
    
    Upgrade
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UpgradeStep
  - withUpgradeStep
```
public UpgradeStepItem withUpgradeStep(UpgradeStep upgradeStep)
```
    One of three steps an upgrade or upgrade eligibility check goes through:
    - PreUpgradeCheck
    - Snapshot
    - Upgrade
    Parameters:
    upgradeStep - One of three steps an upgrade or upgrade eligibility check goes through:
    
    PreUpgradeCheck
    
    Snapshot
    
    Upgrade
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UpgradeStep
  - setUpgradeStepStatus
```
public void setUpgradeStepStatus(String upgradeStepStatus)
```
    The current status of the upgrade. The status can take one of the following values:
    - In Progress
    - Succeeded
    - Succeeded with Issues
    - Failed
    Parameters:
    upgradeStepStatus - The current status of the upgrade. The status can take one of the following values:
    
    In Progress
    
    Succeeded
    
    Succeeded with Issues
    
    Failed
    See Also:
    
    UpgradeStatus
  - getUpgradeStepStatus
```
public String getUpgradeStepStatus()
```
    The current status of the upgrade. The status can take one of the following values:
    - In Progress
    - Succeeded
    - Succeeded with Issues
    - Failed
    Returns:
    The current status of the upgrade. The status can take one of the following values:
    
    In Progress
    
    Succeeded
    
    Succeeded with Issues
    
    Failed
    See Also:
    
    UpgradeStatus
  - withUpgradeStepStatus
```
public UpgradeStepItem withUpgradeStepStatus(String upgradeStepStatus)
```
    The current status of the upgrade. The status can take one of the following values:
    - In Progress
    - Succeeded
    - Succeeded with Issues
    - Failed
    Parameters:
    upgradeStepStatus - The current status of the upgrade. The status can take one of the following values:
    
    In Progress
    
    Succeeded
    
    Succeeded with Issues
    
    Failed
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UpgradeStatus
  - withUpgradeStepStatus
```
public UpgradeStepItem withUpgradeStepStatus(UpgradeStatus upgradeStepStatus)
```
    The current status of the upgrade. The status can take one of the following values:
    - In Progress
    - Succeeded
    - Succeeded with Issues
    - Failed
    Parameters:
    upgradeStepStatus - The current status of the upgrade. The status can take one of the following values:
    
    In Progress
    
    Succeeded
    
    Succeeded with Issues
    
    Failed
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UpgradeStatus
  - getIssues
```
public List<String> getIssues()
```
    A list of strings containing detailed information about the errors encountered in a particular step.
    
    Returns:
    
    A list of strings containing detailed information about the errors encountered in a particular step.
  - setIssues
```
public void setIssues(Collection<String> issues)
```
    A list of strings containing detailed information about the errors encountered in a particular step.
    
    Parameters:
    
    issues - A list of strings containing detailed information about the errors encountered in a particular step.
  - withIssues
```
public UpgradeStepItem withIssues(String... issues)
```
    A list of strings containing detailed information about the errors encountered in a particular step.
    
    NOTE: This method appends the values to the existing list (if any). Use setIssues(java.util.Collection) or withIssues(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    issues - A list of strings containing detailed information about the errors encountered in a particular step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIssues
```
public UpgradeStepItem withIssues(Collection<String> issues)
```
    A list of strings containing detailed information about the errors encountered in a particular step.
    
    Parameters:
    
    issues - A list of strings containing detailed information about the errors encountered in a particular step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProgressPercent
```
public void setProgressPercent(Double progressPercent)
```
    The floating point value representing the progress percentage of a particular step.
    
    Parameters:
    
    progressPercent - The floating point value representing the progress percentage of a particular step.
  - getProgressPercent
```
public Double getProgressPercent()
```
    The floating point value representing the progress percentage of a particular step.
    
    Returns:
    
    The floating point value representing the progress percentage of a particular step.
  - withProgressPercent
```
public UpgradeStepItem withProgressPercent(Double progressPercent)
```
    The floating point value representing the progress percentage of a particular step.
    
    Parameters:
    
    progressPercent - The floating point value representing the progress percentage of a particular step.
    
    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 UpgradeStepItem 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 UpgradeStepItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UpgradeStepItem

Method Detail

setUpgradeStep

getUpgradeStep

withUpgradeStep

withUpgradeStep

setUpgradeStepStatus

getUpgradeStepStatus

withUpgradeStepStatus

withUpgradeStepStatus

getIssues

setIssues

withIssues

withIssues

setProgressPercent

getProgressPercent

withProgressPercent

toString

equals

hashCode

clone

marshall