GOgoogle
reasoningEngines

POST /v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot

Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.

Request

  • Base URL
    https://aiplatform.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

reasoningEnginesIdstring required
sandboxEnvironmentsIdstring required

Request body

createTimestring google-datetime

Output only. The timestamp when this SandboxEnvironmentSnapshot was created.

displayNamestring

Required. The display name of the SandboxEnvironmentSnapshot.

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.

namestring

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

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.

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.

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.

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.

ttlstring google-duration

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

updateTimestring google-datetime

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

Response

Successful response

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

responseobject

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Changes

No recorded changes to this operation across all 8 revisions of this API.