Method: labsExperiments.execute

Full name: projects.locations.instances.labsExperiments.execute

Executes a LabsExperiment. This initiates an asynchronous execution run for the specified experiment with the given payload. The response contains the initial state of the execution resource, including its ID for status tracking.

HTTP request


Path parameters

Parameters
parent

string

Required. The unique identifier of the Experiment definition to execute.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "context": {
    object (LabsExperimentExecutionContext)
  },
  "executionId": string
}
Fields
context

object (LabsExperimentExecutionContext)

Required. The input payload provided by the user when initiating the execution. Stored as a generic Struct for flexibility. The specific structure exists in the existing service implementation.
executionId

string

Optional. The unique identifier of the execution. If not provided, a random UUID will be generated.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.