REST Resource: projects.locations.reasoningEngines.sandboxEnvironmentTemplates

Resource: SandboxEnvironmentTemplate

The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.

Fields
name string

Identifier. The resource name of the SandboxEnvironmentTemplate. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplate}

displayName string

Required. The display name of the SandboxEnvironmentTemplate.

createTime string (Timestamp format)

Output only. The timestamp when this SandboxEnvironmentTemplate was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

state enum (State)

Output only. The state of the sandbox environment template.

egressControlConfig object (EgressControlConfig)

Optional. The configuration for egress control of this template.

sandbox_environment_category Union type
The supported sandbox environment template categories. sandbox_environment_category can be only one of the following:
customContainerEnvironment object (CustomContainerEnvironment)

The sandbox environment for custom container workloads.

defaultContainerEnvironment object (DefaultContainerEnvironment)

The sandbox environment for default container workloads.

JSON representation 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "egressControlConfig": {
    object (EgressControlConfig)
  },

  // sandbox_environment_category
  "customContainerEnvironment": {
    object (CustomContainerEnvironment)
  },
  "defaultContainerEnvironment": {
    object (DefaultContainerEnvironment)
  }
  // Union type
}

CustomContainerEnvironment

The customized sandbox runtime environment for BYOC.

Fields
customContainerSpec object (CustomContainerSpec)

The specification of the custom container environment.

ports[] object (NetworkPort)

Ports to expose from the container.

resources object (ResourceRequirements)

Resource requests and limits for the container.

JSON representation 
{
  "customContainerSpec": {
    object (CustomContainerSpec)
  },
  "ports": [
    {
      object (NetworkPort)
    }
  ],
  "resources": {
    object (ResourceRequirements)
  }
}

CustomContainerSpec

Specification for deploying from a custom container image.

Fields
imageUri string

Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.

JSON representation 
{
  "imageUri": string
}

NetworkPort

Represents a network port in a container.

Fields
port integer

Optional. Port number to expose. This must be a valid port number, between 1 and 65535.

protocol enum (Protocol)

Optional. protocol for port. Defaults to TCP if not specified.

JSON representation 
{
  "port": integer,
  "protocol": enum (Protocol)
}

Protocol

The protocol for the port.

Enums
PROTOCOL_UNSPECIFIED Unspecified protocol. Defaults to TCP.
TCP TCP protocol.
UDP UDP protocol.

ResourceRequirements

message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template.

Fields
requests map (key: string, value: string)

Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").

limits map (key: string, value: string)

Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").

JSON representation 
{
  "requests": {
    string: string,
    ...
  },
  "limits": {
    string: string,
    ...
  }
}

DefaultContainerEnvironment

The default sandbox runtime environment for default container workloads.

Fields
defaultContainerCategory enum (DefaultContainerCategory)

Required. The category of the default container image.

resources object (ResourceRequirements)

Optional. Resource requests and limits for the default container.

JSON representation 
{
  "defaultContainerCategory": enum (DefaultContainerCategory),
  "resources": {
    object (ResourceRequirements)
  }
}

DefaultContainerCategory

The category of the default container image.

Enums
DEFAULT_CONTAINER_CATEGORY_UNSPECIFIED The default value. This value is unused.
DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE The default container image for Computer Use.
DEFAULT_CONTAINER_CATEGORY_SHELL_SANDBOX The default container image for Shell Sandbox.

State

Represents the state of a sandbox environment template.

Enums
UNSPECIFIED The default value. This value is unused.
PROVISIONING Runtime resources are being allocated for the sandbox environment.
ACTIVE Sandbox runtime is ready for serving.
DEPROVISIONING Sandbox runtime is halted, performing tear down tasks.
DELETED Sandbox has terminated with underlying runtime failure.
FAILED Sandbox has failed to provision.

EgressControlConfig

Configuration for egress control of sandbox instances.

Fields
internetAccess boolean

Optional. Whether to allow internet access.

networkAttachment string

Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress.

dnsPeeringConfigs[] object (DnsPeeringConfig)

Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC.

customerVpcNetwork string

Optional. The customer VPC network that sandbox egress is routed into.

JSON representation 
{
  "internetAccess": boolean,
  "networkAttachment": string,
  "dnsPeeringConfigs": [
    {
      object (DnsPeeringConfig)
    }
  ],
  "customerVpcNetwork": string
}

DnsPeeringConfig

Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC.

Fields
domain string

Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.

targetProject string

Required. The project id hosting the Cloud DNS managed zone that contains the 'domain'. The Agent Platform service Agent requires the dns.peer role on this project.

targetNetwork string

Required. The VPC network name in the targetProject where the DNS zone specified by 'domain' is visible.

JSON representation 
{
  "domain": string,
  "targetProject": string,
  "targetNetwork": string
}

Methods

create

 Creates a SandboxEnvironmentTemplate in a given reasoning engine.

delete

 Deletes the specific SandboxEnvironmentTemplate.

get

 Gets details of the specific SandboxEnvironmentTemplate.

list

 Lists SandboxEnvironmentTemplates in a given reasoning engine.