H2h2o
SandboxEngineImageService

Updates a SandboxEngineImage.

Authorization may require the following permission on the image's parent workspace:

  • actions/enginemanager/sandboxEngineImages/UPDATE
patch/v1/{sandboxEngineImage.name}

Request

Path parameters

sandboxEngineImage.namestring required

Identifier. Resource name. Format is workspaces/*/sandboxEngineImages/*.

Query parameters

updateMaskstring required

Required. The list of paths referencing which fields to update. Update mask must be non-empty.

Allowed field paths are: {"display_name", "image", "enabled", "image_pull_policy", "image_pull_secrets"}. Paths are case sensitive (must match exactly).

To update all allowed fields, specify exactly one path with value "*".

Request body

displayNamestring

Optional. Human-readable name.

imagestring required
enabledboolean

Optional. Whether the SandboxEngineImage is enabled. Disabled SandboxEngineImage cannot be used for creating new SandboxEngine.

imagePullPolicy'IMAGE_PULL_POLICY_UNSPECIFIED' | 'IMAGE_PULL_POLICY_ALWAYS' | 'IMAGE_PULL_POLICY_NEVER' | 'IMAGE_PULL_POLICY_IF_NOT_PRESENT'

Policy for downloading an image in K8s.

  • IMAGE_PULL_POLICY_UNSPECIFIED: Unspecified image pull policy.
  • IMAGE_PULL_POLICY_ALWAYS: Every time the container is launched, the container image registry is queried to resolve the name to an image digest.
  • IMAGE_PULL_POLICY_NEVER: Do not try to fetch the image. If the image is already present locally, the container will start. If the image is not present, container startup will fail.
  • IMAGE_PULL_POLICY_IF_NOT_PRESENT: The image is pulled only if it is not already present locally.
imagePullSecretsstring[]

Optional. A list of Kubernetes secret references used for authenticating to private container registries or repositories. These secrets provide the necessary credentials to pull Docker images from private repositories. Each entry in this list should be the name of a Kubernetes secret configured in the cluster.

createTimestring date-time

Output only. Time when the SandboxEngineImage was created.

updateTimestring date-time nullable

Output only. Time when the SandboxEngineImage was last updated.

creatorstring

Output only. Name of entity that created the SandboxEngineImage.

updaterstring

Output only. Name of entity that last updated the SandboxEngineImage.

creatorDisplayNamestring

Output only. Human-readable name of entity that created the SandboxEngineImage.

updaterDisplayNamestring

Output only. Human-readable name of entity that last updated the SandboxEngineImage.

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.