Method: projects.locations.collections.engines.pause

Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*}:pause

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the engine to pause. Format: projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}

Request body

The request body must be empty.

Response body

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

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:

  • discoveryengine.engines.pause

For more information, see the IAM documentation.