Agent Platform API (aiplatform:v1)

2026-09-04

10 new methods | 595 updated methods

Additions

    Methods

  • ▼ ▲ aiplatform.projects.locations.taskStores.operations.list

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations

      Parameters :

        pageSize

          Type : integer

          Location : query

          Format : int32

          Description : The standard list page size.

        name

          Location : path

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

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

          Type : string

          Required : Yes

        pageToken

          Description : The standard list page token.

          Type : string

          Location : query

        filter

          Description : The standard list filter.

          Type : string

          Location : query

        returnPartialSuccess

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

          Type : boolean

          Location : query

      Parameter Order : name

      Path : v1/{+name}/operations

      HTTP Method : GET

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform

  • ▼ ▲ aiplatform.projects.locations.taskStores.operations.cancel

      Parameter Order : name

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}: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

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

          Location : path

          Type : string

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

          Required : Yes

      Path : v1/{+name}:cancel

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform

  • ▼ ▲ aiplatform.projects.locations.taskStores.operations.wait

      Parameter Order : name

      Parameters :

        name

          Location : path

          Description : The name of the operation resource to wait on.

          Required : Yes

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

          Type : string

        timeout

          Location : query

          Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

          Format : google-duration

          Type : string

      HTTP Method : POST

      Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

      Path : v1/{+name}:wait

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}:wait

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform

  • ▼ ▲ aiplatform.projects.locations.taskStores.operations.delete

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}

      Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

      Path : v1/{+name}

      HTTP Method : DELETE

      Parameter Order : name

      Parameters :

        name

          Required : Yes

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

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

          Type : string

          Location : path

  • ▼ ▲ aiplatform.projects.locations.taskStores.operations.get

      Path : v1/{+name}

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform

      • Flat Path : v1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/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.

      HTTP Method : GET

      Parameter Order : name

      Parameters :

        name

          Location : path

          Type : string

          Description : The name of the operation resource.

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

          Required : Yes

  • ▼ ▲ aiplatform.taskStores.operations.cancel

      Parameter Order : name

      HTTP Method : POST

      Flat Path : v1/taskStores/{taskStoresId}/operations/{operationsId}:cancel

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform

      • Parameters :

        name

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

          Type : string

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

          Required : Yes

          Location : path

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

      Path : v1/{+name}:cancel

  • ▼ ▲ aiplatform.taskStores.operations.list

      Flat Path : v1/taskStores/{taskStoresId}/operations

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • 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`.

      Parameter Order : name

      Parameters :

        filter

          Location : query

          Type : string

          Description : The standard list filter.

        pageToken

          Description : The standard list page token.

          Type : string

          Location : query

        returnPartialSuccess

          Location : query

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

          Type : boolean

        pageSize

          Type : integer

          Location : query

          Description : The standard list page size.

          Format : int32

        name

          Pattern : ^taskStores/[^/]+$

          Type : string

          Required : Yes

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

          Location : path

      Path : v1/{+name}/operations

      HTTP Method : GET

  • ▼ ▲ aiplatform.taskStores.operations.get

      Parameter Order : name

      Path : v1/{+name}

      Flat Path : v1/taskStores/{taskStoresId}/operations/{operationsId}

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform

      • HTTP Method : GET

      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.

      Parameters :

        name

          Required : Yes

          Type : string

          Description : The name of the operation resource.

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

          Location : path

  • ▼ ▲ aiplatform.taskStores.operations.delete

      Parameter Order : name

      Flat Path : v1/taskStores/{taskStoresId}/operations/{operationsId}

      Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

      HTTP Method : DELETE

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

      Path : v1/{+name}

      Parameters :

        name

          Required : Yes

          Type : string

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

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

          Location : path

  • ▼ ▲ aiplatform.taskStores.operations.wait

      Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

      Path : v1/{+name}:wait

      Flat Path : v1/taskStores/{taskStoresId}/operations/{operationsId}:wait

      HTTP Method : POST

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform

      • Parameter Order : name

      Parameters :

        timeout

          Format : google-duration

          Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

          Location : query

          Type : string

        name

          Type : string

          Description : The name of the operation resource to wait on.

          Location : path

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

          Required : Yes

Updates