IRecorderClient

public interface IRecorderClient

com.android.tradefed.result.resultdb.IRecorderClient


Interface for communicating with ResultDB recorder backend. The interface contains methods to create and update work units and upload test results under work unit.

Summary

Public methods

abstract void enqueueArtifact(String workUnitId, Artifact artifact)

Enqueue an artifact to report to ResultDB.

abstract void enqueueTestResult(String workUnitId, TestResult result)

Enqueue a test result to report to ResultDB.

abstract void enqueueWorkUnit(String parentId, String id, WorkUnit workUnit)

Enqueue a work unit to report to ResultDB.

abstract void enqueueWorkUnitUpdate(WorkUnit workUnit, FieldMask updateMask)

Enqueue a work unit update to report to ResultDB.

abstract void finalizeUpload()

Finalize the upload of test results, artifacts and work units.

abstract void updateWorkUnit(WorkUnit workUnit, FieldMask updateMask)

Update a work unit in ResultDB.

abstract void uploadArtifact(String workUnitId, Artifact artifact)

Upload an artifact to ResultDB.

Public methods

enqueueArtifact

public abstract void enqueueArtifact (String workUnitId, 
                Artifact artifact)

Enqueue an artifact to report to ResultDB.

Parameters
workUnitId String: The work unit ID of the artifact.

artifact Artifact: The artifact to upload in the CreateArtifactRequest.

enqueueTestResult

public abstract void enqueueTestResult (String workUnitId, 
                TestResult result)

Enqueue a test result to report to ResultDB.

Parameters
workUnitId String: The work unit ID of the test result.

result TestResult: The test result to upload in the CreateTestResultRequest.

enqueueWorkUnit

public abstract void enqueueWorkUnit (String parentId, 
                String id, 
                WorkUnit workUnit)

Enqueue a work unit to report to ResultDB.

Parameters
parentId String: The parent ID of the work unit.

id String: The ID of the work unit.

workUnit WorkUnit: The work unit to upload in the CreateWorkUnitRequest.

enqueueWorkUnitUpdate

public abstract void enqueueWorkUnitUpdate (WorkUnit workUnit, 
                FieldMask updateMask)

Enqueue a work unit update to report to ResultDB.

Parameters
workUnit WorkUnit: The work unit to update in the UpdateWorkUnitRequest.

updateMask FieldMask: The field mask for the update.

finalizeUpload

public abstract void finalizeUpload ()

Finalize the upload of test results, artifacts and work units. This method should be called after all resources have been enqueued. Any enqueueXXX calls after this method will be ignored.

updateWorkUnit

public abstract void updateWorkUnit (WorkUnit workUnit, 
                FieldMask updateMask)

Update a work unit in ResultDB.

Parameters
workUnit WorkUnit: The work unit to update in the UpdateWorkUnitRequest.

updateMask FieldMask: The field mask for the update.

uploadArtifact

public abstract void uploadArtifact (String workUnitId, 
                Artifact artifact)

Upload an artifact to ResultDB.

Parameters
workUnitId String: The work unit ID of the artifact.

artifact Artifact: The artifact to upload in the CreateArtifactRequest.