Interface CreateAgentEngineSandboxConfig (0.16.0)

Config for creating a Sandbox.

Package

@google-cloud/agentplatform

Properties

abortSignal

abortSignal?: AbortSignal;

Abort signal which can be used to cancel the request.

NOTE: AbortSignal is a client-only operation. Using it to cancel an operation will not cancel the request in the service. You will still be charged usage for any applicable operations.

description

description?: string;

The description of the sandbox.

displayName

displayName?: string;

The display name of the sandbox.

httpOptions

httpOptions?: genaiTypes.HttpOptions;

Used to override HTTP request options.

owner

owner?: string;

Owner information for this sandbox environment. A sandbox can only be restored from a snapshot belonging to the same owner.

sandboxEnvironmentSnapshot

sandboxEnvironmentSnapshot?: string;

The name of the sandbox environment snapshot to restore the sandbox from. The sandbox environment snapshot should be in the format: projects/{project}/locations/{location}/agentEngines/{agent_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}

sandboxEnvironmentTemplate

sandboxEnvironmentTemplate?: string;

The name of the sandbox environment template to create the sandbox from. The sandbox environment template should be in the format: projects/{project}/locations/{location}/agentEngines/{agent_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}

ttl

ttl?: string;

The TTL for this resource. The expiration time is computed: now + TTL.

waitForCompletion

waitForCompletion?: boolean;

Waits for the operation to complete before returning.