HostRoleCommandEntity (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.orm.entities.HostRoleCommandEntity

@Entity
public class HostRoleCommandEntity
extends Object

Constructor Summary

Constructors
Constructor and Description

HostRoleCommandEntity()

Constructors
Constructor and Description
`HostRoleCommandEntity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Short`	`getAttemptCount()`
`String`	`getCommandDetail()`
`String`	`getCustomCommandName()`
`Long`	`getEndTime()`
`String`	`getErrorLog()`
`String`	`getEvent()`
`ExecutionCommandEntity`	`getExecutionCommand()`
`Integer`	`getExitcode()`
`HostEntity`	`getHostEntity()`
`Long`	`getHostId()`
`String`	`getHostName()`
`Long`	`getLastAttemptTime()`
`String`	`getOpsDisplayName()`
`Long`	`getOriginalStartTime()` Get the original time the command was first scheduled on the agent.
`String`	`getOutputLog()`
`Long`	`getRequestId()`
`Role`	`getRole()`
`RoleCommand`	`getRoleCommand()`
`StageEntity`	`getStage()`
`Long`	`getStageId()`
`Long`	`getStartTime()`
`HostRoleStatus`	`getStatus()`
`byte[]`	`getStdError()`
`byte[]`	`getStdOut()`
`byte[]`	`getStructuredOut()`
`Long`	`getTaskId()`
`TopologyLogicalTaskEntity`	`getTopologyLogicalTaskEntity()`
`int`	`hashCode()`
`boolean`	`isBackgroundCommand()` Gets whether this command runs in the background and will not block other commands.
`boolean`	`isFailureAutoSkipped()` Gets whether commands which fail and are retryable are automatically skipped and marked with `HostRoleStatus.SKIPPED_FAILED`.
`boolean`	`isRetryAllowed()` Determine whether this task should hold for retry when an error occurs.
`void`	`setAttemptCount(Short attemptCount)`
`void`	`setAutoSkipOnFailure(boolean skipFailures)` Sets whether commands which fail and are retryable are automatically skipped and marked with `HostRoleStatus.SKIPPED_FAILED`.
`void`	`setBackgroundCommand(boolean runInBackground)` Sets whether this is a command is a background command and will not block other commands.
`void`	`setCommandDetail(String commandDetail)`
`void`	`setCustomCommandName(String customCommandName)`
`void`	`setEndTime(Long endTime)`
`void`	`setErrorLog(String errorLog)`
`void`	`setEvent(String event)`
`void`	`setExecutionCommand(ExecutionCommandEntity executionCommandsByTaskId)`
`void`	`setExitcode(Integer exitcode)`
`void`	`setHostEntity(HostEntity hostEntity)`
`void`	`setLastAttemptTime(Long lastAttemptTime)`
`void`	`setOpsDisplayName(String opsDisplayName)`
`void`	`setOriginalStartTime(Long originalStartTime)` Set the original start time when the command is first scheduled.
`void`	`setOutputLog(String outputLog)`
`void`	`setRequestId(Long requestId)`
`void`	`setRetryAllowed(boolean enabled)` Sets whether this task should hold for retry when an error occurs.
`void`	`setRole(Role role)`
`void`	`setRoleCommand(RoleCommand roleCommand)`
`void`	`setStage(StageEntity stage)` Sets the associated `StageEntity` for this command.
`void`	`setStageId(Long stageId)`
`void`	`setStartTime(Long startTime)`
`void`	`setStatus(HostRoleStatus status)`
`void`	`setStdError(byte[] stdError)`
`void`	`setStdOut(byte[] stdOut)`
`void`	`setStructuredOut(byte[] structuredOut)`
`void`	`setTaskId(Long taskId)`
`void`	`setTopologyLogicalTaskEntity(TopologyLogicalTaskEntity topologyLogicalTaskEntity)`
`String`	`toString()`

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

Constructor Detail
- HostRoleCommandEntity
```
public HostRoleCommandEntity()
```

Method Detail

getTaskId
```
public Long getTaskId()
```

setTaskId
```
public void setTaskId(Long taskId)
```

getRequestId
```
public Long getRequestId()
```

setRequestId

public void setRequestId(Long requestId)

getStageId
```
public Long getStageId()
```

setStageId
```
public void setStageId(Long stageId)
```

getHostName
```
public String getHostName()
```

getHostId
```
public Long getHostId()
```

getRole
```
public Role getRole()
```

setRole
```
public void setRole(Role role)
```

getEvent
```
public String getEvent()
```

setEvent
```
public void setEvent(String event)
```

getExitcode
```
public Integer getExitcode()
```

setExitcode

public void setExitcode(Integer exitcode)

getStatus
```
public HostRoleStatus getStatus()
```

setStatus

public void setStatus(HostRoleStatus status)

getStdError
```
public byte[] getStdError()
```

setStdError

public void setStdError(byte[] stdError)

getStdOut
```
public byte[] getStdOut()
```

setStdOut
```
public void setStdOut(byte[] stdOut)
```

getOutputLog
```
public String getOutputLog()
```

setOutputLog

public void setOutputLog(String outputLog)

getErrorLog
```
public String getErrorLog()
```

setErrorLog

public void setErrorLog(String errorLog)

getStartTime
```
public Long getStartTime()
```

setStartTime

public void setStartTime(Long startTime)

getOriginalStartTime
```
public Long getOriginalStartTime()
```
Get the original time the command was first scheduled on the agent. This value is never overwritten.

Returns:

Original start time

setOriginalStartTime
```
public void setOriginalStartTime(Long originalStartTime)
```
Set the original start time when the command is first scheduled. This value is never overwritten.

Parameters:

originalStartTime - Original start time

getLastAttemptTime
```
public Long getLastAttemptTime()
```

setLastAttemptTime

public void setLastAttemptTime(Long lastAttemptTime)

getAttemptCount
```
public Short getAttemptCount()
```

setAttemptCount

public void setAttemptCount(Short attemptCount)

getRoleCommand
```
public RoleCommand getRoleCommand()
```

setRoleCommand

public void setRoleCommand(RoleCommand roleCommand)

getStructuredOut
```
public byte[] getStructuredOut()
```

setStructuredOut

public void setStructuredOut(byte[] structuredOut)

getEndTime
```
public Long getEndTime()
```

setEndTime
```
public void setEndTime(Long endTime)
```

getCommandDetail
```
public String getCommandDetail()
```

setCommandDetail

public void setCommandDetail(String commandDetail)

getCustomCommandName
```
public String getCustomCommandName()
```

setCustomCommandName

public void setCustomCommandName(String customCommandName)

getOpsDisplayName
```
public String getOpsDisplayName()
```

setOpsDisplayName

public void setOpsDisplayName(String opsDisplayName)

isRetryAllowed
```
public boolean isRetryAllowed()
```
Determine whether this task should hold for retry when an error occurs.

Returns:

true if this task should hold for retry when an error occurs

setRetryAllowed
```
public void setRetryAllowed(boolean enabled)
```
Sets whether this task should hold for retry when an error occurs.

Parameters:

enabled - true if this task should hold for retry when an error occurs

isFailureAutoSkipped
```
public boolean isFailureAutoSkipped()
```
Gets whether commands which fail and are retryable are automatically skipped and marked with HostRoleStatus.SKIPPED_FAILED.

Returns:

setAutoSkipOnFailure
```
public void setAutoSkipOnFailure(boolean skipFailures)
```
Sets whether commands which fail and are retryable are automatically skipped and marked with HostRoleStatus.SKIPPED_FAILED.

Parameters:

skipFailures -

setBackgroundCommand
```
public void setBackgroundCommand(boolean runInBackground)
```
Sets whether this is a command is a background command and will not block other commands.

Parameters:

runInBackground - true if this is a background command, false otherwise.

isBackgroundCommand
```
public boolean isBackgroundCommand()
```
Gets whether this command runs in the background and will not block other commands.

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

getExecutionCommand

public ExecutionCommandEntity getExecutionCommand()

setExecutionCommand

public void setExecutionCommand(ExecutionCommandEntity executionCommandsByTaskId)

getStage
```
public StageEntity getStage()
```

setStage
```
public void setStage(StageEntity stage)
```
Sets the associated StageEntity for this command. If the StageEntity has been persisted, then this will also set the commands stage and request ID fields.

Parameters:

stage -

getHostEntity
```
public HostEntity getHostEntity()
```

setHostEntity

public void setHostEntity(HostEntity hostEntity)

getTopologyLogicalTaskEntity

public TopologyLogicalTaskEntity getTopologyLogicalTaskEntity()

setTopologyLogicalTaskEntity

public void setTopologyLogicalTaskEntity(TopologyLogicalTaskEntity topologyLogicalTaskEntity)

toString
```
public String toString()
```
Overrides:

toString in class Object

Class HostRoleCommandEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HostRoleCommandEntity

Method Detail

getTaskId

setTaskId

getRequestId

setRequestId

getStageId

setStageId

getHostName

getHostId

getRole

setRole

getEvent

setEvent

getExitcode

setExitcode

getStatus

setStatus

getStdError

setStdError

getStdOut

setStdOut

getOutputLog

setOutputLog

getErrorLog

setErrorLog

getStartTime

setStartTime

getOriginalStartTime

setOriginalStartTime

getLastAttemptTime

setLastAttemptTime

getAttemptCount

setAttemptCount

getRoleCommand

setRoleCommand

getStructuredOut

setStructuredOut

getEndTime

setEndTime

getCommandDetail

setCommandDetail

getCustomCommandName

setCustomCommandName

getOpsDisplayName

setOpsDisplayName

isRetryAllowed

setRetryAllowed

isFailureAutoSkipped

setAutoSkipOnFailure

setBackgroundCommand

isBackgroundCommand

equals

hashCode

getExecutionCommand

setExecutionCommand

getStage

setStage

getHostEntity

setHostEntity

getTopologyLogicalTaskEntity

setTopologyLogicalTaskEntity

toString