RequestExecution (Ambari Server 3.0.0.0-SNAPSHOT API)

All Known Implementing Classes:

RequestExecutionImpl
```
public interface RequestExecution
```
Request Execution is a type of resource that supports scheduling a request or a group of requests for execution by the ActionManager.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class RequestExecution.Status
Status of the Request execution

Nested Classes
Modifier and Type	Interface and Description
`static class`	`RequestExecution.Status` Status of the Request execution

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`RequestScheduleResponse`	`convertToResponse()` Get @RequestScheduleResponse for this Request Execution
`RequestScheduleResponse`	`convertToResponseWithBody()` Get response with request body
`void`	`delete()` Delete Request Schedule entity
`Integer`	`getAuthenticatedUserId()` Get authenticated user
`Batch`	`getBatch()` Get the batch of requests along with batch settings
`BatchRequest`	`getBatchRequest(long batchId)` Get batch request with specified order id
`Collection<Long>`	`getBatchRequestRequestsIDs(long batchId)` Get the requests IDs for the batch
`String`	`getClusterName()` Cluster name to which request schedule belongs
`String`	`getCreateTime()` Get created time
`String`	`getCreateUser()` Get create user
`String`	`getDescription()` Get description of the request execution
`Long`	`getId()` Primary key of Request Execution
`String`	`getLastExecutionStatus()` Get status of the last batch of requests
`String`	`getRequestBody(Long batchId)` Get the request body for a batch request
`Schedule`	`getSchedule()` Get schedule for the execution
`String`	`getStatus()` Get status of schedule
`String`	`getUpdateTime()` Get updated time
`String`	`getUpdateUser()` Get update user
`void`	`persist()` Persist the Request Execution and schedule
`void`	`refresh()` Refresh entity from DB.
`void`	`setAuthenticatedUserId(Integer username)` Set authenticated user
`void`	`setBatch(Batch batch)` Set batch of requests and batch settings
`void`	`setCreateUser(String username)` Set create username
`void`	`setDescription(String description)` Set request execution description
`void`	`setLastExecutionStatus(String status)` Set datetime:status of last request that was executed
`void`	`setSchedule(Schedule schedule)` Set schedule for the execution
`void`	`setStatus(RequestExecution.Status status)` Set status of the schedule
`void`	`setUpdateUser(String username)` Set create username
`void`	`updateBatchRequest(long batchId, BatchRequestResponse batchRequestResponse, boolean statusOnly)` Updates batch request data
`void`	`updateStatus(RequestExecution.Status status)` Update status and save RequestExecution

- Method Detail
  - getId
```
Long getId()
```
    Primary key of Request Execution
    
    Returns:
  - getClusterName
```
String getClusterName()
```
    Cluster name to which request schedule belongs
    
    Returns:
  - getBatch
```
Batch getBatch()
```
    Get the batch of requests along with batch settings
    
    Returns:
  - setBatch
```
void setBatch(Batch batch)
```
    Set batch of requests and batch settings
  - getSchedule
```
Schedule getSchedule()
```
    Get schedule for the execution
    
    Returns:
  - setSchedule
```
void setSchedule(Schedule schedule)
```
    Set schedule for the execution
  - convertToResponse
```
RequestScheduleResponse convertToResponse()
```
    Get @RequestScheduleResponse for this Request Execution
    
    Returns:
  - persist
```
void persist()
```
    Persist the Request Execution and schedule
  - refresh
```
void refresh()
```
    Refresh entity from DB.
  - delete
```
void delete()
```
    Delete Request Schedule entity
  - getStatus
```
String getStatus()
```
    Get status of schedule
  - setDescription
```
void setDescription(String description)
```
    Set request execution description
  - getDescription
```
String getDescription()
```
    Get description of the request execution
  - setStatus
```
void setStatus(RequestExecution.Status status)
```
    Set status of the schedule
  - setLastExecutionStatus
```
void setLastExecutionStatus(String status)
```
    Set datetime:status of last request that was executed
  - setAuthenticatedUserId
```
void setAuthenticatedUserId(Integer username)
```
    Set authenticated user
  - setCreateUser
```
void setCreateUser(String username)
```
    Set create username
  - setUpdateUser
```
void setUpdateUser(String username)
```
    Set create username
  - getCreateTime
```
String getCreateTime()
```
    Get created time
  - getUpdateTime
```
String getUpdateTime()
```
    Get updated time
  - getAuthenticatedUserId
```
Integer getAuthenticatedUserId()
```
    Get authenticated user
  - getCreateUser
```
String getCreateUser()
```
    Get create user
  - getUpdateUser
```
String getUpdateUser()
```
    Get update user
  - getLastExecutionStatus
```
String getLastExecutionStatus()
```
    Get status of the last batch of requests
    
    Returns:
  - convertToResponseWithBody
```
RequestScheduleResponse convertToResponseWithBody()
```
    Get response with request body
  - getRequestBody
```
String getRequestBody(Long batchId)
```
    Get the request body for a batch request
  - getBatchRequestRequestsIDs
```
Collection<Long> getBatchRequestRequestsIDs(long batchId)
```
    Get the requests IDs for the batch
  - getBatchRequest
```
BatchRequest getBatchRequest(long batchId)
```
    Get batch request with specified order id
  - updateBatchRequest
```
void updateBatchRequest(long batchId,
                        BatchRequestResponse batchRequestResponse,
                        boolean statusOnly)
```
    Updates batch request data
    
    Parameters:
    
    batchId - order id of batch request
    
    batchRequestResponse -
    
    statusOnly - true if only status should be updated
  - updateStatus
```
void updateStatus(RequestExecution.Status status)
```
    Update status and save RequestExecution

Interface RequestExecution

Nested Class Summary

Method Summary

Method Detail

getId

getClusterName

getBatch

setBatch

getSchedule

setSchedule

convertToResponse

persist

refresh

delete

getStatus

setDescription

getDescription

setStatus

setLastExecutionStatus

setAuthenticatedUserId

setCreateUser

setUpdateUser

getCreateTime

getUpdateTime

getAuthenticatedUserId

getCreateUser

getUpdateUser

getLastExecutionStatus

convertToResponseWithBody

getRequestBody

getBatchRequestRequestsIDs

getBatchRequest

updateBatchRequest

updateStatus