Discovery Engine API (discoveryengine:v1)

Additions

Methods


• ▼ ▲ discoveryengine.projects.operations.cancel

  Path: v1/{+name}:cancel

  Flat Path: v1/projects/{projectsId}/operations/{operationsId}:cancel

  HTTP Method: POST

  Parameters:

  name

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

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  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`.

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel

  Path: v1/{+name}:cancel

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel

  HTTP Method: POST

  Parameters:

  name

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

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  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`.

• ▼ ▲ discoveryengine.projects.locations.dataStores.branches.operations.cancel

  Path: v1/{+name}:cancel

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel

  HTTP Method: POST

  Parameters:

  name

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

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  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`.

• ▼ ▲ discoveryengine.projects.locations.groundingConfigs.check

  Path: v1/{+groundingConfig}:check

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/groundingConfigs/{groundingConfigsId}:check

  HTTP Method: POST

  Parameters:

  groundingConfig

  Description: Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`.

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: groundingConfig

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

  Description: Performs a grounding check.