2024-06-18
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.operations.wait
Path: v1/{+name}:wait
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$
Type: string
Required: Yes
Location: path
Description: The name of the operation resource to wait on.
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.
Location: query
Type: string
Format: google-duration
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait
Parameter Order: name
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.operations.cancel
Parameter Order: name
Parameters:
name
Location: path
Description: The name of the operation resource to be cancelled.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$
Required: Yes
Path: v1/{+name}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
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`.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Required: Yes
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
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
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Type: integer
Format: int32
Description: The standard list page size.
Location: query
filter
Description: The standard list filter.
Type: string
Location: query
name
Location: path
Description: The name of the operation's parent resource.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$
pageToken
Type: string
Description: The standard list page token.
Location: query
Parameter Order: name
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.operations.delete
Path: v1/{+name}
Parameter Order: name
HTTP Method: DELETE
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
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.notebookRuntimeTemplates.operations.cancel
Path: v1/{+name}: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`.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Required: Yes
Description: The name of the operation resource to be cancelled.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.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
Type: string
Required: Yes
Description: The name of the operation resource to wait on.
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$
Location: path
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
HTTP Method: POST
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.operations.get
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}
Path: v1/{+name}
Parameters:
name
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
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.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.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`.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}
Parameters:
name
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$
Type: string
Location: path
Required: Yes
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.operations.list
HTTP Method: GET
Parameter Order: name
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations
Parameters:
pageSize
Type: integer
Description: The standard list page size.
Location: query
Format: int32
filter
Location: query
Type: string
Description: The standard list filter.
name
Description: The name of the operation's parent resource.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
Required: Yes
pageToken
Location: query
Type: string
Description: The standard list page token.
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`.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.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: v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait
Parameter Order: name
Parameters:
timeout
Type: string
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
name
Description: The name of the operation resource to wait on.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:wait
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.notebookRuntimes.operations.get
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Description: The name of the operation resource.
HTTP Method: GET
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}
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.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.operations.cancel
Path: v1/{+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`.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel
Parameters:
name
Location: path
Required: Yes
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$
Type: string
Parameter Order: name
▼ ▲ aiplatform.projects.locations.notebookRuntimes.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters:
name
Location: path
Required: Yes
Type: string
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
pageSize
Type: integer
Location: query
Format: int32
Description: The standard list page size.
pageToken
Description: The standard list page token.
Type: string
Location: query
filter
Type: string
Description: The standard list filter.
Location: query
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations
Path: v1/{+name}/operations
Parameter Order: name
▼ ▲ aiplatform.projects.locations.notebookRuntimes.operations.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
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
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Description: The name of the operation resource to be deleted.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}
Parameter Order: name
Path: v1/{+name}