2026-04-11
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.create
HTTP Method : POST
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
parent
Location : path
Required : Yes
Pattern : ^reasoningEngines/[^/]+$
Type : string
Description : Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.
Path : v1/{+parent}/sandboxEnvironmentTemplates
Description : Creates a SandboxEnvironmentTemplate in a given reasoning engine.
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.get
Path : v1/{+name}
Description : Gets details of the specific SandboxEnvironmentTemplate.
Parameters :
name
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}
HTTP Method : GET
Parameter Order : name
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.list
Parameter Order : parent
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates
Path : v1/{+parent}/sandboxEnvironmentTemplates
Description : Lists SandboxEnvironmentTemplates in a given reasoning engine.
Parameters :
parent
Location : path
Required : Yes
Pattern : ^reasoningEngines/[^/]+$
Type : string
Description : Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.
filter
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Type : string
Location : query
pageToken
Location : query
Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.
Type : string
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.delete
Parameters :
name
Description : Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
Location : path
Required : Yes
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
Type : string
Path : v1/{+name}
Description : Deletes the specific SandboxEnvironmentTemplate.
Parameter Order : name
HTTP Method : DELETE
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.get
Parameter Order : name
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Required : Yes
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.
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.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.
Type : string
Format : google-duration
Location : query
name
Description : The name of the operation resource to wait on.
Location : path
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Required : Yes
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/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel
Parameter Order : name
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/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`.
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Location : path
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.delete
Parameters :
name
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Location : path
Description : The name of the operation resource to be deleted.
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`.
HTTP Method : DELETE
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.query
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query
HTTP Method : POST
Path : v1/{+name}:query
Description : Queries using a reasoning engine.
Parameters :
name
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.streamQuery
Path : v1/{+name}:streamQuery
Description : Streams queries using a reasoning engine.
Parameters :
name
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Parameter Order : name
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.snapshot
Parameters :
name
Location : path
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Type : string
Required : Yes
Description : Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`.
Path : v1/{+name}:snapshot
Description : Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.
HTTP Method : POST
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.get
Parameters :
name
Description : Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
Location : path
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$
Type : string
Required : Yes
Path : v1/{+name}
Description : Gets details of the specific SandboxEnvironmentSnapshot.
Parameter Order : name
HTTP Method : GET
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.list
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : parent
Parameters :
filter
Type : string
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Location : query
pageToken
Location : query
Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.
Type : string
parent
Pattern : ^reasoningEngines/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
pageSize
Location : query
Description : Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.
Type : integer
Format : int32
Path : v1/{+parent}/sandboxEnvironmentSnapshots
Description : Lists SandboxEnvironmentSnapshots in a given reasoning engine.
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.delete
Parameters :
name
Description : Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
Location : path
Required : Yes
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$
Type : string
Path : v1/{+name}
Description : Deletes the specific SandboxEnvironmentSnapshot.
Parameter Order : name
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/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`.
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Location : path
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.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`.
Parameters :
name
Location : path
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Description : The name of the operation resource to be cancelled.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel
Parameter Order : name
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.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.
Parameters :
name
Required : Yes
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Location : path
Description : The name of the operation resource.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}
HTTP Method : GET
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.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.
Parameters :
name
Location : path
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Description : The name of the operation resource to wait on.
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.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.create
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates
HTTP Method : POST
Path : v1/{+parent}/sandboxEnvironmentTemplates
Description : Creates a SandboxEnvironmentTemplate in a given reasoning engine.
Parameters :
parent
Description : Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Type : string
Required : Yes
Location : path
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.get
Path : v1/{+name}
Description : Gets details of the specific SandboxEnvironmentTemplate.
Parameters :
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
Type : string
Description : Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.list
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates
HTTP Method : GET
Path : v1/{+parent}/sandboxEnvironmentTemplates
Description : Lists SandboxEnvironmentTemplates in a given reasoning engine.
Parameters :
parent
Description : Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Type : string
Required : Yes
pageSize
Location : query
Description : Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.
Type : integer
Format : int32
filter
Location : query
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Type : string
pageToken
Location : query
Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.
Type : string
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.delete
Parameter Order : name
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
Type : string
Path : v1/{+name}
Description : Deletes the specific SandboxEnvironmentTemplate.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.delete
Parameter Order : name
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Location : path
Description : The name of the operation resource to be deleted.
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`.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.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.
Parameters :
name
Description : The name of the operation resource.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.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.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Location : path
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/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : name
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Location : path
Description : The name of the operation resource to be cancelled.
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.projects.locations.reasoningEngines.runtimeRevisions.query
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Path : v1/{+name}:query
Description : Queries using a reasoning engine.
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.streamQuery
Parameter Order : name
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery
Path : v1/{+name}:streamQuery
Description : Streams queries using a reasoning engine.
Parameters :
name
Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.snapshot
Parameters :
name
Description : Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Type : string
Required : Yes
Path : v1/{+name}:snapshot
Description : Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.get
Path : v1/{+name}
Description : Gets details of the specific SandboxEnvironmentSnapshot.
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$
Type : string
Required : Yes
Description : Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.list
Path : v1/{+parent}/sandboxEnvironmentSnapshots
Description : Lists SandboxEnvironmentSnapshots in a given reasoning engine.
Parameters :
parent
Description : Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Type : string
Required : Yes
Location : path
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.
filter
Location : query
Type : string
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
pageToken
Type : string
Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots
HTTP Method : GET
Parameter Order : parent
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.delete
Path : v1/{+name}
Description : Deletes the specific SandboxEnvironmentSnapshot.
Parameters :
name
Description : Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$
Type : string
Required : Yes
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.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`.
Parameters :
name
Description : The name of the operation resource to be deleted.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Location : path
Parameter Order : name
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.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`.
Parameters :
name
Description : The name of the operation resource to be cancelled.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.get
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Required : Yes
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.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : name
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Required : Yes
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.
Type : string
Format : google-duration
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.