IClusterOptions
  public
  
  
  
  interface
  IClusterOptions
  
  
  
| com.android.tradefed.cluster.IClusterOptions | 
An interface for getting cluster-related options.
Summary
| Public methods | |
|---|---|
| 
        abstract
        
        
        
        
        boolean | 
      checkCommandState()
      Whether the command state (on the TF cluster) should be checked during heartbeat. | 
| 
        abstract
        
        
        
        
        boolean | 
      checkPermitsOnLease()
      Check some available permits before leasing. | 
| 
        abstract
        
        
        
        
        String | 
      getClusterId()
      Get the cluster id for this TF instance. | 
| 
        abstract
        
        
        
        
        int | 
      getConnectTimeout()
      Get http connect timeout. | 
| 
        abstract
        
        
        
        
        MultiMap<String, String> | 
      getDeviceGroup()
      Get the device group to device mapping. | 
| 
        abstract
        
        
        
        
        long | 
      getDeviceMonitorSnapshotInterval()
      Get the time interval between each device snapshot in ms. | 
| 
        abstract
        
        
        
        
         | 
      getDeviceTag()
      Get the device serial to tag mapping. | 
| 
        abstract
        
        
        
        
        long | 
      getInvocationHeartbeatInterval()
      Get the time interval between invocation heartbeats in ms. | 
| 
        abstract
        
        
        
        
        String | 
      getLabName()
      Get the name of the lab the host belong to. | 
| 
        abstract
        
        
        
        
         | 
      getLabels()
      Get labels for the host. | 
| 
        abstract
        
        
        
        
         | 
      getNextClusterIds()
      Get the secondary cluster ids for this TF instance. | 
| 
        abstract
        
        
        
        
        int | 
      getReadTimeout()
      Get http read timeout. | 
| 
        abstract
        
        
        
        
        String | 
      getRunTargetFormat()
      Get the format for labelling run targets. | 
| 
        abstract
        
        
        
        
        File | 
      getSchedulerServiceAccountKeyfile()
      Get the tradefed test scheduler service account key file. | 
| 
        abstract
        
        
        
        
        String | 
      getSchedulerServiceUrl()
      Get the tradefed test scheduler service URL. | 
| 
        abstract
        
        
        
        
        String | 
      getServiceUrl()
      Get the base url of the tradefed cluster REST API. | 
| 
        abstract
        
        
        
        
        boolean | 
      isDeviceMonitorDisabled()
      Returns whether Cluster device reporting is disabled. | 
| 
        abstract
        
        
        
        
        long | 
      maxDiskUsagePercentage()
      Maximal disk usage percentage before we stop leasing additional new tasks. | 
| 
        abstract
        
        
        
        
        boolean | 
      shouldCollectEarlyTestSummary()
      Returns whether scheduler should collect early test summary. | 
| 
        abstract
        
        
        
        
        Boolean | 
      shouldUploadInvocationStatus()
      Returns whether TF should upload invocation status. | 
Public methods
checkCommandState
public abstract boolean checkCommandState ()
Whether the command state (on the TF cluster) should be checked during heartbeat.
| Returns | |
|---|---|
| boolean | |
checkPermitsOnLease
public abstract boolean checkPermitsOnLease ()
Check some available permits before leasing.
| Returns | |
|---|---|
| boolean | |
getClusterId
public abstract String getClusterId ()
Get the cluster id for this TF instance.
| Returns | |
|---|---|
| String | |
getConnectTimeout
public abstract int getConnectTimeout ()
Get http connect timeout.
| Returns | |
|---|---|
| int | |
getDeviceGroup
public abstract MultiMap<String, String> getDeviceGroup ()
Get the device group to device mapping.
| Returns | |
|---|---|
| MultiMap<String, String> | |
getDeviceMonitorSnapshotInterval
public abstract long getDeviceMonitorSnapshotInterval ()
Get the time interval between each device snapshot in ms.
| Returns | |
|---|---|
| long | |
getDeviceTag
public abstractgetDeviceTag () 
Get the device serial to tag mapping.
| Returns | |
|---|---|
|  | |
getInvocationHeartbeatInterval
public abstract long getInvocationHeartbeatInterval ()
Get the time interval between invocation heartbeats in ms.
| Returns | |
|---|---|
| long | |
getLabName
public abstract String getLabName ()
Get the name of the lab the host belong to.
| Returns | |
|---|---|
| String | |
getLabels
public abstractgetLabels () 
Get labels for the host.
| Returns | |
|---|---|
|  | |
getNextClusterIds
public abstractgetNextClusterIds () 
Get the secondary cluster ids for this TF instance.
| Returns | |
|---|---|
|  | |
getReadTimeout
public abstract int getReadTimeout ()
Get http read timeout.
| Returns | |
|---|---|
| int | |
getRunTargetFormat
public abstract String getRunTargetFormat ()
Get the format for labelling run targets.
| Returns | |
|---|---|
| String | |
getSchedulerServiceAccountKeyfile
public abstract File getSchedulerServiceAccountKeyfile ()
Get the tradefed test scheduler service account key file.
| Returns | |
|---|---|
| File | |
getSchedulerServiceUrl
public abstract String getSchedulerServiceUrl ()
Get the tradefed test scheduler service URL.
| Returns | |
|---|---|
| String | |
getServiceUrl
public abstract String getServiceUrl ()
Get the base url of the tradefed cluster REST API.
| Returns | |
|---|---|
| String | |
isDeviceMonitorDisabled
public abstract boolean isDeviceMonitorDisabled ()
Returns whether Cluster device reporting is disabled.
| Returns | |
|---|---|
| boolean | |
maxDiskUsagePercentage
public abstract long maxDiskUsagePercentage ()
Maximal disk usage percentage before we stop leasing additional new tasks.
| Returns | |
|---|---|
| long | |
shouldCollectEarlyTestSummary
public abstract boolean shouldCollectEarlyTestSummary ()
Returns whether scheduler should collect early test summary.
| Returns | |
|---|---|
| boolean | |
shouldUploadInvocationStatus
public abstract Boolean shouldUploadInvocationStatus ()
Returns whether TF should upload invocation status.
| Returns | |
|---|---|
| Boolean | |
