Method: projects.locations.investigations.revisions.run

Run an existing revision of an investigation.

HTTP request

POST https://geminicloudassist.googleapis.com/v1alpha/{name=projects/*/locations/*/investigations/*/revisions/*}:run

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Run the investigation revision.

The revision to run, format: projects/{project}/locations/global/investigations/{investigation}/revisions/{revision}

Request body

The request body contains data with the following structure:

JSON representation
{
  "runParameters": {
    object (InvestigationRunParameters)
  },
  "updatedRevision": {
    object (InvestigationRevision)
  },
  "updateMask": string
}
Fields
runParameters

object (InvestigationRunParameters)

Optional. Parameters to pass through to Titan.

updatedRevision

object (InvestigationRevision)

Optional. Revision to update before running.

updateMask

string (FieldMask format)

Optional. The fields of the revision to update. Note that only user-writeable fields can be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

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.

IAM Permissions

Requires the following IAM permission on the name resource:

  • geminicloudassist.investigationRevisions.run

For more information, see the IAM documentation.

InvestigationRunParameters

Represents user parameters for running an investigation.

JSON representation
{
  "accessTokens": {
    string: string,
    ...
  }
}
Fields
accessTokens

map (key: string, value: string)

Optional. If populated, map of project to access token for TSE-triggered investigations.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.