Cloud Document AI API (documentai:v1)

Deletions

Methods


• ▼ ▲ documentai.uiv1beta3.projects.locations.operations.get

  Path: uiv1beta3/{+name}

  HTTP Method: GET

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

  Parameter Order: name

  Parameters:

  name

  Location: path

  Required: Yes

  Type: string

  Description: The name of the operation resource.

  Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

  Flat Path: uiv1beta3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

  Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

• ▼ ▲ documentai.uiv1beta3.projects.locations.operations.cancel

  Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

  Parameters:

  name

  Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Description: The name of the operation resource to be cancelled.

  Parameter Order: name

  HTTP Method: POST

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

  Flat Path: uiv1beta3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

  Path: uiv1beta3/{+name}:cancel

• ▼ ▲ documentai.uiv1beta3.projects.locations.operations.list

  Flat Path: uiv1beta3/projects/{projectsId}/locations/{locationsId}/operations

  Path: uiv1beta3/{+name}

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

  Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

  Parameter Order: name

  HTTP Method: GET

  Parameters:

  name

  Pattern: ^projects/[^/]+/locations/[^/]+/operations$

  Type: string

  Required: Yes

  Description: The name of the operation's parent resource.

  Location: path

  pageToken

  Description: The standard list page token.

  Location: query

  Type: string

  filter

  Location: query

  Description: The standard list filter.

  Type: string

  pageSize

  Type: integer

  Format: int32

  Description: The standard list page size.

  Location: query

• ▼ ▲ documentai.uiv1beta3.projects.locations.list

  Flat Path: uiv1beta3/projects/{projectsId}/locations

  Parameter Order: name

  HTTP Method: GET

  Parameters:

  filter

  Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

  Type: string

  Location: query

  pageSize

  Description: The maximum number of results to return. If not set, the service selects a default.

  Format: int32

  Location: query

  Type: integer

  name

  Location: path

  Pattern: ^projects/[^/]+$

  Type: string

  Description: The resource that owns the locations collection, if applicable.

  Required: Yes

  pageToken

  Type: string

  Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

  Location: query

  Description: Lists information about the supported locations for this service.

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

  Path: uiv1beta3/{+name}/locations

• ▼ ▲ documentai.uiv1beta3.projects.locations.get

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

  HTTP Method: GET

  Description: Gets information about a location.

  Flat Path: uiv1beta3/projects/{projectsId}/locations/{locationsId}

  Parameter Order: name

  Path: uiv1beta3/{+name}

  Parameters:

  name

  Location: path

  Required: Yes

  Description: Resource name for the location.

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+$