2024-11-17
▼ ▲ aiplatform.projects.locations.endpoints.update
Path : v1/{+name}:update
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update
HTTP Method : POST
Parameters :
name
Description : Output only. The resource name of the Endpoint.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an Endpoint with a long running operation.
▼ ▲ aiplatform.projects.locations.reasoningEngines.create
Path : v1/{+parent}/reasoningEngines
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.list
Path : v1/{+parent}/reasoningEngines
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists reasoning engines in a location.
▼ ▲ aiplatform.projects.locations.reasoningEngines.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the ReasoningEngine.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Mask specifying which fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.operations.list
Path : v1/{+name}/operations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
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`.
▼ ▲ aiplatform.projects.locations.reasoningEngines.operations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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.projects.locations.reasoningEngines.operations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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.projects.locations.reasoningEngines.operations.cancel
Path : v1/{+name}:cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.reasoningEngines.operations.wait
Path : v1/{+name}:wait
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
timeout
Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location : query
Type : string
Format : google-duration
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.