Sign in

v1

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

Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.

post/v1/{+name}:snapshot

Path parameters

namestring required

Required. The resource name of the sandbox environment to snapshot. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}.

Request body

namestring

Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}

createTimestring google-datetime

Output only. The timestamp when this SandboxEnvironmentSnapshot was created.

displayNamestring

Required. The display name of the SandboxEnvironmentSnapshot.

ownerstring

Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.

ttlstring google-duration

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

parentSnapshotstring

Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.

updateTimestring google-datetime

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

sizeBytesstring int64

Optional. Output only. Size of the snapshot data in bytes.

sourceSandboxEnvironmentstring

Required. The resource name of the source SandboxEnvironment this snapshot was taken from.

expireTimestring google-datetime

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

postSnapshotAction'POST_SNAPSHOT_ACTION_UNSPECIFIED' | 'RUNNING' | 'PAUSE'

Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.

Response

Successful response