Method: projects.locations.catalogs.models.pause

Pauses the training of an existing model.

HTTP request

POST https://retail.googleapis.com/v2beta/{name=projects/*/locations/*/catalogs/*/models/*}:pause

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the model to pause. Format: projects/{projectNumber}/locations/{locationId}/catalogs/{catalogId}/models/{modelId}

Request body

The request body must be empty.

Response body

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

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:

  • retail.models.pause

For more information, see the IAM documentation.