2025-10-28
▼ ▲ aiplatform.endpoints.operations.get
Parameters :
name
Pattern : ^endpoints/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource.
Required : Yes
Type : string
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 : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/endpoints/{endpointsId}/operations/{operationsId}
Parameter Order : name
▼ ▲ aiplatform.endpoints.operations.list
Parameter Order : name
Flat Path : v1/endpoints/{endpointsId}/operations
Path : v1/{+name}/operations
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
Pattern : ^endpoints/[^/]+$
Description : The name of the operation's parent resource.
Type : string
Required : Yes
pageSize
Location : query
Type : integer
Format : int32
Description : The standard list page size.
returnPartialSuccess
Location : query
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
filter
Description : The standard list filter.
Location : query
Type : string
pageToken
Location : query
Type : string
Description : The standard list page token.
HTTP Method : GET
▼ ▲ aiplatform.endpoints.operations.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 : v1/endpoints/{endpointsId}/operations/{operationsId}
Parameter Order : name
Parameters :
name
Location : path
Type : string
Pattern : ^endpoints/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Required : Yes
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
▼ ▲ aiplatform.endpoints.operations.wait
HTTP Method : POST
Path : v1/{+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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Pattern : ^endpoints/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Location : path
Description : The name of the operation resource to wait on.
timeout
Type : string
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.
Flat Path : v1/endpoints/{endpointsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.endpoints.operations.cancel
HTTP Method : POST
Parameters :
name
Type : string
Location : path
Pattern : ^endpoints/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/endpoints/{endpointsId}/operations/{operationsId}: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`.
Parameter Order : name
▼ ▲ aiplatform.schedules.operations.cancel
Parameters :
name
Pattern : ^schedules/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Required : Yes
Location : path
Type : string
Path : v1/{+name}:cancel
Flat Path : v1/schedules/{schedulesId}/operations/{operationsId}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
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
▼ ▲ aiplatform.schedules.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/schedules/{schedulesId}/operations/{operationsId}:wait
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^schedules/[^/]+/operations/[^/]+$
Description : The name of the operation resource to wait on.
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
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+name}:wait
Parameter Order : name
▼ ▲ aiplatform.schedules.operations.list
Parameters :
name
Required : Yes
Description : The name of the operation's parent resource.
Location : path
Type : string
Pattern : ^schedules/[^/]+$
pageSize
Format : int32
Type : integer
Location : query
Description : The standard list page size.
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Location : query
pageToken
Type : string
Description : The standard list page token.
Location : query
filter
Description : The standard list filter.
Location : query
Type : string
Flat Path : v1/schedules/{schedulesId}/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
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}/operations
HTTP Method : GET
▼ ▲ aiplatform.schedules.operations.delete
HTTP Method : DELETE
Parameter Order : name
Flat Path : v1/schedules/{schedulesId}/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
Location : path
Pattern : ^schedules/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource to be deleted.
Type : string
Path : v1/{+name}
▼ ▲ aiplatform.schedules.operations.get
Parameter Order : name
Flat Path : v1/schedules/{schedulesId}/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.
Parameters :
name
Required : Yes
Description : The name of the operation resource.
Pattern : ^schedules/[^/]+/operations/[^/]+$
Type : string
Location : path
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ aiplatform.ragEngineConfig.operations.list
HTTP Method : GET
Flat Path : v1/ragEngineConfig/operations
Path : v1/{+name}/operations
Parameter Order : name
Parameters :
name
Location : path
Description : The name of the operation's parent resource.
Required : Yes
Pattern : ^ragEngineConfig$
Type : string
pageToken
Description : The standard list page token.
Location : query
Type : string
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Location : query
filter
Type : string
Description : The standard list filter.
Location : query
pageSize
Type : integer
Location : query
Description : The standard list page size.
Format : int32
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.ragEngineConfig.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Type : string
Pattern : ^ragEngineConfig/operations/[^/]+$
Location : path
Description : The name of the operation resource.
Parameter Order : name
Path : v1/{+name}
Flat Path : v1/ragEngineConfig/operations/{operationsId}
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.ragEngineConfig.operations.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+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 : v1/ragEngineConfig/operations/{operationsId}
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to be deleted.
Pattern : ^ragEngineConfig/operations/[^/]+$
Type : string
Parameter Order : name
▼ ▲ aiplatform.ragEngineConfig.operations.wait
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^ragEngineConfig/operations/[^/]+$
Type : string
Required : Yes
Location : path
timeout
Format : google-duration
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.
Type : string
Parameter Order : name
Flat Path : v1/ragEngineConfig/operations/{operationsId}:wait
Path : v1/{+name}: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.
▼ ▲ aiplatform.ragEngineConfig.operations.cancel
Parameters :
name
Location : path
Required : Yes
Type : string
Pattern : ^ragEngineConfig/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Flat Path : v1/ragEngineConfig/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`.
Path : v1/{+name}:cancel
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.trainingPipelines.operations.wait
Flat Path : v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+name}:wait
Parameters :
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
name
Required : Yes
Pattern : ^trainingPipelines/[^/]+/operations/[^/]+$
Description : The name of the operation resource to wait on.
Location : path
Type : string
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
▼ ▲ aiplatform.trainingPipelines.operations.list
Path : v1/{+name}/operations
HTTP Method : GET
Parameters :
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
pageSize
Format : int32
Type : integer
Description : The standard list page size.
Location : query
name
Pattern : ^trainingPipelines/[^/]+$
Type : string
Description : The name of the operation's parent resource.
Location : path
Required : Yes
filter
Location : query
Type : string
Description : The standard list filter.
pageToken
Type : string
Description : The standard list page token.
Location : query
Flat Path : v1/trainingPipelines/{trainingPipelinesId}/operations
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`.
Parameter Order : name
▼ ▲ aiplatform.trainingPipelines.operations.cancel
Flat Path : v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel
Parameter Order : name
HTTP Method : POST
Parameters :
name
Required : Yes
Type : string
Description : The name of the operation resource to be cancelled.
Location : path
Pattern : ^trainingPipelines/[^/]+/operations/[^/]+$
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.trainingPipelines.operations.get
HTTP Method : GET
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^trainingPipelines/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Description : The name of the operation resource.
Flat Path : v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}
Path : v1/{+name}
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.
▼ ▲ aiplatform.trainingPipelines.operations.delete
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameter Order : name
Parameters :
name
Location : path
Description : The name of the operation resource to be deleted.
Pattern : ^trainingPipelines/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Flat Path : v1/trainingPipelines/{trainingPipelinesId}/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`.
▼ ▲ aiplatform.deploymentResourcePools.operations.wait
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
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 : v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait
Path : v1/{+name}:wait
Parameters :
timeout
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.
Location : query
Format : google-duration
name
Type : string
Required : Yes
Location : path
Description : The name of the operation resource to wait on.
Pattern : ^deploymentResourcePools/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.deploymentResourcePools.operations.delete
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^deploymentResourcePools/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
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`.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}
Path : v1/{+name}
HTTP Method : DELETE
▼ ▲ aiplatform.deploymentResourcePools.operations.get
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Location : path
Pattern : ^deploymentResourcePools/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource.
Required : Yes
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.deploymentResourcePools.operations.cancel
Path : v1/{+name}:cancel
Parameters :
name
Required : Yes
Location : path
Type : string
Pattern : ^deploymentResourcePools/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
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/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ aiplatform.deploymentResourcePools.operations.list
Path : v1/{+name}/operations
Flat Path : v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method : GET
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Location : query
Description : The standard list page size.
Format : int32
Type : integer
filter
Type : string
Location : query
Description : The standard list filter.
name
Description : The name of the operation's parent resource.
Location : path
Type : string
Required : Yes
Pattern : ^deploymentResourcePools/[^/]+$
returnPartialSuccess
Location : query
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
pageToken
Description : The standard list page token.
Type : string
Location : query
▼ ▲ aiplatform.tuningJobs.operations.list
Flat Path : v1/tuningJobs/{tuningJobsId}/operations
Path : v1/{+name}/operations
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
pageSize
Type : integer
Format : int32
Location : query
Description : The standard list page size.
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
name
Type : string
Pattern : ^tuningJobs/[^/]+$
Description : The name of the operation's parent resource.
Location : path
Required : Yes
filter
Description : The standard list filter.
Location : query
Type : string
pageToken
Type : string
Location : query
Description : The standard list page token.
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.tuningJobs.operations.delete
Parameter Order : name
HTTP Method : DELETE
Parameters :
name
Required : Yes
Location : path
Description : The name of the operation resource to be deleted.
Type : string
Pattern : ^tuningJobs/[^/]+/operations/[^/]+$
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
Path : v1/{+name}
Flat Path : v1/tuningJobs/{tuningJobsId}/operations/{operationsId}
▼ ▲ aiplatform.tuningJobs.operations.get
Path : v1/{+name}
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.
HTTP Method : GET
Flat Path : v1/tuningJobs/{tuningJobsId}/operations/{operationsId}
Parameter Order : name
Parameters :
name
Description : The name of the operation resource.
Location : path
Type : string
Pattern : ^tuningJobs/[^/]+/operations/[^/]+$
Required : Yes
▼ ▲ aiplatform.tuningJobs.operations.cancel
Parameter Order : name
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/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel
Path : v1/{+name}:cancel
Parameters :
name
Required : Yes
Location : path
Type : string
Description : The name of the operation resource to be cancelled.
Pattern : ^tuningJobs/[^/]+/operations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ aiplatform.specialistPools.operations.delete
Parameters :
name
Type : string
Required : Yes
Description : The name of the operation resource to be deleted.
Pattern : ^specialistPools/[^/]+/operations/[^/]+$
Location : path
HTTP Method : DELETE
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`.
Flat Path : v1/specialistPools/{specialistPoolsId}/operations/{operationsId}
Path : v1/{+name}
▼ ▲ aiplatform.specialistPools.operations.get
Parameter Order : name
HTTP Method : GET
Path : v1/{+name}
Parameters :
name
Location : path
Description : The name of the operation resource.
Pattern : ^specialistPools/[^/]+/operations/[^/]+$
Type : string
Required : Yes
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.
Flat Path : v1/specialistPools/{specialistPoolsId}/operations/{operationsId}
▼ ▲ aiplatform.specialistPools.operations.list
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
Flat Path : v1/specialistPools/{specialistPoolsId}/operations
HTTP Method : GET
Path : v1/{+name}/operations
Parameters :
filter
Type : string
Description : The standard list filter.
Location : query
pageToken
Type : string
Description : The standard list page token.
Location : query
pageSize
Format : int32
Type : integer
Location : query
Description : The standard list page size.
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Location : query
name
Required : Yes
Description : The name of the operation's parent resource.
Type : string
Pattern : ^specialistPools/[^/]+$
Location : path
▼ ▲ aiplatform.specialistPools.operations.wait
HTTP Method : POST
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/specialistPools/{specialistPoolsId}/operations/{operationsId}: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.
Parameters :
name
Description : The name of the operation resource to wait on.
Required : Yes
Pattern : ^specialistPools/[^/]+/operations/[^/]+$
Type : string
Location : path
timeout
Format : google-duration
Type : string
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.
Path : v1/{+name}:wait
▼ ▲ aiplatform.specialistPools.operations.cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
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`.
Parameter Order : name
Flat Path : v1/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel
Parameters :
name
Required : Yes
Pattern : ^specialistPools/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be cancelled.
Location : path
▼ ▲ aiplatform.persistentResources.operations.delete
Flat Path : v1/persistentResources/{persistentResourcesId}/operations/{operationsId}
HTTP Method : DELETE
Path : v1/{+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`.
Parameter Order : name
Parameters :
name
Pattern : ^persistentResources/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Required : Yes
Location : path
Type : string
▼ ▲ aiplatform.persistentResources.operations.cancel
Parameter Order : name
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
Path : v1/{+name}:cancel
Flat Path : v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel
Parameters :
name
Required : Yes
Location : path
Pattern : ^persistentResources/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Type : string
HTTP Method : POST
▼ ▲ aiplatform.persistentResources.operations.list
Parameters :
name
Required : Yes
Pattern : ^persistentResources/[^/]+$
Location : path
Type : string
Description : The name of the operation's parent resource.
pageSize
Type : integer
Location : query
Format : int32
Description : The standard list page size.
filter
Location : query
Type : string
Description : The standard list filter.
returnPartialSuccess
Location : query
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
pageToken
Description : The standard list page token.
Type : string
Location : query
Parameter Order : name
Flat Path : v1/persistentResources/{persistentResourcesId}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Path : v1/{+name}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.persistentResources.operations.get
Parameters :
name
Description : The name of the operation resource.
Location : path
Required : Yes
Type : string
Pattern : ^persistentResources/[^/]+/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.
Flat Path : v1/persistentResources/{persistentResourcesId}/operations/{operationsId}
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
▼ ▲ aiplatform.persistentResources.operations.wait
HTTP Method : POST
Parameters :
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
name
Type : string
Location : path
Pattern : ^persistentResources/[^/]+/operations/[^/]+$
Description : The name of the operation resource to wait on.
Required : Yes
Flat Path : v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+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.
Parameter Order : name
▼ ▲ aiplatform.notebookRuntimeTemplates.operations.wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}: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.
HTTP Method : POST
Parameter Order : name
Parameters :
name
Description : The name of the operation resource to wait on.
Type : string
Pattern : ^notebookRuntimeTemplates/[^/]+/operations/[^/]+$
Location : path
Required : Yes
timeout
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.
Format : google-duration
Location : query
Path : v1/{+name}:wait
▼ ▲ aiplatform.notebookRuntimeTemplates.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`.
Path : v1/{+name}:cancel
Flat Path : v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameters :
name
Pattern : ^notebookRuntimeTemplates/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Required : Yes
Location : path
Type : string
▼ ▲ aiplatform.notebookRuntimeTemplates.operations.delete
HTTP Method : DELETE
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^notebookRuntimeTemplates/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
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`.
Parameter Order : name
Flat Path : v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}
▼ ▲ aiplatform.notebookRuntimeTemplates.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.
Parameter Order : name
HTTP Method : GET
Flat Path : v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^notebookRuntimeTemplates/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Path : v1/{+name}
▼ ▲ aiplatform.notebookRuntimeTemplates.operations.list
Parameter Order : name
Path : v1/{+name}/operations
Flat Path : v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^notebookRuntimeTemplates/[^/]+$
Location : path
Type : string
Required : Yes
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
pageSize
Location : query
Description : The standard list page size.
Format : int32
Type : integer
pageToken
Description : The standard list page token.
Type : string
Location : query
filter
Description : The standard list filter.
Type : string
Location : query
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method : GET
▼ ▲ aiplatform.tensorboards.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 :
filter
Location : query
Description : The standard list filter.
Type : string
name
Pattern : ^tensorboards/[^/]+$
Description : The name of the operation's parent resource.
Required : Yes
Location : path
Type : string
pageSize
Location : query
Format : int32
Description : The standard list page size.
Type : integer
pageToken
Description : The standard list page token.
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
Path : v1/{+name}/operations
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/tensorboards/{tensorboardsId}/operations
HTTP Method : GET
▼ ▲ aiplatform.tensorboards.operations.cancel
Flat Path : v1/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel
Parameters :
name
Type : string
Description : The name of the operation resource to be cancelled.
Pattern : ^tensorboards/[^/]+/operations/[^/]+$
Required : Yes
Location : path
Path : v1/{+name}:cancel
Parameter Order : name
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`.
▼ ▲ aiplatform.tensorboards.operations.delete
Parameter Order : name
Flat Path : v1/tensorboards/{tensorboardsId}/operations/{operationsId}
Parameters :
name
Pattern : ^tensorboards/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Location : path
Description : The name of the operation resource to be deleted.
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
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`.
▼ ▲ aiplatform.tensorboards.operations.wait
Parameters :
timeout
Location : query
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.
name
Description : The name of the operation resource to wait on.
Type : string
Pattern : ^tensorboards/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+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.
HTTP Method : POST
Flat Path : v1/tensorboards/{tensorboardsId}/operations/{operationsId}:wait
Parameter Order : name
▼ ▲ aiplatform.tensorboards.operations.get
Path : v1/{+name}
Parameters :
name
Location : path
Pattern : ^tensorboards/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Required : Yes
Type : string
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 : v1/tensorboards/{tensorboardsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.tensorboards.experiments.runs.timeSeries.operations.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`.
Parameters :
name
Type : string
Description : The name of the operation resource to be deleted.
Required : Yes
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
Location : path
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
HTTP Method : DELETE
Parameter Order : name
▼ ▲ aiplatform.tensorboards.experiments.runs.timeSeries.operations.cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:cancel
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel
Parameters :
name
Description : The name of the operation resource to be cancelled.
Type : string
Location : path
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
Required : Yes
Parameter Order : name
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
▼ ▲ aiplatform.tensorboards.experiments.runs.timeSeries.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.
Parameters :
name
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Type : string
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}
Parameter Order : name
Path : v1/{+name}
▼ ▲ aiplatform.tensorboards.experiments.runs.timeSeries.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/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
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
Type : string
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource to wait on.
Path : v1/{+name}:wait
HTTP Method : POST
▼ ▲ aiplatform.tensorboards.experiments.runs.timeSeries.operations.list
Parameter Order : name
HTTP Method : GET
Parameters :
pageToken
Type : string
Description : The standard list page token.
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Location : query
filter
Type : string
Location : query
Description : The standard list filter.
name
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Location : path
Type : string
Description : The name of the operation's parent resource.
Required : Yes
pageSize
Location : query
Type : integer
Format : int32
Description : The standard list page size.
Path : v1/{+name}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.tensorboards.experiments.runs.operations.list
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`.
Parameter Order : name
Parameters :
returnPartialSuccess
Location : query
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
pageToken
Location : query
Description : The standard list page token.
Type : string
pageSize
Location : query
Type : integer
Description : The standard list page size.
Format : int32
filter
Type : string
Location : query
Description : The standard list filter.
name
Location : path
Required : Yes
Description : The name of the operation's parent resource.
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations
▼ ▲ aiplatform.tensorboards.experiments.runs.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`.
Parameters :
name
Type : string
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
Path : v1/{+name}:cancel
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel
Parameter Order : name
▼ ▲ aiplatform.tensorboards.experiments.runs.operations.wait
Parameter Order : name
Path : v1/{+name}:wait
HTTP Method : POST
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
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
name
Description : The name of the operation resource to wait on.
Required : Yes
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
Location : path
Type : string
▼ ▲ aiplatform.tensorboards.experiments.runs.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`.
Parameter Order : name
HTTP Method : DELETE
Parameters :
name
Required : Yes
Type : string
Location : path
Description : The name of the operation resource to be deleted.
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}
Path : v1/{+name}
▼ ▲ aiplatform.tensorboards.experiments.runs.operations.get
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
HTTP Method : 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.
▼ ▲ aiplatform.tensorboards.experiments.operations.get
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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}
Parameters :
name
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource.
Required : Yes
Type : string
Parameter Order : name
▼ ▲ aiplatform.tensorboards.experiments.operations.delete
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}
Parameter Order : name
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
Path : v1/{+name}
Parameters :
name
Required : Yes
Location : path
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be deleted.
▼ ▲ aiplatform.tensorboards.experiments.operations.list
Parameter Order : name
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters :
pageToken
Type : string
Description : The standard list page token.
Location : query
name
Pattern : ^tensorboards/[^/]+/experiments/[^/]+$
Required : Yes
Description : The name of the operation's parent resource.
Location : path
Type : string
filter
Location : query
Type : string
Description : The standard list filter.
pageSize
Format : int32
Type : integer
Description : The standard list page size.
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
HTTP Method : GET
Path : v1/{+name}/operations
▼ ▲ aiplatform.tensorboards.experiments.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`.
Parameters :
name
Type : string
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Required : Yes
Location : path
HTTP Method : POST
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:cancel
▼ ▲ aiplatform.tensorboards.experiments.operations.wait
HTTP Method : POST
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
Pattern : ^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
Type : string
Location : path
Required : Yes
Description : The name of the operation resource to wait on.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}: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.
Parameter Order : name
Path : v1/{+name}:wait
▼ ▲ aiplatform.metadataStores.artifacts.operations.list
Path : v1/{+name}/operations
Parameters :
pageToken
Description : The standard list page token.
Location : query
Type : string
filter
Type : string
Location : query
Description : The standard list filter.
name
Description : The name of the operation's parent resource.
Required : Yes
Location : path
Type : string
Pattern : ^metadataStores/[^/]+/artifacts/[^/]+$
pageSize
Location : query
Description : The standard list page size.
Type : integer
Format : int32
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
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
HTTP Method : GET
Flat Path : v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations
▼ ▲ aiplatform.metadataStores.artifacts.operations.wait
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
Parameters :
name
Required : Yes
Type : string
Pattern : ^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource to wait on.
timeout
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.
Format : google-duration
Location : query
Path : v1/{+name}:wait
Flat Path : v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait
HTTP Method : POST
▼ ▲ aiplatform.metadataStores.artifacts.operations.cancel
Parameters :
name
Required : Yes
Pattern : ^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Type : string
Location : path
Flat Path : v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameter Order : name
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`.
▼ ▲ aiplatform.metadataStores.artifacts.operations.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}
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`.
Path : v1/{+name}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Required : Yes
Type : string
Pattern : ^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$
Location : path
▼ ▲ aiplatform.metadataStores.artifacts.operations.get
Flat Path : v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : name
Parameters :
name
Location : path
Type : string
Required : Yes
Description : The name of the operation resource.
Pattern : ^metadataStores/[^/]+/artifacts/[^/]+/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.
Path : v1/{+name}
▼ ▲ aiplatform.metadataStores.executions.operations.wait
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Location : path
timeout
Format : google-duration
Location : query
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.
HTTP Method : POST
Parameter Order : name
Flat Path : v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: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
▼ ▲ aiplatform.metadataStores.executions.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/metadataStores/{metadataStoresId}/executions/{executionsId}/operations
Parameters :
pageToken
Description : The standard list page token.
Location : query
Type : string
name
Type : string
Description : The name of the operation's parent resource.
Pattern : ^metadataStores/[^/]+/executions/[^/]+$
Required : Yes
Location : path
filter
Type : string
Location : query
Description : The standard list filter.
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
pageSize
Description : The standard list page size.
Type : integer
Format : int32
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : name
▼ ▲ aiplatform.metadataStores.executions.operations.delete
HTTP Method : DELETE
Path : v1/{+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`.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}
Parameter Order : name
Parameters :
name
Required : Yes
Location : path
Description : The name of the operation resource to be deleted.
Pattern : ^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$
Type : string
▼ ▲ aiplatform.metadataStores.executions.operations.cancel
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$
Type : string
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`.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel
Parameter Order : name
Path : v1/{+name}:cancel
▼ ▲ aiplatform.metadataStores.executions.operations.get
Parameters :
name
Pattern : ^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Description : The name of the operation resource.
Type : string
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
Flat Path : v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}
HTTP Method : GET
Path : v1/{+name}
Parameter Order : name
▼ ▲ aiplatform.metadataStores.contexts.operations.list
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
Path : v1/{+name}/operations
Flat Path : v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations
Parameters :
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
pageToken
Type : string
Description : The standard list page token.
Location : query
filter
Type : string
Description : The standard list filter.
Location : query
name
Pattern : ^metadataStores/[^/]+/contexts/[^/]+$
Description : The name of the operation's parent resource.
Type : string
Required : Yes
Location : path
pageSize
Type : integer
Location : query
Description : The standard list page size.
Format : int32
Parameter Order : name
HTTP Method : GET
▼ ▲ aiplatform.metadataStores.contexts.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`.
Parameter Order : name
HTTP Method : DELETE
Flat Path : v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to be deleted.
Type : string
Pattern : ^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$
Path : v1/{+name}
▼ ▲ aiplatform.metadataStores.contexts.operations.cancel
Flat Path : v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel
Parameter Order : name
Parameters :
name
Required : Yes
Type : string
Description : The name of the operation resource to be cancelled.
Location : path
Pattern : ^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$
Path : v1/{+name}:cancel
HTTP Method : POST
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`.
▼ ▲ aiplatform.metadataStores.contexts.operations.get
Flat Path : v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}
Parameters :
name
Pattern : ^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Description : The name of the operation resource.
Path : v1/{+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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
▼ ▲ aiplatform.metadataStores.contexts.operations.wait
Flat Path : v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait
Parameter Order : name
Path : v1/{+name}:wait
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
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
Required : Yes
Type : string
Description : The name of the operation resource to wait on.
Location : path
Pattern : ^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$
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.metadataStores.operations.cancel
Parameter Order : name
Parameters :
name
Type : string
Pattern : ^metadataStores/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Required : Yes
Location : path
Flat Path : v1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel
Path : v1/{+name}:cancel
HTTP Method : POST
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`.
▼ ▲ aiplatform.metadataStores.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/metadataStores/{metadataStoresId}/operations/{operationsId}
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.
Path : v1/{+name}
Parameters :
name
Pattern : ^metadataStores/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Location : path
Required : Yes
Type : string
▼ ▲ aiplatform.metadataStores.operations.delete
HTTP Method : DELETE
Flat Path : v1/metadataStores/{metadataStoresId}/operations/{operationsId}
Parameter Order : name
Path : v1/{+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`.
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 : ^metadataStores/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.metadataStores.operations.wait
Flat Path : v1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
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 :
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
Required : Yes
Description : The name of the operation resource to wait on.
Location : path
Type : string
Pattern : ^metadataStores/[^/]+/operations/[^/]+$
HTTP Method : POST
Path : v1/{+name}:wait
▼ ▲ aiplatform.metadataStores.operations.list
Path : v1/{+name}/operations
Flat Path : v1/metadataStores/{metadataStoresId}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
pageToken
Description : The standard list page token.
Location : query
Type : string
name
Location : path
Type : string
Required : Yes
Pattern : ^metadataStores/[^/]+$
Description : The name of the operation's parent resource.
filter
Type : string
Description : The standard list filter.
Location : query
pageSize
Description : The standard list page size.
Type : integer
Format : int32
Location : query
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method : GET
Parameter Order : name
▼ ▲ aiplatform.operations.cancel
Parameters :
name
Required : Yes
Location : path
Type : string
Description : The name of the operation resource to be cancelled.
Pattern : ^operations/[^/]+$
Path : v1/{+name}:cancel
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/operations/{operationsId}: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`.
▼ ▲ aiplatform.operations.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 : v1/operations/{operationsId}
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Location : path
Pattern : ^operations/[^/]+$
Description : The name of the operation resource to be deleted.
Required : Yes
Parameter Order : name
Path : v1/{+name}
▼ ▲ aiplatform.operations.wait
Parameters :
name
Description : The name of the operation resource to wait on.
Type : string
Pattern : ^operations/[^/]+$
Required : Yes
Location : path
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
Flat Path : v1/operations/{operationsId}:wait
Parameter Order : name
Path : v1/{+name}: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.
▼ ▲ aiplatform.operations.list
Path : v1/operations
Parameters :
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
name
Description : The name of the operation's parent resource.
Type : string
Location : query
pageToken
Description : The standard list page token.
Location : query
Type : string
pageSize
Location : query
Format : int32
Description : The standard list page size.
Type : integer
filter
Location : query
Description : The standard list filter.
Type : string
HTTP Method : GET
Flat Path : v1/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.operations.get
HTTP Method : GET
Parameters :
name
Type : string
Description : The name of the operation resource.
Pattern : ^operations/[^/]+$
Required : Yes
Location : path
Path : v1/{+name}
Flat Path : v1/operations/{operationsId}
Parameter Order : name
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.
▼ ▲ aiplatform.dataLabelingJobs.operations.wait
Parameter Order : name
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
Path : v1/{+name}:wait
Parameters :
name
Description : The name of the operation resource to wait on.
Required : Yes
Pattern : ^dataLabelingJobs/[^/]+/operations/[^/]+$
Type : string
Location : path
timeout
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.
Location : query
Flat Path : v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.dataLabelingJobs.operations.delete
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 : v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}
Path : v1/{+name}
Parameters :
name
Location : path
Type : string
Required : Yes
Pattern : ^dataLabelingJobs/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.dataLabelingJobs.operations.list
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
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`.
Flat Path : v1/dataLabelingJobs/{dataLabelingJobsId}/operations
Parameters :
pageSize
Description : The standard list page size.
Type : integer
Location : query
Format : int32
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
name
Location : path
Pattern : ^dataLabelingJobs/[^/]+$
Type : string
Description : The name of the operation's parent resource.
Required : Yes
pageToken
Location : query
Type : string
Description : The standard list page token.
filter
Description : The standard list filter.
Location : query
Type : string
Path : v1/{+name}/operations
▼ ▲ aiplatform.dataLabelingJobs.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.
Parameters :
name
Required : Yes
Location : path
Pattern : ^dataLabelingJobs/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource.
Path : v1/{+name}
Flat Path : v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ aiplatform.dataLabelingJobs.operations.cancel
HTTP Method : POST
Parameter Order : name
Parameters :
name
Pattern : ^dataLabelingJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Type : string
Path : v1/{+name}:cancel
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`.
Flat Path : v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.models.evaluations.operations.list
HTTP Method : GET
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
Parameters :
name
Location : path
Description : The name of the operation's parent resource.
Required : Yes
Pattern : ^models/[^/]+/evaluations/[^/]+$
Type : string
filter
Description : The standard list filter.
Type : string
Location : query
returnPartialSuccess
Location : query
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
pageSize
Format : int32
Type : integer
Description : The standard list page size.
Location : query
pageToken
Location : query
Description : The standard list page token.
Type : string
Flat Path : v1/models/{modelsId}/evaluations/{evaluationsId}/operations
Path : v1/{+name}/operations
▼ ▲ aiplatform.models.evaluations.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`.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel
Path : v1/{+name}:cancel
Parameters :
name
Location : path
Pattern : ^models/[^/]+/evaluations/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Required : Yes
Type : string
▼ ▲ aiplatform.models.evaluations.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^models/[^/]+/evaluations/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Description : The name of the operation resource.
Location : path
Flat Path : v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}
Parameter Order : name
Path : v1/{+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
▼ ▲ aiplatform.models.evaluations.operations.delete
Path : v1/{+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`.
Flat Path : v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}
Parameters :
name
Pattern : ^models/[^/]+/evaluations/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Type : string
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
▼ ▲ aiplatform.models.evaluations.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.
Parameter Order : name
Flat Path : v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait
Parameters :
timeout
Type : string
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
name
Description : The name of the operation resource to wait on.
Type : string
Required : Yes
Location : path
Pattern : ^models/[^/]+/evaluations/[^/]+/operations/[^/]+$
Path : v1/{+name}:wait
▼ ▲ aiplatform.models.operations.cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:cancel
Parameters :
name
Location : path
Description : The name of the operation resource to be cancelled.
Pattern : ^models/[^/]+/operations/[^/]+$
Required : Yes
Type : string
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/models/{modelsId}/operations/{operationsId}:cancel
Parameter Order : name
HTTP Method : POST
▼ ▲ aiplatform.models.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.
Parameters :
name
Description : The name of the operation resource.
Pattern : ^models/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Path : v1/{+name}
Flat Path : v1/models/{modelsId}/operations/{operationsId}
▼ ▲ aiplatform.models.operations.delete
Flat Path : v1/models/{modelsId}/operations/{operationsId}
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^models/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Location : path
Path : v1/{+name}
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`.
▼ ▲ aiplatform.models.operations.wait
Path : v1/{+name}:wait
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 : ^models/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to wait on.
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
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
HTTP Method : POST
Flat Path : v1/models/{modelsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.models.operations.list
Path : v1/{+name}/operations
Flat Path : v1/models/{modelsId}/operations
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
Parameter Order : name
Parameters :
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
pageToken
Description : The standard list page token.
Type : string
Location : query
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
name
Description : The name of the operation's parent resource.
Pattern : ^models/[^/]+$
Required : Yes
Location : path
Type : string
HTTP Method : GET
▼ ▲ aiplatform.featureGroups.operations.delete
Parameters :
name
Pattern : ^featureGroups/[^/]+/operations/[^/]+$
Location : path
Type : string
Required : Yes
Description : The name of the operation resource to be deleted.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/featureGroups/{featureGroupsId}/operations/{operationsId}
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}
Parameter Order : name
▼ ▲ aiplatform.featureGroups.operations.get
Parameters :
name
Required : Yes
Pattern : ^featureGroups/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Location : path
Type : string
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.
HTTP Method : GET
Flat Path : v1/featureGroups/{featureGroupsId}/operations/{operationsId}
Parameter Order : name
Path : v1/{+name}
▼ ▲ aiplatform.featureGroups.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.
Parameter Order : name
Flat Path : v1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait
HTTP Method : POST
Path : v1/{+name}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
timeout
Format : google-duration
Type : string
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.
name
Description : The name of the operation resource to wait on.
Pattern : ^featureGroups/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
▼ ▲ aiplatform.featureGroups.operations.listWait
Parameters :
pageSize
Format : int32
Location : query
Description : The standard list page size.
Type : integer
pageToken
Description : The standard list page token.
Type : string
Location : query
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
name
Location : path
Required : Yes
Description : The name of the operation's parent resource.
Pattern : ^featureGroups/[^/]+/operations/[^/]+$
Type : string
filter
Location : query
Type : string
Description : The standard list filter.
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path : v1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait
HTTP Method : GET
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:wait
▼ ▲ aiplatform.featureGroups.features.operations.wait
Parameters :
name
Pattern : ^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$
Location : path
Type : string
Required : Yes
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.
Format : google-duration
Location : query
Type : string
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/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait
HTTP Method : POST
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:wait
▼ ▲ aiplatform.featureGroups.features.operations.listWait
Path : v1/{+name}:wait
Parameters :
pageSize
Location : query
Type : integer
Description : The standard list page size.
Format : int32
filter
Description : The standard list filter.
Type : string
Location : query
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
pageToken
Location : query
Type : string
Description : The standard list page token.
name
Required : Yes
Pattern : ^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation's parent resource.
Type : string
Flat Path : v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait
Parameter Order : name
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`.
HTTP Method : GET
▼ ▲ aiplatform.featureGroups.features.operations.delete
Path : v1/{+name}
Flat Path : v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}
Parameter Order : name
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Location : path
Type : string
Required : Yes
Pattern : ^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$
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.featureGroups.features.operations.get
Flat Path : v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+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.
Parameter Order : name
HTTP Method : GET
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource.
Pattern : ^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$
Type : string
▼ ▲ aiplatform.notebookExecutionJobs.operations.wait
Path : v1/{+name}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : name
Flat Path : v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}: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.
Type : string
Format : google-duration
name
Location : path
Type : string
Required : Yes
Pattern : ^notebookExecutionJobs/[^/]+/operations/[^/]+$
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.
▼ ▲ aiplatform.notebookExecutionJobs.operations.delete
Path : v1/{+name}
Parameter Order : name
Flat Path : v1/notebookExecutionJobs/{notebookExecutionJobsId}/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
HTTP Method : DELETE
Parameters :
name
Required : Yes
Pattern : ^notebookExecutionJobs/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Location : path
Type : string
▼ ▲ aiplatform.notebookExecutionJobs.operations.list
Path : v1/{+name}/operations
Parameters :
pageSize
Location : query
Type : integer
Format : int32
Description : The standard list page size.
filter
Description : The standard list filter.
Location : query
Type : string
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Location : query
pageToken
Description : The standard list page token.
Location : query
Type : string
name
Pattern : ^notebookExecutionJobs/[^/]+$
Required : Yes
Description : The name of the operation's parent resource.
Location : path
Type : string
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method : GET
Flat Path : v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.notebookExecutionJobs.operations.get
Parameters :
name
Type : string
Description : The name of the operation resource.
Pattern : ^notebookExecutionJobs/[^/]+/operations/[^/]+$
Required : Yes
Location : path
Parameter Order : name
Flat Path : v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}
HTTP Method : GET
Path : v1/{+name}
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.
▼ ▲ aiplatform.notebookExecutionJobs.operations.cancel
Path : v1/{+name}:cancel
Parameter Order : name
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 : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel
Parameters :
name
Type : string
Description : The name of the operation resource to be cancelled.
Required : Yes
Pattern : ^notebookExecutionJobs/[^/]+/operations/[^/]+$
Location : path
▼ ▲ aiplatform.modelDeploymentMonitoringJobs.operations.list
Parameter Order : name
Path : v1/{+name}/operations
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`.
Parameters :
pageToken
Type : string
Description : The standard list page token.
Location : query
pageSize
Location : query
Description : The standard list page size.
Type : integer
Format : int32
filter
Type : string
Description : The standard list filter.
Location : query
name
Pattern : ^modelDeploymentMonitoringJobs/[^/]+$
Location : path
Type : string
Description : The name of the operation's parent resource.
Required : Yes
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
Flat Path : v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations
HTTP Method : GET
▼ ▲ aiplatform.modelDeploymentMonitoringJobs.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.
HTTP Method : POST
Path : v1/{+name}:wait
Flat Path : v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
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
Location : path
Description : The name of the operation resource to wait on.
Pattern : ^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
▼ ▲ aiplatform.modelDeploymentMonitoringJobs.operations.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`.
Parameters :
name
Pattern : ^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be deleted.
Required : Yes
Location : path
HTTP Method : DELETE
Path : v1/{+name}
Flat Path : v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.modelDeploymentMonitoringJobs.operations.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/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel
Parameter Order : name
Parameters :
name
Description : The name of the operation resource to be cancelled.
Required : Yes
Type : string
Pattern : ^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
Location : path
Path : v1/{+name}:cancel
▼ ▲ aiplatform.modelDeploymentMonitoringJobs.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.
Flat Path : v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}
Parameters :
name
Required : Yes
Description : The name of the operation resource.
Pattern : ^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
Location : path
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Path : v1/{+name}
▼ ▲ aiplatform.hyperparameterTuningJobs.operations.list
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
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`.
Flat Path : v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations
Parameters :
pageToken
Description : The standard list page token.
Type : string
Location : query
name
Type : string
Pattern : ^hyperparameterTuningJobs/[^/]+$
Location : path
Description : The name of the operation's parent resource.
Required : Yes
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
pageSize
Type : integer
Description : The standard list page size.
Location : query
Format : int32
filter
Location : query
Type : string
Description : The standard list filter.
▼ ▲ aiplatform.hyperparameterTuningJobs.operations.delete
Parameters :
name
Required : Yes
Pattern : ^hyperparameterTuningJobs/[^/]+/operations/[^/]+$
Location : path
Type : string
Description : The name of the operation resource to be deleted.
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`.
Path : v1/{+name}
HTTP Method : DELETE
Parameter Order : name
Flat Path : v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}
▼ ▲ aiplatform.hyperparameterTuningJobs.operations.get
Parameter Order : name
Flat Path : v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/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.
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^hyperparameterTuningJobs/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Location : path
▼ ▲ aiplatform.hyperparameterTuningJobs.operations.wait
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.
Type : string
Location : query
name
Pattern : ^hyperparameterTuningJobs/[^/]+/operations/[^/]+$
Description : The name of the operation resource to wait on.
Type : string
Location : path
Required : Yes
Flat Path : v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait
Path : v1/{+name}:wait
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.hyperparameterTuningJobs.operations.cancel
Parameters :
name
Required : Yes
Location : path
Type : string
Description : The name of the operation resource to be cancelled.
Pattern : ^hyperparameterTuningJobs/[^/]+/operations/[^/]+$
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/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel
Path : v1/{+name}:cancel
Parameter Order : name
HTTP Method : POST
▼ ▲ aiplatform.pipelineJobs.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.
Parameter Order : name
Flat Path : v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait
Parameters :
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
Format : google-duration
Location : query
name
Location : path
Pattern : ^pipelineJobs/[^/]+/operations/[^/]+$
Description : The name of the operation resource to wait on.
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+name}:wait
▼ ▲ aiplatform.pipelineJobs.operations.list
Parameters :
filter
Location : query
Type : string
Description : The standard list filter.
pageToken
Location : query
Description : The standard list page token.
Type : string
name
Type : string
Location : path
Required : Yes
Pattern : ^pipelineJobs/[^/]+$
Description : The name of the operation's parent resource.
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Location : query
pageSize
Location : query
Format : int32
Description : The standard list page size.
Type : integer
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
Path : v1/{+name}/operations
HTTP Method : GET
Flat Path : v1/pipelineJobs/{pipelineJobsId}/operations
Parameter Order : name
▼ ▲ aiplatform.pipelineJobs.operations.cancel
Parameters :
name
Pattern : ^pipelineJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Type : string
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`.
Parameter Order : name
Path : v1/{+name}:cancel
Flat Path : v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.pipelineJobs.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.
Parameter Order : name
Parameters :
name
Type : string
Description : The name of the operation resource.
Location : path
Pattern : ^pipelineJobs/[^/]+/operations/[^/]+$
Required : Yes
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Flat Path : v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}
▼ ▲ aiplatform.pipelineJobs.operations.delete
Path : v1/{+name}
Parameters :
name
Description : The name of the operation resource to be deleted.
Type : string
Pattern : ^pipelineJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}
HTTP Method : DELETE
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.migratableResources.operations.wait
Parameters :
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
Location : query
Type : string
name
Description : The name of the operation resource to wait on.
Required : Yes
Pattern : ^migratableResources/[^/]+/operations/[^/]+$
Type : string
Location : path
Flat Path : v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait
Path : v1/{+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.
HTTP Method : POST
Parameter Order : name
▼ ▲ aiplatform.migratableResources.operations.list
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path : v1/migratableResources/{migratableResourcesId}/operations
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}/operations
Parameter Order : name
Parameters :
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
filter
Description : The standard list filter.
Type : string
Location : query
pageToken
Type : string
Description : The standard list page token.
Location : query
name
Location : path
Pattern : ^migratableResources/[^/]+$
Description : The name of the operation's parent resource.
Required : Yes
Type : string
pageSize
Location : query
Type : integer
Description : The standard list page size.
Format : int32
▼ ▲ aiplatform.migratableResources.operations.delete
Parameter Order : name
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation resource to be deleted.
Location : path
Type : string
Required : Yes
Pattern : ^migratableResources/[^/]+/operations/[^/]+$
Flat Path : v1/migratableResources/{migratableResourcesId}/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
▼ ▲ aiplatform.migratableResources.operations.cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1/migratableResources/{migratableResourcesId}/operations/{operationsId}: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`.
Parameter Order : name
Parameters :
name
Required : Yes
Description : The name of the operation resource to be cancelled.
Location : path
Type : string
Pattern : ^migratableResources/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.migratableResources.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/migratableResources/{migratableResourcesId}/operations/{operationsId}
Parameter Order : name
Parameters :
name
Description : The name of the operation resource.
Pattern : ^migratableResources/[^/]+/operations/[^/]+$
Required : Yes
Location : path
Type : string
Path : v1/{+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.ragCorpora.ragFiles.operations.wait
Parameters :
name
Type : string
Description : The name of the operation resource to wait on.
Required : Yes
Location : path
Pattern : ^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
timeout
Format : google-duration
Type : string
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.
HTTP Method : POST
Flat Path : v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}: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.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:wait
▼ ▲ aiplatform.ragCorpora.ragFiles.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`.
Parameter Order : name
Flat Path : v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation resource to be cancelled.
Type : string
Required : Yes
Pattern : ^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
Location : path
Path : v1/{+name}:cancel
HTTP Method : POST
▼ ▲ aiplatform.ragCorpora.ragFiles.operations.list
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path : v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Description : The standard list page size.
Location : query
Format : int32
Type : integer
filter
Location : query
Type : string
Description : The standard list filter.
pageToken
Location : query
Type : string
Description : The standard list page token.
name
Pattern : ^ragCorpora/[^/]+/ragFiles/[^/]+$
Type : string
Location : path
Description : The name of the operation's parent resource.
Required : Yes
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
HTTP Method : GET
Parameter Order : name
Path : v1/{+name}/operations
▼ ▲ aiplatform.ragCorpora.ragFiles.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Location : path
Required : Yes
Type : string
Pattern : ^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
Path : v1/{+name}
Flat Path : v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/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.
Parameter Order : name
▼ ▲ aiplatform.ragCorpora.ragFiles.operations.delete
HTTP Method : DELETE
Path : v1/{+name}
Parameters :
name
Pattern : ^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Description : The name of the operation resource to be deleted.
Location : path
Flat Path : v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}
Parameter Order : name
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.ragCorpora.operations.cancel
Parameters :
name
Pattern : ^ragCorpora/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Description : The name of the operation resource to be cancelled.
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`.
Flat Path : v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel
Parameter Order : name
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:cancel
▼ ▲ aiplatform.ragCorpora.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 : v1/{+name}
HTTP Method : GET
Parameter Order : name
Parameters :
name
Type : string
Pattern : ^ragCorpora/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Location : path
Required : Yes
Flat Path : v1/ragCorpora/{ragCorporaId}/operations/{operationsId}
▼ ▲ aiplatform.ragCorpora.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.
Flat Path : v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait
Path : v1/{+name}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Type : string
Location : path
Pattern : ^ragCorpora/[^/]+/operations/[^/]+$
Required : Yes
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.
Type : string
Format : google-duration
▼ ▲ aiplatform.ragCorpora.operations.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Path : v1/{+name}
Flat Path : v1/ragCorpora/{ragCorporaId}/operations/{operationsId}
Parameters :
name
Type : string
Location : path
Pattern : ^ragCorpora/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource to be deleted.
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`.
Parameter Order : name
▼ ▲ aiplatform.ragCorpora.operations.list
Path : v1/{+name}/operations
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
Parameter Order : name
HTTP Method : GET
Parameters :
returnPartialSuccess
Location : query
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
pageToken
Location : query
Description : The standard list page token.
Type : string
filter
Description : The standard list filter.
Type : string
Location : query
pageSize
Location : query
Description : The standard list page size.
Type : integer
Format : int32
name
Type : string
Location : path
Required : Yes
Pattern : ^ragCorpora/[^/]+$
Description : The name of the operation's parent resource.
Flat Path : v1/ragCorpora/{ragCorporaId}/operations
▼ ▲ aiplatform.studies.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^studies/[^/]+/operations/[^/]+$
Required : Yes
Location : path
Type : string
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
Flat Path : v1/studies/{studiesId}/operations/{operationsId}
▼ ▲ aiplatform.studies.operations.wait
Parameters :
name
Location : path
Pattern : ^studies/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Description : The name of the operation resource to wait on.
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.
Type : string
Format : google-duration
Flat Path : v1/studies/{studiesId}/operations/{operationsId}: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.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Path : v1/{+name}:wait
▼ ▲ aiplatform.studies.operations.delete
Path : v1/{+name}
Parameter Order : name
HTTP Method : 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`.
Flat Path : v1/studies/{studiesId}/operations/{operationsId}
Parameters :
name
Description : The name of the operation resource to be deleted.
Required : Yes
Pattern : ^studies/[^/]+/operations/[^/]+$
Type : string
Location : path
▼ ▲ aiplatform.studies.operations.list
Parameters :
pageSize
Type : integer
Description : The standard list page size.
Location : query
Format : int32
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
filter
Type : string
Description : The standard list filter.
Location : query
pageToken
Type : string
Description : The standard list page token.
Location : query
name
Required : Yes
Location : path
Description : The name of the operation's parent resource.
Pattern : ^studies/[^/]+$
Type : string
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`.
Flat Path : v1/studies/{studiesId}/operations
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}/operations
▼ ▲ aiplatform.studies.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`.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameters :
name
Type : string
Required : Yes
Location : path
Description : The name of the operation resource to be cancelled.
Pattern : ^studies/[^/]+/operations/[^/]+$
Parameter Order : name
Flat Path : v1/studies/{studiesId}/operations/{operationsId}:cancel
Path : v1/{+name}:cancel
▼ ▲ aiplatform.studies.trials.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
Type : string
Pattern : ^studies/[^/]+/trials/[^/]+/operations/[^/]+$
Description : The name of the operation resource to wait on.
Required : Yes
Location : path
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.
Path : v1/{+name}:wait
Parameter Order : name
Flat Path : v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.studies.trials.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}
Parameters :
name
Description : The name of the operation resource.
Type : string
Required : Yes
Pattern : ^studies/[^/]+/trials/[^/]+/operations/[^/]+$
Location : path
Path : v1/{+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.
Parameter Order : name
▼ ▲ aiplatform.studies.trials.operations.delete
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}
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`.
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Type : string
Location : path
Required : Yes
Pattern : ^studies/[^/]+/trials/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.studies.trials.operations.list
HTTP Method : GET
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
name
Description : The name of the operation's parent resource.
Type : string
Required : Yes
Location : path
Pattern : ^studies/[^/]+/trials/[^/]+$
pageSize
Description : The standard list page size.
Type : integer
Location : query
Format : int32
pageToken
Description : The standard list page token.
Type : string
Location : query
filter
Type : string
Description : The standard list filter.
Location : query
Path : v1/{+name}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path : v1/studies/{studiesId}/trials/{trialsId}/operations
▼ ▲ aiplatform.studies.trials.operations.cancel
HTTP Method : POST
Parameter Order : name
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
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^studies/[^/]+/trials/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource to be cancelled.
Required : Yes
Type : string
Flat Path : v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.indexEndpoints.operations.wait
Parameters :
timeout
Type : string
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.
name
Description : The name of the operation resource to wait on.
Location : path
Type : string
Pattern : ^indexEndpoints/[^/]+/operations/[^/]+$
Required : Yes
Path : v1/{+name}:wait
Parameter Order : name
Flat Path : v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}: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.
▼ ▲ aiplatform.indexEndpoints.operations.delete
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Location : path
Pattern : ^indexEndpoints/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Required : Yes
Flat Path : v1/indexEndpoints/{indexEndpointsId}/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`.
Parameter Order : name
Path : v1/{+name}
▼ ▲ aiplatform.indexEndpoints.operations.list
Path : v1/{+name}/operations
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/indexEndpoints/{indexEndpointsId}/operations
Parameters :
filter
Description : The standard list filter.
Location : query
Type : string
pageToken
Description : The standard list page token.
Type : string
Location : query
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
pageSize
Format : int32
Location : query
Type : integer
Description : The standard list page size.
name
Location : path
Required : Yes
Type : string
Pattern : ^indexEndpoints/[^/]+$
Description : The name of the operation's parent resource.
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
▼ ▲ aiplatform.indexEndpoints.operations.get
Parameter Order : name
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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}
Parameters :
name
Type : string
Pattern : ^indexEndpoints/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource.
Location : path
Path : v1/{+name}
▼ ▲ aiplatform.indexEndpoints.operations.cancel
Flat Path : v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}: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
Parameters :
name
Location : path
Type : string
Pattern : ^indexEndpoints/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource to be cancelled.
HTTP Method : POST
Parameter Order : name
▼ ▲ aiplatform.indexes.operations.get
Parameter Order : name
Flat Path : v1/indexes/{indexesId}/operations/{operationsId}
HTTP Method : GET
Path : v1/{+name}
Parameters :
name
Pattern : ^indexes/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Location : path
Required : Yes
Type : string
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.
▼ ▲ aiplatform.indexes.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`.
HTTP Method : POST
Parameter Order : name
Parameters :
name
Pattern : ^indexes/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Type : string
Location : path
Required : Yes
Flat Path : v1/indexes/{indexesId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.indexes.operations.wait
Parameters :
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
Format : google-duration
Type : string
name
Location : path
Type : string
Description : The name of the operation resource to wait on.
Required : Yes
Pattern : ^indexes/[^/]+/operations/[^/]+$
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/indexes/{indexesId}/operations/{operationsId}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : POST
Path : v1/{+name}:wait
▼ ▲ aiplatform.indexes.operations.list
Parameters :
name
Pattern : ^indexes/[^/]+$
Description : The name of the operation's parent resource.
Required : Yes
Location : path
Type : string
pageSize
Format : int32
Type : integer
Description : The standard list page size.
Location : query
pageToken
Type : string
Location : query
Description : The standard list page token.
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
filter
Location : query
Type : string
Description : The standard list filter.
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method : GET
Flat Path : v1/indexes/{indexesId}/operations
Parameter Order : name
Path : v1/{+name}/operations
▼ ▲ aiplatform.indexes.operations.delete
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^indexes/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be deleted.
Required : Yes
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
Flat Path : v1/indexes/{indexesId}/operations/{operationsId}
HTTP Method : DELETE
▼ ▲ aiplatform.notebookRuntimes.operations.get
Path : v1/{+name}
Flat Path : v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}
Scopes : 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.
Parameter Order : name
Parameters :
name
Location : path
Required : Yes
Pattern : ^notebookRuntimes/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Type : string
▼ ▲ aiplatform.notebookRuntimes.operations.delete
HTTP Method : DELETE
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`.
Path : v1/{+name}
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 : ^notebookRuntimes/[^/]+/operations/[^/]+$
Flat Path : v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}
▼ ▲ aiplatform.notebookRuntimes.operations.list
Parameters :
pageSize
Format : int32
Location : query
Type : integer
Description : The standard list page size.
name
Pattern : ^notebookRuntimes/[^/]+$
Location : path
Description : The name of the operation's parent resource.
Required : Yes
Type : string
filter
Type : string
Location : query
Description : The standard list filter.
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
pageToken
Location : query
Description : The standard list page token.
Type : string
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 : v1/{+name}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/notebookRuntimes/{notebookRuntimesId}/operations
▼ ▲ aiplatform.notebookRuntimes.operations.wait
Scopes : https://www.googleapis.com/auth/cloud-platform
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/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Required : Yes
Location : path
Pattern : ^notebookRuntimes/[^/]+/operations/[^/]+$
Type : string
timeout
Format : google-duration
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.
Type : string
Parameter Order : name
▼ ▲ aiplatform.notebookRuntimes.operations.cancel
Parameters :
name
Type : string
Required : Yes
Pattern : ^notebookRuntimes/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
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
HTTP Method : POST
Flat Path : v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.featureOnlineStores.featureViews.operations.listWait
Flat Path : v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait
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`.
Parameter Order : name
HTTP Method : GET
Path : v1/{+name}:wait
Parameters :
pageToken
Location : query
Description : The standard list page token.
Type : string
pageSize
Type : integer
Description : The standard list page size.
Format : int32
Location : query
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
filter
Type : string
Description : The standard list filter.
Location : query
name
Type : string
Required : Yes
Description : The name of the operation's parent resource.
Pattern : ^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Location : path
▼ ▲ aiplatform.featureOnlineStores.featureViews.operations.delete
Parameters :
name
Pattern : ^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Location : path
Required : Yes
Type : string
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
Parameter Order : name
Path : v1/{+name}
HTTP Method : DELETE
Flat Path : v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}
▼ ▲ aiplatform.featureOnlineStores.featureViews.operations.get
Parameters :
name
Pattern : ^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Required : Yes
Location : path
Type : string
Flat Path : v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}
HTTP Method : GET
Path : v1/{+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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.featureOnlineStores.featureViews.operations.wait
Scopes : https://www.googleapis.com/auth/cloud-platform
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
Parameters :
name
Pattern : ^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Description : The name of the operation resource to wait on.
Required : Yes
Type : string
Location : path
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
Location : query
Type : string
Flat Path : v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait
Path : v1/{+name}:wait
HTTP Method : POST
▼ ▲ aiplatform.featureOnlineStores.operations.wait
Scopes : https://www.googleapis.com/auth/cloud-platform
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
Required : Yes
Type : string
Location : path
Description : The name of the operation resource to wait on.
Pattern : ^featureOnlineStores/[^/]+/operations/[^/]+$
HTTP Method : POST
Path : v1/{+name}: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.
Flat Path : v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait
▼ ▲ aiplatform.featureOnlineStores.operations.get
Path : v1/{+name}
Flat Path : v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}
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
Parameters :
name
Type : string
Pattern : ^featureOnlineStores/[^/]+/operations/[^/]+$
Required : Yes
Location : path
Description : The name of the operation resource.
HTTP Method : GET
▼ ▲ aiplatform.featureOnlineStores.operations.listWait
Parameters :
filter
Type : string
Description : The standard list filter.
Location : query
pageToken
Type : string
Location : query
Description : The standard list page token.
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
name
Description : The name of the operation's parent resource.
Location : path
Pattern : ^featureOnlineStores/[^/]+/operations/[^/]+$
Type : string
Required : Yes
pageSize
Description : The standard list page size.
Type : integer
Format : int32
Location : query
Path : v1/{+name}:wait
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
Flat Path : v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait
▼ ▲ aiplatform.featureOnlineStores.operations.delete
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Description : The name of the operation resource to be deleted.
Pattern : ^featureOnlineStores/[^/]+/operations/[^/]+$
Required : Yes
Type : string
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/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}
Parameter Order : name
▼ ▲ aiplatform.featurestores.entityTypes.operations.list
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 : v1/{+name}/operations
Parameters :
pageToken
Description : The standard list page token.
Location : query
Type : string
filter
Type : string
Location : query
Description : The standard list filter.
name
Location : path
Required : Yes
Description : The name of the operation's parent resource.
Type : string
Pattern : ^featurestores/[^/]+/entityTypes/[^/]+$
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
pageSize
Format : int32
Location : query
Description : The standard list page size.
Type : integer
Flat Path : v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations
HTTP Method : GET
▼ ▲ aiplatform.featurestores.entityTypes.operations.cancel
Parameter Order : name
Parameters :
name
Type : string
Location : path
Description : The name of the operation resource to be cancelled.
Required : Yes
Pattern : ^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
Flat Path : v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
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`.
HTTP Method : POST
▼ ▲ aiplatform.featurestores.entityTypes.operations.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`.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : DELETE
Flat Path : v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}
Path : v1/{+name}
Parameters :
name
Type : string
Description : The name of the operation resource to be deleted.
Pattern : ^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
Required : Yes
Location : path
▼ ▲ aiplatform.featurestores.entityTypes.operations.wait
Path : v1/{+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.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait
Parameter Order : name
Parameters :
name
Type : string
Description : The name of the operation resource to wait on.
Required : Yes
Pattern : ^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
Location : path
timeout
Type : string
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.
▼ ▲ aiplatform.featurestores.entityTypes.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/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.
HTTP Method : GET
Parameters :
name
Required : Yes
Location : path
Pattern : ^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Type : string
Path : v1/{+name}
▼ ▲ aiplatform.featurestores.entityTypes.features.operations.delete
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
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 : v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}
Parameter Order : name
Parameters :
name
Required : Yes
Location : path
Pattern : ^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be deleted.
▼ ▲ aiplatform.featurestores.entityTypes.features.operations.wait
Flat Path : v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait
HTTP Method : POST
Path : v1/{+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.
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
Type : string
Format : google-duration
name
Description : The name of the operation resource to wait on.
Location : path
Pattern : ^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Parameter Order : name
▼ ▲ aiplatform.featurestores.entityTypes.features.operations.cancel
HTTP Method : POST
Parameter Order : name
Path : v1/{+name}:cancel
Flat Path : v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation resource to be cancelled.
Type : string
Location : path
Required : Yes
Pattern : ^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
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`.
▼ ▲ aiplatform.featurestores.entityTypes.features.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 :
filter
Location : query
Type : string
Description : The standard list filter.
pageToken
Description : The standard list page token.
Type : string
Location : query
pageSize
Format : int32
Location : query
Type : integer
Description : The standard list page size.
name
Required : Yes
Description : The name of the operation's parent resource.
Type : string
Location : path
Pattern : ^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$
returnPartialSuccess
Location : query
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Flat Path : v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Path : v1/{+name}/operations
▼ ▲ aiplatform.featurestores.entityTypes.features.operations.get
HTTP Method : GET
Flat Path : v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}
Path : v1/{+name}
Parameters :
name
Pattern : ^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Location : path
Description : The name of the operation resource.
Parameter Order : name
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.
▼ ▲ aiplatform.featurestores.operations.list
Path : v1/{+name}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path : v1/featurestores/{featurestoresId}/operations
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
filter
Location : query
Description : The standard list filter.
Type : string
pageToken
Type : string
Description : The standard list page token.
Location : query
name
Type : string
Location : path
Pattern : ^featurestores/[^/]+$
Description : The name of the operation's parent resource.
Required : Yes
pageSize
Format : int32
Description : The standard list page size.
Location : query
Type : integer
HTTP Method : GET
▼ ▲ aiplatform.featurestores.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`.
Flat Path : v1/featurestores/{featurestoresId}/operations/{operationsId}:cancel
Parameter Order : name
HTTP Method : POST
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Type : string
Pattern : ^featurestores/[^/]+/operations/[^/]+$
Path : v1/{+name}:cancel
▼ ▲ aiplatform.featurestores.operations.wait
Parameter Order : name
Parameters :
name
Pattern : ^featurestores/[^/]+/operations/[^/]+$
Location : path
Type : string
Required : Yes
Description : The name of the operation resource to wait on.
timeout
Format : google-duration
Type : string
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.
Scopes : https://www.googleapis.com/auth/cloud-platform
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
Flat Path : v1/featurestores/{featurestoresId}/operations/{operationsId}:wait
▼ ▲ aiplatform.featurestores.operations.get
Flat Path : v1/featurestores/{featurestoresId}/operations/{operationsId}
Parameter Order : name
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation resource.
Pattern : ^featurestores/[^/]+/operations/[^/]+$
Required : Yes
Location : path
Type : string
Path : v1/{+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.featurestores.operations.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`.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Flat Path : v1/featurestores/{featurestoresId}/operations/{operationsId}
Parameters :
name
Required : Yes
Location : path
Pattern : ^featurestores/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be deleted.
Parameter Order : name
Path : v1/{+name}
▼ ▲ aiplatform.datasets.operations.list
Parameter Order : name
Path : v1/{+name}/operations
Flat Path : v1/datasets/{datasetsId}/operations
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`.
Parameters :
pageSize
Format : int32
Type : integer
Location : query
Description : The standard list page size.
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
pageToken
Location : query
Description : The standard list page token.
Type : string
name
Type : string
Pattern : ^datasets/[^/]+$
Description : The name of the operation's parent resource.
Location : path
Required : Yes
filter
Location : query
Description : The standard list filter.
Type : string
HTTP Method : GET
▼ ▲ aiplatform.datasets.operations.cancel
Parameters :
name
Location : path
Pattern : ^datasets/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be cancelled.
Required : Yes
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`.
Path : v1/{+name}:cancel
HTTP Method : POST
Flat Path : v1/datasets/{datasetsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.datasets.operations.wait
HTTP Method : POST
Flat Path : v1/datasets/{datasetsId}/operations/{operationsId}:wait
Path : v1/{+name}:wait
Parameters :
name
Type : string
Required : Yes
Location : path
Description : The name of the operation resource to wait on.
Pattern : ^datasets/[^/]+/operations/[^/]+$
timeout
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.
Location : query
Format : google-duration
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.datasets.operations.delete
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^datasets/[^/]+/operations/[^/]+$
Type : string
Location : path
Required : Yes
Path : v1/{+name}
Flat Path : v1/datasets/{datasetsId}/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`.
Parameter Order : name
▼ ▲ aiplatform.datasets.operations.get
HTTP Method : GET
Path : v1/{+name}
Flat Path : v1/datasets/{datasetsId}/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
Parameter Order : name
Parameters :
name
Required : Yes
Location : path
Pattern : ^datasets/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource.
▼ ▲ aiplatform.datasets.dataItems.annotations.operations.wait
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : name
Path : v1/{+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.
Parameters :
name
Required : Yes
Description : The name of the operation resource to wait on.
Pattern : ^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
Type : string
Location : path
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
Flat Path : v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.datasets.dataItems.annotations.operations.get
HTTP Method : GET
Path : v1/{+name}
Flat Path : v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}
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
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
▼ ▲ aiplatform.datasets.dataItems.annotations.operations.list
Parameters :
pageSize
Type : integer
Location : query
Description : The standard list page size.
Format : int32
filter
Type : string
Location : query
Description : The standard list filter.
pageToken
Type : string
Location : query
Description : The standard list page token.
name
Type : string
Location : path
Pattern : ^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$
Description : The name of the operation's parent resource.
Required : Yes
returnPartialSuccess
Location : query
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Path : v1/{+name}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Flat Path : v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.datasets.dataItems.annotations.operations.cancel
Flat Path : v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}: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`.
Parameter Order : name
Parameters :
name
Pattern : ^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Required : Yes
Location : path
Type : string
Path : v1/{+name}:cancel
▼ ▲ aiplatform.datasets.dataItems.annotations.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 : v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation resource to be deleted.
Required : Yes
Pattern : ^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
Type : string
Location : path
▼ ▲ aiplatform.datasets.dataItems.operations.list
Flat Path : v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations
Parameters :
filter
Type : string
Description : The standard list filter.
Location : query
name
Location : path
Required : Yes
Type : string
Description : The name of the operation's parent resource.
Pattern : ^datasets/[^/]+/dataItems/[^/]+$
pageToken
Description : The standard list page token.
Location : query
Type : string
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
pageSize
Type : integer
Format : int32
Description : The standard list page size.
Location : query
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/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.datasets.dataItems.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.
Parameter Order : name
Flat Path : v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}
HTTP Method : GET
Path : v1/{+name}
Parameters :
name
Location : path
Description : The name of the operation resource.
Required : Yes
Type : string
Pattern : ^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.datasets.dataItems.operations.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Flat Path : v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}
Parameters :
name
Location : path
Type : string
Required : Yes
Description : The name of the operation resource to be deleted.
Pattern : ^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$
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`.
Path : v1/{+name}
▼ ▲ aiplatform.datasets.dataItems.operations.cancel
Parameters :
name
Description : The name of the operation resource to be cancelled.
Type : string
Required : Yes
Pattern : ^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$
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`.
Parameter Order : name
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel
Path : v1/{+name}:cancel
▼ ▲ aiplatform.datasets.dataItems.operations.wait
Flat Path : v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait
Parameter Order : name
Parameters :
timeout
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.
Location : query
Format : google-duration
name
Required : Yes
Pattern : ^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$
Description : The name of the operation resource to wait on.
Type : string
Location : path
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
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
▼ ▲ aiplatform.datasets.annotationSpecs.operations.list
Parameters :
filter
Location : query
Type : string
Description : The standard list filter.
pageSize
Location : query
Format : int32
Type : integer
Description : The standard list page size.
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
pageToken
Location : query
Type : string
Description : The standard list page token.
name
Type : string
Description : The name of the operation's parent resource.
Location : path
Required : Yes
Pattern : ^datasets/[^/]+/annotationSpecs/[^/]+$
Flat Path : v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
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`.
Path : v1/{+name}/operations
HTTP Method : GET
▼ ▲ aiplatform.datasets.annotationSpecs.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.
HTTP Method : POST
Path : v1/{+name}:wait
Parameters :
name
Description : The name of the operation resource to wait on.
Location : path
Pattern : ^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
Required : Yes
Type : string
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
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.datasets.annotationSpecs.operations.get
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.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}
Path : v1/{+name}
Parameters :
name
Type : string
Location : path
Pattern : ^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Required : Yes
▼ ▲ aiplatform.datasets.annotationSpecs.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`.
Parameters :
name
Pattern : ^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource to be cancelled.
Location : path
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:cancel
Flat Path : v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.datasets.annotationSpecs.operations.delete
Flat Path : v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}
Parameters :
name
Required : Yes
Description : The name of the operation resource to be deleted.
Pattern : ^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
Location : path
Type : string
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+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`.
Parameter Order : name
▼ ▲ aiplatform.datasets.savedQueries.operations.delete
Path : v1/{+name}
Flat Path : v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}
Parameter Order : name
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
Required : Yes
Type : string
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`.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
▼ ▲ aiplatform.datasets.savedQueries.operations.list
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Type : string
Pattern : ^datasets/[^/]+/savedQueries/[^/]+$
Required : Yes
Location : path
filter
Location : query
Type : string
Description : The standard list filter.
pageToken
Description : The standard list page token.
Type : string
Location : query
pageSize
Description : The standard list page size.
Type : integer
Location : query
Format : int32
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Path : v1/{+name}/operations
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`.
Parameter Order : name
Flat Path : v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations
▼ ▲ aiplatform.datasets.savedQueries.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`.
Path : v1/{+name}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Type : string
Pattern : ^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
Parameter Order : name
Flat Path : v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.datasets.savedQueries.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
Parameters :
timeout
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.
Location : query
name
Description : The name of the operation resource to wait on.
Type : string
Location : path
Required : Yes
Pattern : ^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
Flat Path : v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : POST
▼ ▲ aiplatform.datasets.savedQueries.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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}
Path : v1/{+name}
HTTP Method : GET
Parameters :
name
Pattern : ^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
Location : path
Type : string
Description : The name of the operation resource.
Required : Yes
Parameter Order : name
▼ ▲ aiplatform.reasoningEngines.operations.delete
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Type : string
Pattern : ^reasoningEngines/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
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`.
Parameter Order : name
HTTP Method : DELETE
Path : v1/{+name}
▼ ▲ aiplatform.reasoningEngines.operations.list
Parameter Order : name
Path : v1/{+name}/operations
Parameters :
pageSize
Description : The standard list page size.
Format : int32
Type : integer
Location : query
pageToken
Description : The standard list page token.
Location : query
Type : string
filter
Location : query
Type : string
Description : The standard list filter.
name
Pattern : ^reasoningEngines/[^/]+$
Description : The name of the operation's parent resource.
Location : path
Type : string
Required : Yes
returnPartialSuccess
Type : boolean
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/operations
HTTP Method : GET
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.reasoningEngines.operations.get
HTTP Method : 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.
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}
Parameters :
name
Required : Yes
Description : The name of the operation resource.
Type : string
Location : path
Pattern : ^reasoningEngines/[^/]+/operations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
▼ ▲ aiplatform.reasoningEngines.operations.wait
Path : v1/{+name}:wait
HTTP Method : POST
Parameters :
name
Location : path
Description : The name of the operation resource to wait on.
Type : string
Required : Yes
Pattern : ^reasoningEngines/[^/]+/operations/[^/]+$
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
Format : google-duration
Location : query
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
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait
Parameter Order : name
▼ ▲ aiplatform.reasoningEngines.operations.cancel
Parameter Order : name
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
Required : Yes
Description : The name of the operation resource to be cancelled.
Location : path
Pattern : ^reasoningEngines/[^/]+/operations/[^/]+$
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel
Path : v1/{+name}:cancel
HTTP Method : POST
▼ ▲ aiplatform.customJobs.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.
Path : v1/{+name}:wait
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Pattern : ^customJobs/[^/]+/operations/[^/]+$
Location : path
Type : string
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.
Type : string
Location : query
Format : google-duration
Flat Path : v1/customJobs/{customJobsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.customJobs.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`.
Flat Path : v1/customJobs/{customJobsId}/operations/{operationsId}:cancel
Parameters :
name
Description : The name of the operation resource to be cancelled.
Type : string
Required : Yes
Pattern : ^customJobs/[^/]+/operations/[^/]+$
Location : path
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ aiplatform.customJobs.operations.list
Parameter Order : name
Flat Path : v1/customJobs/{customJobsId}/operations
Path : v1/{+name}/operations
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`.
Parameters :
name
Type : string
Description : The name of the operation's parent resource.
Pattern : ^customJobs/[^/]+$
Required : Yes
Location : path
filter
Location : query
Description : The standard list filter.
Type : string
pageSize
Location : query
Description : The standard list page size.
Type : integer
Format : int32
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 e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Location : query
pageToken
Description : The standard list page token.
Location : query
Type : string
HTTP Method : GET
▼ ▲ aiplatform.customJobs.operations.get
Flat Path : v1/customJobs/{customJobsId}/operations/{operationsId}
HTTP Method : GET
Path : v1/{+name}
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.
Parameters :
name
Pattern : ^customJobs/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Required : Yes
Location : path
Type : string
Parameter Order : name
▼ ▲ aiplatform.customJobs.operations.delete
Path : v1/{+name}
HTTP Method : DELETE
Parameters :
name
Location : path
Required : Yes
Type : string
Description : The name of the operation resource to be deleted.
Pattern : ^customJobs/[^/]+/operations/[^/]+$
Flat Path : v1/customJobs/{customJobsId}/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`.
Parameter Order : name