v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates a SandboxEnvironment in a given reasoning engine.

post/v1/{+parent}/sandboxEnvironments

Path parameters

parentstring required

Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}.

Request body

updateTimestring google-datetime

Output only. The timestamp when this SandboxEnvironment was most recently updated.

sandboxEnvironmentSnapshotstring

Optional. The resource name of the SandboxEnvironmentSnapshot to use for creating this SandboxEnvironment. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}

expireTimestring google-datetime

Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is always provided on output, regardless of what expiration was sent on input.

createTimestring google-datetime

Output only. The timestamp when this SandboxEnvironment was created.

sandboxEnvironmentTemplatestring

Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from.

ownerstring

Optional. Owner information for this sandbox environment. A Sandbox can only be restored from a snapshot that belongs to the same owner. If not set, sandbox will be created as the default owner.

ttlstring google-duration

Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.

latestSandboxEnvironmentSnapshotstring

Output only. The resource name of the latest snapshot taken for this SandboxEnvironment.

state'STATE_UNSPECIFIED' | 'STATE_PROVISIONING' | 'STATE_RUNNING' | 'STATE_DEPROVISIONING' | 'STATE_TERMINATED' | 'STATE_DELETED'

Output only. The runtime state of the SandboxEnvironment.

displayNamestring

Required. The display name of the SandboxEnvironment.

namestring

Identifier. The name of the SandboxEnvironment.

Response

Successful response