HostRoleStatus (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<HostRoleStatus>
- - org.apache.ambari.server.actionmanager.HostRoleStatus

All Implemented Interfaces:

Serializable, Comparable<HostRoleStatus>
```
public enum HostRoleStatus
extends Enum<HostRoleStatus>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABORTED` Operation was abandoned
`COMPLETED` Host reported success
`FAILED` Failed
`HOLDING` Task is holding, waiting for command to proceed to completion.
`HOLDING_FAILED` Task is holding after a failure, waiting for command to skip or retry.
`HOLDING_TIMEDOUT` Task is holding after a time-out, waiting for command to skip or retry.
`IN_PROGRESS` Host reported it is working, received an IN_PROGRESS command status from host.
`PENDING` Not queued for a host.
`QUEUED` Queued for a host, or has already been sent to host, but host did not answer yet.
`SKIPPED_FAILED` The operation failed and was automatically skipped.
`TIMEDOUT` Host did not respond in time

Field Summary

Fields
Modifier and Type	Field and Description
`static Set<HostRoleStatus>`	`FAILED_STATUSES` The `HostRoleStatus`s that represent any commands which are considered to be "Failed".
`static Set<HostRoleStatus>`	`IN_PROGRESS_STATUSES` The `HostRoleStatus`s that represent any commands which are considered to be "In Progress".
`static Set<HostRoleStatus>`	`NOT_COMPLETED_STATUSES` The `HostRoleStatus`s that represent all non-completed states.
`static Set<HostRoleStatus>`	`NOT_SKIPPABLE_FAILED_STATUSES` The `HostRoleStatus`s that represent any commands which are considered to be "Failed" and next commands can not be executed.
`static List<HostRoleStatus>`	`SCHEDULED_STATES`
`static Set<HostRoleStatus>`	`STACK_UPGRADE_FAILED_STATUSES` The `HostRoleStatus`s that represent the current commands that failed during stack upgrade.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static List<HostRoleStatus>`	`getCompletedStates()`
`boolean`	`isCompletedState()` Indicates whether or not this is a completed state.
`boolean`	`isFailedAndNotSkippableState()` Indicates whether or not it is a valid failure state without ability to be skipped.
`boolean`	`isFailedState()` Indicates whether or not it is a valid failure state.
`boolean`	`isHoldingState()` Indicates whether or not this is a holding state.
`boolean`	`isInProgress()`
`static HostRoleStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static HostRoleStatus[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - PENDING
```
public static final HostRoleStatus PENDING
```
    Not queued for a host.
  - QUEUED
```
public static final HostRoleStatus QUEUED
```
    Queued for a host, or has already been sent to host, but host did not answer yet.
  - IN_PROGRESS
```
public static final HostRoleStatus IN_PROGRESS
```
    Host reported it is working, received an IN_PROGRESS command status from host.
  - HOLDING
```
public static final HostRoleStatus HOLDING
```
    Task is holding, waiting for command to proceed to completion.
  - COMPLETED
```
public static final HostRoleStatus COMPLETED
```
    Host reported success
  - FAILED
```
public static final HostRoleStatus FAILED
```
    Failed
  - HOLDING_FAILED
```
public static final HostRoleStatus HOLDING_FAILED
```
    Task is holding after a failure, waiting for command to skip or retry.
  - TIMEDOUT
```
public static final HostRoleStatus TIMEDOUT
```
    Host did not respond in time
  - HOLDING_TIMEDOUT
```
public static final HostRoleStatus HOLDING_TIMEDOUT
```
    Task is holding after a time-out, waiting for command to skip or retry.
  - ABORTED
```
public static final HostRoleStatus ABORTED
```
    Operation was abandoned
  - SKIPPED_FAILED
```
public static final HostRoleStatus SKIPPED_FAILED
```
    The operation failed and was automatically skipped.
- Field Detail
  - SCHEDULED_STATES
```
public static final List<HostRoleStatus> SCHEDULED_STATES
```
  - FAILED_STATUSES
```
public static final Set<HostRoleStatus> FAILED_STATUSES
```
    The HostRoleStatuss that represent any commands which are considered to be "Failed".
  - NOT_SKIPPABLE_FAILED_STATUSES
```
public static final Set<HostRoleStatus> NOT_SKIPPABLE_FAILED_STATUSES
```
    The HostRoleStatuss that represent any commands which are considered to be "Failed" and next commands can not be executed.
  - STACK_UPGRADE_FAILED_STATUSES
```
public static final Set<HostRoleStatus> STACK_UPGRADE_FAILED_STATUSES
```
    The HostRoleStatuss that represent the current commands that failed during stack upgrade. This is not used to indicate commands that failed and then skipped.
  - IN_PROGRESS_STATUSES
```
public static final Set<HostRoleStatus> IN_PROGRESS_STATUSES
```
    The HostRoleStatuss that represent any commands which are considered to be "In Progress".
  - NOT_COMPLETED_STATUSES
```
public static final Set<HostRoleStatus> NOT_COMPLETED_STATUSES
```
    The HostRoleStatuss that represent all non-completed states.
- Method Detail
  - values
```
public static HostRoleStatus[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (HostRoleStatus c : HostRoleStatus.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HostRoleStatus valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isFailedState
```
public boolean isFailedState()
```
    Indicates whether or not it is a valid failure state.
    
    Returns:
    
    true if this is a valid failure state.
  - isFailedAndNotSkippableState
```
public boolean isFailedAndNotSkippableState()
```
    Indicates whether or not it is a valid failure state without ability to be skipped.
    
    Returns:
    
    true if this is a valid failure state.
  - isCompletedState
```
public boolean isCompletedState()
```
    Indicates whether or not this is a completed state. Completed means that the associated task has stopped running because it has finished successfully or has failed.
    
    Returns:
    
    true if this is a completed state.
  - isHoldingState
```
public boolean isHoldingState()
```
    Indicates whether or not this is a holding state. Holding means that the associated task is waiting for a command to transition to a completion state.
    
    Returns:
    
    true if this is a holding state.
  - getCompletedStates
```
public static List<HostRoleStatus> getCompletedStates()
```
    Returns:
    
    list of completed states
  - isInProgress
```
public boolean isInProgress()
```
    Returns:
    
    true if this is a status that is in progress

Enum HostRoleStatus

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PENDING

QUEUED

IN_PROGRESS

HOLDING

COMPLETED

FAILED

HOLDING_FAILED

TIMEDOUT

HOLDING_TIMEDOUT

ABORTED

SKIPPED_FAILED

Field Detail

SCHEDULED_STATES

FAILED_STATUSES

NOT_SKIPPABLE_FAILED_STATUSES

STACK_UPGRADE_FAILED_STATUSES

IN_PROGRESS_STATUSES

NOT_COMPLETED_STATUSES

Method Detail

values

valueOf

isFailedState

isFailedAndNotSkippableState

isCompletedState

isHoldingState

getCompletedStates

isInProgress