IClusterClient
public
interface
IClusterClient
com.android.tradefed.cluster.IClusterClient |
An interface for interacting with the TFC backend.
Summary
Constants | |
---|---|
String |
TYPE_NAME
The unique configuration object type name. |
Public methods | |
---|---|
abstract
IClusterEventUploader<ClusterCommandEvent>
|
getCommandEventUploader()
Get a |
abstract
ClusterCommand.State
|
getCommandState(String requestId, String commandId)
Determine the state of a cluster command. |
default
ClusterCommandStatus
|
getCommandStatus(String requestId, String commandId)
Get the command status of a cluster command (the state and the cancel reason if canceled). |
abstract
IClusterEventUploader<ClusterHostEvent>
|
getHostEventUploader()
Get a |
abstract
TestContext
|
getTestContext(String requestId, String commandId)
|
abstract
TestEnvironment
|
getTestEnvironment(String requestId)
Get |
abstract
|
getTestResources(String requestId)
Get |
abstract
|
leaseHostCommands(String clusterId, String hostname,
Lease |
abstract
void
|
updateTestContext(String requestId, String commandId, TestContext testContext)
|
Constants
TYPE_NAME
public static final String TYPE_NAME
The unique configuration object type name. Used to retrieve the singleton instance from the
GlobalConfiguration
.
Constant Value: "cluster_client"
Public methods
getCommandEventUploader
public abstract IClusterEventUploader<ClusterCommandEvent> getCommandEventUploader ()
Get a IClusterEventUploader
that can be used to upload ClusterCommandEvent
s.
Returns | |
---|---|
IClusterEventUploader<ClusterCommandEvent> |
getCommandState
public abstract ClusterCommand.State getCommandState (String requestId, String commandId)
Determine the state of a cluster command.
Parameters | |
---|---|
requestId |
String : cluster request ID |
commandId |
String : cluster command ID |
Returns | |
---|---|
ClusterCommand.State |
cluster command's state, or ClusterCommand.State.UNKNOWN if state could not
be determined |
getCommandStatus
public ClusterCommandStatus getCommandStatus (String requestId, String commandId)
Get the command status of a cluster command (the state and the cancel reason if canceled).
Parameters | |
---|---|
requestId |
String : cluster request ID |
commandId |
String : cluster command ID |
Returns | |
---|---|
ClusterCommandStatus |
a ClusterCommandStatus that represents the state and the cancel reason if the command
is canceled. The state is ClusterCommand.State.UNKNOWN if it could not be
determined. |
getHostEventUploader
public abstract IClusterEventUploader<ClusterHostEvent> getHostEventUploader ()
Get a IClusterEventUploader
that can be used to upload ClusterHostEvent
s.
Returns | |
---|---|
IClusterEventUploader<ClusterHostEvent> |
getTestContext
public abstract TestContext getTestContext (String requestId, String commandId)
Parameters | |
---|---|
requestId |
String |
commandId |
String |
Returns | |
---|---|
TestContext |
Throws | |
---|---|
JSONException |
getTestEnvironment
public abstract TestEnvironment getTestEnvironment (String requestId)
Get TestEnvironment
for a request.
Returns | |
---|---|
TestEnvironment |
a TestEnvironment object. |
Throws | |
---|---|
|
IOException |
|
org.json.JSONException |
JSONException |
getTestResources
public abstractgetTestResources (String requestId)
Get TestResource
s for a request.
Returns | |
---|---|
|
a list of TestResource . |
Throws | |
---|---|
|
IOException |
|
org.json.JSONException |
JSONException |
leaseHostCommands
public abstractleaseHostCommands (String clusterId, String hostname, devices, nextClusterIds, int maxTasksTolease)
Lease ClusterCommand
for the give host.
Parameters | |
---|---|
clusterId |
String : cluster id for the host |
hostname |
String : hostname |
devices |
: deviceInfos the host has |
nextClusterIds |
: a list of next cluster IDs to lease commands from. |
maxTasksTolease |
int : the max number of tasks that can current be leased |
Returns | |
---|---|
|
a list of ClusterCommand |
Throws | |
---|---|
|
org.json.JSONException |
JSONException |
updateTestContext
public abstract void updateTestContext (String requestId, String commandId, TestContext testContext)
Parameters | |
---|---|
requestId |
String |
commandId |
String |
testContext |
TestContext |
Throws | |
---|---|
JSONException |