Method: processors.disable

Full name: projects.locations.processors.disable

Disables a processor

HTTP request

POST https://{endpoint}/v1/{name}:disable

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

Path parameters

Parameters
name

string

Required. The processor resource name to be disabled. It takes the form projects/{project}/locations/{location}/processors/{processor}.

Authorization requires the following IAM permission on the specified resource name:

  • documentai.processors.update

Request body

The request body must be empty.

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:

  • documentai.processors.update

For more information, see the IAM documentation.