2024-04-30
▼ ▲ aiplatform.projects.locations.agents.operations.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.
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Type: string
Description: The name of the operation resource.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.projects.locations.agents.operations.list
Parameter Order: name
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/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations
Path: v1beta1/{+name}/operations
Parameters:
pageSize
Format: int32
Location: query
Type: integer
Description: The standard list page size.
filter
Location: query
Type: string
Description: The standard list filter.
pageToken
Location: query
Description: The standard list page token.
Type: string
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type: string
Description: The name of the operation's parent resource.
Location: path
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.agents.operations.delete
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/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`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to be deleted.
Type: string
Required: Yes
HTTP Method: DELETE
Parameter Order: name
▼ ▲ aiplatform.projects.locations.agents.operations.cancel
Parameter Order: name
Path: v1beta1/{+name}:cancel
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to be cancelled.
Required: Yes
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: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.agents.operations.wait
Parameters:
timeout
Location: query
Format: google-duration
Type: string
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.
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$
Type: string
Required: Yes
Description: The name of the operation resource to wait on.
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.
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:wait
Path: v1beta1/{+name}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.apps.operations.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.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}
Path: v1beta1/{+name}
Parameter Order: name
Parameters:
name
Description: The name of the operation resource.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.projects.locations.apps.operations.cancel
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Location: path
Required: Yes
Type: string
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+name}: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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.apps.operations.delete
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: The name of the operation resource to be deleted.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$
Path: v1beta1/{+name}
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.apps.operations.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations
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
Path: v1beta1/{+name}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
name
Location: path
Required: Yes
Description: The name of the operation's parent resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
pageSize
Format: int32
Description: The standard list page size.
Location: query
Type: integer
filter
Location: query
Description: The standard list filter.
Type: string
pageToken
Location: query
Description: The standard list page token.
Type: string
▼ ▲ aiplatform.projects.locations.apps.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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:wait
Path: v1beta1/{+name}:wait
Parameter Order: name
Parameters:
timeout
Location: query
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.
Type: string
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$
Location: path
Type: string
Description: The name of the operation resource to wait on.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.extensions.deployments.operations.wait
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/deployments/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
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.
Format: google-duration
Type: string
Location: query
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/deployments/{deploymentsId}/operations/{operationsId}:wait
Path: v1beta1/{+name}:wait
▼ ▲ aiplatform.projects.locations.extensions.deployments.operations.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/deployments/{deploymentsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameters:
name
Description: The name of the operation resource to be deleted.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/deployments/[^/]+/operations/[^/]+$
Path: v1beta1/{+name}
Parameter Order: name
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`.
▼ ▲ aiplatform.projects.locations.extensions.deployments.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/deployments/{deploymentsId}/operations
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
HTTP Method: GET
Parameters:
pageToken
Type: string
Description: The standard list page token.
Location: query
name
Location: path
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/deployments/[^/]+$
Required: Yes
Type: string
filter
Type: string
Location: query
Description: The standard list filter.
pageSize
Type: integer
Format: int32
Location: query
Description: The standard list page size.
Path: v1beta1/{+name}/operations
▼ ▲ aiplatform.projects.locations.extensions.deployments.operations.get
HTTP Method: GET
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/deployments/{deploymentsId}/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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Description: The name of the operation resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/deployments/[^/]+/operations/[^/]+$
Location: path
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.extensions.deployments.operations.cancel
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/deployments/[^/]+/operations/[^/]+$
Type: string
Required: Yes
Description: The name of the operation resource to be cancelled.
Path: v1beta1/{+name}: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`.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/deployments/{deploymentsId}/operations/{operationsId}:cancel
HTTP Method: POST