2026-10-31
▼ ▲ aiplatform.projects.locations.collaborativeProjects.operations.wait
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+/operations/[^/]+$
Description : The name of the operation resource to wait on.
Type : string
Required : Yes
timeout
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.
Type : string
Location : query
Format : google-duration
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}/operations/{operationsId}:wait
HTTP Method : POST
Scopes :
Path : v1beta1/{+name}: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.
▼ ▲ aiplatform.projects.locations.collaborativeProjects.operations.get
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}/operations/{operationsId}
Parameters :
name
Location : path
Description : The name of the operation resource.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+/operations/[^/]+$
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.
Parameter Order : name
Path : v1beta1/{+name}
Scopes :
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.collaborativeProjects.operations.cancel
HTTP Method : POST
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`.
Scopes :
Parameters :
name
Type : string
Required : Yes
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+/operations/[^/]+$
Location : path
Path : v1beta1/{+name}:cancel
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.collaborativeProjects.operations.delete
Parameter Order : name
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}/operations/{operationsId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be deleted.
Required : Yes
Location : path
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
▼ ▲ aiplatform.projects.locations.agents.tasks.stream
Parameter Order : name
HTTP Method : GET
Description : Read-only server-stream of a task's execution by id: trajectory steps and status changes, resumable from a step sequence number. Unlike CreateTaskBidiStream, it does not accept client inputs -- use it to observe or replay a task (the trajectory is not stored on the Task resource). This is the entry point for *observers*: it tails the trajectory from interaction storage without restoring the runtime actor, so it adds no restore latency and continues to follow output that a participant driving the task on a CreateTaskBidiStream connection produces. Observe-only clients should prefer this over a subscribe_task connect on CreateTaskBidiStream, which restores the actor and is meant for clients that will send input.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:stream
Path : v1beta1/{+name}:stream
Parameters :
continuationToken
Description : Optional. Opaque resume cursor, as issued on TaskServerEvent.continuation_token. Replay continues immediately after the event that carried the token. Takes precedence over next_step_seq_num when both are set. A malformed token, or one whose position does not exist on this task, is rejected with INVALID_ARGUMENT rather than silently falling back to the numeric cursor, so a client cannot mistake a rejected resume for a replay from the start.
Type : string
Location : query
snapshot
Location : query
Description : Optional. If true, streams only the events produced up to the current point in time and terminates the stream once all existing events are sent, rather than tailing and waiting for future events.
Type : boolean
nextStepSeqNum
Location : query
Type : string
Format : int64
Description : Optional. The next step sequence number to resume from. When zero, streams from the beginning of the available trajectory.
name
Required : Yes
Description : Required. The name of the task to stream. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Scopes :
▼ ▲ aiplatform.projects.locations.agents.tasks.cancel
Scopes :
Parameter Order : name
Path : v1beta1/{+name}:cancel
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Location : path
Description : Required. The name of the task to cancel. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}
Required : Yes
Deprecated : Yes
Description : Deprecated: use `CancelTaskLro` instead. This method keeps the same cancellation semantics but returns `Task` directly, which forecloses the future cascade behaviour on recurring parents that only an `Operation` return type can express. Cancels a task, out-of-band by id. Drains any in-progress work and moves the task to CANCELLED. Use this when there is no active stream (e.g. a scheduled or background task) or when a caller other than the streaming client cancels. A task may also be cancelled in-band via the bidi cancel_task end_request; the two paths are equivalent. Cancellation semantics: * Idempotent: cancelling an already-terminal task is a no-op that returns the current Task; concurrent/duplicate cancels collapse to one CANCELLED. * First terminal state wins: once the task is CANCELLED/COMPLETED/FAILED, later cancels have no effect. * Cancel takes precedence over complete_task: a cancel arriving while (or after) a client half-closes with complete_task still drives the task to CANCELLED rather than letting it finish.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:cancel
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.agents.tasks.suspend
Path : v1beta1/{+name}:suspend
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:suspend
Scopes :
Parameters :
name
Description : Required. The name of the task to suspend. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Type : string
Required : Yes
Parameter Order : name
Description : Suspends a task, pausing its active turn or scheduling loop and transitioning the status to SUSPENDED. The underlying runtime session remains resumable.
▼ ▲ aiplatform.projects.locations.agents.tasks.resume
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:resume
Parameter Order : name
Scopes :
Path : v1beta1/{+name}:resume
HTTP Method : POST
Description : Resumes a suspended task, transitioning it back to an active state (WORKING or QUEUED).
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Required : Yes
Type : string
Description : Required. The name of the task to resume. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}
Location : path
▼ ▲ aiplatform.projects.locations.agents.tasks.patch
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}
Scopes :
Parameter Order : name
Path : v1beta1/{+name}
HTTP Method : PATCH
Description : Updates a task's mutable fields (e.g. schedule, priority, title). Typically allowed while the task is IDLE.
Parameters :
name
Description : Identifier. Resource name of the task.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Location : path
updateMask
Location : query
Description : Required. The list of fields to update.
Type : string
Format : google-fieldmask
▼ ▲ aiplatform.projects.locations.agents.tasks.list
Scopes :
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks
Path : v1beta1/{+parent}/tasks
Parameter Order : parent
Parameters :
pageSize
Type : integer
Location : query
Description : Optional. The maximum number of tasks to return. The service may return fewer. If unspecified (or <= 0), at most 50 are returned. The maximum is 100; larger values are capped to 100.
Format : int32
orderBy
Description : Optional. Sort order, e.g. "create_time desc".
Location : query
Type : string
filter
Description : Optional. A filter expression, e.g. "status=WORKING". Lineage filters pick how much of a task tree to fetch: * "parent_task_id=" -- direct children only (progressive disclosure, one level per call). * "root_task_id=" -- the whole tree in one flat collection. Label filters support filtering by task labels: * "labels.=" -- match tasks with the given label key and value. Multiple label filters can be combined with AND. Multiple values for the same key can be combined with OR, e.g., "labels.foo=bar OR labels.foo=baz". Status filters restrict the listing to tasks in the given statuses: * "status=" -- e.g. "status=WORKING". Multiple statuses can be combined with OR, e.g., "status=WORKING OR status=IDLE". Both page normally via `page_size`/`page_token`, and both are ordered by `order_by` (default "create_time asc"), not by tree shape. A whole-tree page is therefore not a subtree: a child can arrive before its parent, so the client buffers by `parent_task_id` and renders as parents resolve.
Location : query
Type : string
pageToken
Location : query
Description : Optional. A page token from a previous ListTasks call.
Type : string
parent
Description : Required. The parent to list tasks under. Both forms are accepted and scope the listing differently: * projects/{project}/locations/{location}/agents/{agent} -- tasks assigned to that agent. * projects/{project}/locations/{location} -- all tasks in the location.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Type : string
Description : Lists tasks under a parent. Supports filtering (e.g. by status or assigned_agent) so a surface can show "my tasks".
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.agents.tasks.delete
HTTP Method : DELETE
Scopes :
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}
Description : Deletes a task. Long-running because deletion cascades: it cancels any active run (WORKING / REQUIRES_ACTION / SUSPENDED tasks are cancelled-then-deleted, not rejected), and cleans up the task's bound resources -- environment, generated artifacts, and the runtime trajectory/sessions. The operation completes when the cascade finishes; on success the response is google.protobuf.Empty.
Parameters :
operateOnSelf
Description : Optional. Whether to skip cascading deletion to all descendant subtasks. Defaults to false (cascades to all descendants by default). Matches google.cloud.aiplatform.master.CancelTaskRequest.operate_on_self. Behavior: UNSET or false ⇒ cascade: delete this task and every non-terminal descendant (gated by Mendel flag sobi_enable_cascading_delete_task; returns FAILED_PRECONDITION when the flag is OFF and the task has non-terminal children). true ⇒ delete this task only. Each descendant deletion signals the runtime for the live-session case (Actor.OnCancel finalizes trajectory + reclaims sandbox VM) before removing the Sobi DB rows, matching the single-DeleteTask contract.
Type : boolean
Location : query
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Location : path
Description : Required. The name of the task to delete. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}
Required : Yes
Path : v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.agents.tasks.get
HTTP Method : GET
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Type : string
Location : path
Description : Required. The name of the task to retrieve. Both name forms are accepted: * projects/{project}/locations/{location}/agents/{agent}/tasks/{task} * projects/{project}/locations/{location}/tasks/{task}
Description : Gets a task.
Scopes :
Path : v1beta1/{+name}
Parameter Order : name
▼ ▲ aiplatform.projects.locations.agents.tasks.create
Scopes :
Path : v1beta1/{+parent}/tasks
Parameters :
userContext.channel
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Optional. How the user's input reached the agent. Leave unset when the user talks to the agent directly in an AI-native interface.
uniqueCreationToken
Description : Optional. Optional idempotency token to guarantee the task is created only once. Suggest a UUID. A create carrying a token that a live task of the same agent already holds fails with `ALREADY_EXISTS`, naming that task in the response. The token is free again once that task finishes.
Location : query
Type : string
parent
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type : string
Description : Required. The parent agent that owns this task. Format: projects/{project}/locations/{location}/agents/{agent}
userContext.location
Type : string
Location : query
Description : Optional. The user's coarse, human-readable location, e.g. "Mountain View, CA, US". Must be no more precise than city level; never send street addresses, postal codes, or coordinates. The agent uses it for location-dependent requests, e.g. weather or nearby places.
userContext.timeZone
Description : Optional. The user's IANA time zone name, e.g. "America/Los_Angeles". The agent uses it to interpret and present dates and times, e.g. to resolve "tomorrow morning".
Location : query
Type : string
Description : Creates a task without opening a live channel. Convenient for scheduled/background tasks where the caller does not need to drive the execution interactively; observe progress later via StreamTask (or by reconnecting to CreateTaskBidiStream with a `subscribe_task` request).
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.agents.tasks.uploadArtifact
Parameter Order : task
Path : v1beta1/{+task}:uploadArtifact
Description : Uploads a file into a task's workspace. A client-streaming RPC: the request body is the file's raw bytes, relayed to storage a chunk at a time, so neither ESF nor this server holds the whole file. A broken connection restarts the upload from zero. `path` must be an absolute path under `/workspace/userdata/`. The task must not be in a terminal state. An existing file at `path` is replaced. At most 1 GiB.
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:uploadArtifact
Scopes :
Parameters :
task
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Description : Required. The task to upload into. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}
Location : path
Type : string
Required : Yes
path
Description : Required. Absolute destination path, e.g. "/workspace/userdata/input.csv". Must be under "/workspace/userdata/" and at most 1024 characters; relative paths and paths containing a ".." segment are rejected with INVALID_ARGUMENT.
Type : string
Location : query
▼ ▲ aiplatform.projects.locations.agents.tasks.deleteArtifact
Path : v1beta1/{+task}:deleteArtifact
Description : Deletes a file from a task's workspace. `path` must be an absolute path to a file under `/workspace/userdata/` (for example, `/workspace/userdata/input.csv`). Paths outside `/workspace/userdata/`, `/workspace/userdata` itself, relative paths, or paths with `.` or `..` segments fail with `INVALID_ARGUMENT`. Directory paths and tasks in a terminal state fail with `FAILED_PRECONDITION`. A missing file fails with `NOT_FOUND` unless `allow_missing` is true, in which case the call succeeds with an empty response.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:deleteArtifact
HTTP Method : POST
Scopes :
Parameter Order : task
Parameters :
task
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Required : Yes
Description : Required. The task to delete from. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}
Location : path
Type : string
▼ ▲ aiplatform.projects.locations.agents.tasks.listArtifacts
Path : v1beta1/{+task}:listArtifacts
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:listArtifacts
HTTP Method : GET
Scopes :
Parameter Order : task
Description : Lists the files in a task's workspace. By default only the immediate children of `path` are returned; set `recursive` to descend into subdirectories. Entries are returned in breadth-first order. While the task's sandbox is running, paths it writes locally are read from the sandbox so the listing reflects files not yet synced to storage; otherwise they are read from storage. Which one served a request is not visible to the caller.
Parameters :
pageToken
Location : query
Type : string
Description : Optional. A page token from a previous ListTaskArtifacts call. The workspace is live: the agent can write between pages, so a paged listing is not a snapshot. An entry added during the walk may or may not appear, and one removed may still be listed and then fail to download.
task
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Location : path
Description : Required. The task whose workspace to list. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}
Type : string
Required : Yes
pageSize
Format : int32
Location : query
Description : Optional. The maximum number of entries to return. The service may return fewer. If unspecified (or <= 0), at most 100 are returned. The maximum is 1000; larger values are capped to 1000.
Type : integer
recursive
Description : Optional. If true, descends into subdirectories. Results are breadth-first.
Type : boolean
Location : query
path
Location : query
Description : Optional. Absolute path of the directory to list, e.g. "/workspace/userdata". Must be "/workspace" or under it, at most 1024 characters, and not contain a ".." segment. Defaults to "/workspace".
Type : string
▼ ▲ aiplatform.projects.locations.agents.tasks.downloadArtifact
Description : Downloads a file from a task's workspace as a stream of chunks. A server-streaming RPC. The response body is the file's raw bytes, with the file's own media type as the `Content-Type`. At most 1 GiB. Like ListTaskArtifacts, reads from the running sandbox when there is one, so a file the agent has just written is returned even before it reaches storage.
Parameters :
path
Location : query
Type : string
Description : Required. Absolute path of the file to read, e.g. "/workspace/report.md". Must be under "/workspace", at most 1024 characters, and not contain a ".." segment.
task
Required : Yes
Description : Required. The task to download from. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Type : string
processingConfig.outputMimeType
Description : Required. The media type to return: * `application/pdf`: the file as a PDF, e.g. a .docx or .pptx. * `application/json`: a spreadsheet, e.g. a .xlsx, as JSON describing its sheets and cells, from which a client draws the workbook as a grid. Any other value fails with `INVALID_ARGUMENT`.
Location : query
Type : string
Parameter Order : task
Scopes :
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:downloadArtifact
HTTP Method : GET
Path : v1beta1/{+task}:downloadArtifact
▼ ▲ aiplatform.projects.locations.tasks.list
Parameters :
pageToken
Type : string
Location : query
Description : Optional. A page token from a previous ListTasks call.
filter
Description : Optional. A filter expression, e.g. "status=WORKING". Lineage filters pick how much of a task tree to fetch: * "parent_task_id=" -- direct children only (progressive disclosure, one level per call). * "root_task_id=" -- the whole tree in one flat collection. Label filters support filtering by task labels: * "labels.=" -- match tasks with the given label key and value. Multiple label filters can be combined with AND. Multiple values for the same key can be combined with OR, e.g., "labels.foo=bar OR labels.foo=baz". Status filters restrict the listing to tasks in the given statuses: * "status=" -- e.g. "status=WORKING". Multiple statuses can be combined with OR, e.g., "status=WORKING OR status=IDLE". Both page normally via `page_size`/`page_token`, and both are ordered by `order_by` (default "create_time asc"), not by tree shape. A whole-tree page is therefore not a subtree: a child can arrive before its parent, so the client buffers by `parent_task_id` and renders as parents resolve.
Type : string
Location : query
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. The maximum number of tasks to return. The service may return fewer. If unspecified (or <= 0), at most 50 are returned. The maximum is 100; larger values are capped to 100.
parent
Description : Required. The parent to list tasks under. Both forms are accepted and scope the listing differently: * projects/{project}/locations/{location}/agents/{agent} -- tasks assigned to that agent. * projects/{project}/locations/{location} -- all tasks in the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Required : Yes
orderBy
Description : Optional. Sort order, e.g. "create_time desc".
Type : string
Location : query
Scopes :
Parameter Order : parent
Path : v1beta1/{+parent}/tasks
HTTP Method : GET
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tasks
Description : Lists tasks under a parent. Supports filtering (e.g. by status or assigned_agent) so a surface can show "my tasks".
▼ ▲ aiplatform.projects.locations.tasks.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/tasks/[^/]+$
Required : Yes
Type : string
Description : Required. The name of the task to retrieve. Both name forms are accepted: * projects/{project}/locations/{location}/agents/{agent}/tasks/{task} * projects/{project}/locations/{location}/tasks/{task}
Location : path
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tasks/{tasksId}
Parameter Order : name
HTTP Method : GET
Description : Gets a task.
Scopes :
▼ ▲ aiplatform.collaborativeProjects.operations.delete
Parameter Order : name
HTTP Method : DELETE
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`.
Flat Path : v1beta1/collaborativeProjects/{collaborativeProjectsId}/operations/{operationsId}
Parameters :
name
Location : path
Pattern : ^collaborativeProjects/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Description : The name of the operation resource to be deleted.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
▼ ▲ aiplatform.collaborativeProjects.operations.wait
Parameter Order : name
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.
Scopes :
HTTP Method : POST
Flat Path : v1beta1/collaborativeProjects/{collaborativeProjectsId}/operations/{operationsId}:wait
Path : v1beta1/{+name}:wait
Parameters :
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
name
Location : path
Type : string
Pattern : ^collaborativeProjects/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource to wait on.
▼ ▲ aiplatform.collaborativeProjects.operations.get
Parameter Order : name
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
Flat Path : v1beta1/collaborativeProjects/{collaborativeProjectsId}/operations/{operationsId}
Parameters :
name
Required : Yes
Description : The name of the operation resource.
Location : path
Pattern : ^collaborativeProjects/[^/]+/operations/[^/]+$
Type : string
Path : v1beta1/{+name}
Scopes :
▼ ▲ aiplatform.collaborativeProjects.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`.
HTTP Method : POST
Flat Path : v1beta1/collaborativeProjects/{collaborativeProjectsId}/operations/{operationsId}:cancel
Path : v1beta1/{+name}:cancel
Parameters :
name
Pattern : ^collaborativeProjects/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource to be cancelled.
Type : string
Location : path
Parameter Order : name
Scopes :
▼ ▲ aiplatform.projects.locations.agents.create
Parameters :
idpNonce
Type : string
Description : Optional. Optional. One-time cryptographic nonce issued by the trusted IdP provisioning iframe for session and device non-repudiation.
Location : query