Method: projects.locations.studies.trials.stop

Stops a Trial.

HTTP request

POST https://{service-endpoint}/v1/{name}:stop

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
name

string

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Trial.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.trials.update

For more information, see the IAM documentation.