Method: projects.testMatrices.cancel
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-25 UTC.
[null,null,["Last updated 2024-07-25 UTC."],[],[],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CancelTestMatrixResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nCancels 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.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist\n\nHTTP request\n\n`POST https://testing.googleapis.com/v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\nRequest body\n\nThe request body must be empty.\n\nResponse body Response containing the current state of the specified test matrix.\n\nIf successful, the response body contains data with the following structure:\n\nAuthorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
