sandbox_environment_snapshots

Creates, updates, deletes, gets or lists a sandbox_environment_snapshots resource.

Overview

Name	sandbox_environment_snapshots
Type	Resource
Id	google.aiplatform.sandbox_environment_snapshots

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}
createTime	string (google-datetime)	Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
displayName	string	Required. The display name of the SandboxEnvironmentSnapshot.
expireTime	string (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.
owner	string	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.
parentSnapshot	string	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.
postSnapshotAction	string	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. (POST_SNAPSHOT_ACTION_UNSPECIFIED, RUNNING, PAUSE)
sizeBytes	string (int64)	Optional. Output only. Size of the snapshot data in bytes.
sourceSandboxEnvironment	string	Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
ttl	string (google-duration)	Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
updateTime	string (google-datetime)	Output only. The timestamp when this SandboxEnvironment was most recently updated.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}
createTime	string (google-datetime)	Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
displayName	string	Required. The display name of the SandboxEnvironmentSnapshot.
expireTime	string (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.
owner	string	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.
parentSnapshot	string	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.
postSnapshotAction	string	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. (POST_SNAPSHOT_ACTION_UNSPECIFIED, RUNNING, PAUSE)
sizeBytes	string (int64)	Optional. Output only. Size of the snapshot data in bytes.
sourceSandboxEnvironment	string	Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
ttl	string (google-duration)	Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
updateTime	string (google-datetime)	Output only. The timestamp when this SandboxEnvironment was most recently updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, reasoningEnginesId, sandboxEnvironmentSnapshotsId		Gets details of the specific SandboxEnvironmentSnapshot.
list	select	projectsId, locationsId, reasoningEnginesId	filter, pageSize, pageToken	Lists SandboxEnvironmentSnapshots in a given reasoning engine.
delete	delete	projectsId, locationsId, reasoningEnginesId, sandboxEnvironmentSnapshotsId		Deletes the specific SandboxEnvironmentSnapshot.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
reasoningEnginesId	string
sandboxEnvironmentSnapshotsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets details of the specific SandboxEnvironmentSnapshot.

SELECT
name,
createTime,
displayName,
expireTime,
owner,
parentSnapshot,
postSnapshotAction,
sizeBytes,
sourceSandboxEnvironment,
ttl,
updateTime
FROM google.aiplatform.sandbox_environment_snapshots
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND reasoningEnginesId = '{{ reasoningEnginesId }}' -- required
AND sandboxEnvironmentSnapshotsId = '{{ sandboxEnvironmentSnapshotsId }}' -- required
;

list

Lists SandboxEnvironmentSnapshots in a given reasoning engine.

SELECT
name,
createTime,
displayName,
expireTime,
owner,
parentSnapshot,
postSnapshotAction,
sizeBytes,
sourceSandboxEnvironment,
ttl,
updateTime
FROM google.aiplatform.sandbox_environment_snapshots
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND reasoningEnginesId = '{{ reasoningEnginesId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

DELETE examples

delete

Deletes the specific SandboxEnvironmentSnapshot.

DELETE FROM google.aiplatform.sandbox_environment_snapshots
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND reasoningEnginesId = '{{ reasoningEnginesId }}' --required
AND sandboxEnvironmentSnapshotsId = '{{ sandboxEnvironmentSnapshotsId }}' --required
;