Method: projects.testMatrices.cancel

Cancels unfinished test executions in a test matrix. This call returns immediately and cancellation proceeds asynchronously. If the matrix is already final, this operation will have no effect.

May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to read project
  • INVALID_ARGUMENT - if the request is malformed
  • NOT_FOUND - if the Test Matrix does not exist

HTTP request

POST https://testing.googleapis.com/v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

Cloud project that owns the test.

testMatrixId

string

Test matrix that will be canceled.

Request body

The request body must be empty.

Response body

Response containing the current state of the specified test matrix.

If successful, the response body contains data with the following structure:

JSON representation
{
  "testState": enum (TestState)
}
Fields
testState

enum (TestState)

The current rolled-up state of the test matrix. If this state is already final, then the cancelation request will have no effect.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.