Package-level declarations

Types

Link copied to clipboard
data class AcceleratorConfigResponse(val coreCount: String, val type: String)

Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported.

Link copied to clipboard
data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

Link copied to clipboard

Definition of the boot image used by the Runtime. Used to facilitate runtime upgradeability.

Link copied to clipboard
data class ContainerImageResponse(val repository: String, val tag: String)

Definition of a container image for starting a notebook instance with the environment installed in a container.

Link copied to clipboard
data class DataprocParametersResponse(val cluster: String)

Parameters used in Dataproc JobType executions.

Link copied to clipboard
data class DiskResponse(val autoDelete: Boolean, val boot: Boolean, val deviceName: String, val diskSizeGb: String, val guestOsFeatures: List<GuestOsFeatureResponse>, val index: String, val interface: String, val kind: String, val licenses: List<String>, val mode: String, val source: String, val type: String)

An instance-attached disk resource.

Link copied to clipboard
data class EncryptionConfigResponse(val kmsKey: String)

Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.

Link copied to clipboard
data class ExecutionResponse(val createTime: String, val description: String, val displayName: String, val executionTemplate: ExecutionTemplateResponse, val jobUri: String, val name: String, val outputNotebookFile: String, val state: String, val updateTime: String)

The definition of a single executed notebook.

Link copied to clipboard
data class ExecutionTemplateResponse(val acceleratorConfig: SchedulerAcceleratorConfigResponse, val containerImageUri: String, val dataprocParameters: DataprocParametersResponse, val inputNotebookFile: String, val jobType: String, val kernelSpec: String, val labels: Map<String, String>, val masterType: String, val outputNotebookFolder: String, val parameters: String, val paramsYamlFile: String, val scaleTier: String, val serviceAccount: String, val tensorboard: String, val vertexAiParameters: VertexAIParametersResponse)

The description a notebook execution workload.

Link copied to clipboard
data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Link copied to clipboard
data class GetEnvironmentResult(val containerImage: ContainerImageResponse, val createTime: String, val description: String, val displayName: String, val name: String, val postStartupScript: String, val vmImage: VmImageResponse)
Link copied to clipboard
data class GetExecutionResult(val createTime: String, val description: String, val displayName: String, val executionTemplate: ExecutionTemplateResponse, val jobUri: String, val name: String, val outputNotebookFile: String, val state: String, val updateTime: String)
Link copied to clipboard
data class GetInstanceIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetInstanceResult(val acceleratorConfig: AcceleratorConfigResponse, val bootDiskSizeGb: String, val bootDiskType: String, val canIpForward: Boolean, val containerImage: ContainerImageResponse, val createTime: String, val creator: String, val customGpuDriverPath: String, val dataDiskSizeGb: String, val dataDiskType: String, val diskEncryption: String, val disks: List<DiskResponse>, val installGpuDriver: Boolean, val instanceOwners: List<String>, val kmsKey: String, val labels: Map<String, String>, val machineType: String, val metadata: Map<String, String>, val name: String, val network: String, val nicType: String, val noProxyAccess: Boolean, val noPublicIp: Boolean, val noRemoveDataDisk: Boolean, val postStartupScript: String, val proxyUri: String, val reservationAffinity: ReservationAffinityResponse, val serviceAccount: String, val serviceAccountScopes: List<String>, val shieldedInstanceConfig: ShieldedInstanceConfigResponse, val state: String, val subnet: String, val tags: List<String>, val updateTime: String, val upgradeHistory: List<UpgradeHistoryEntryResponse>, val vmImage: VmImageResponse)
Link copied to clipboard
data class GetRuntimeIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetRuntimeResult(val accessConfig: RuntimeAccessConfigResponse, val createTime: String, val healthState: String, val labels: Map<String, String>, val metrics: RuntimeMetricsResponse, val name: String, val softwareConfig: RuntimeSoftwareConfigResponse, val state: String, val updateTime: String, val virtualMachine: VirtualMachineResponse)
Link copied to clipboard
data class GetScheduleResult(val createTime: String, val cronSchedule: String, val description: String, val displayName: String, val executionTemplate: ExecutionTemplateResponse, val name: String, val recentExecutions: List<ExecutionResponse>, val state: String, val timeZone: String, val updateTime: String)
Link copied to clipboard
data class GuestOsFeatureResponse(val type: String)

Guest OS features for boot disk.

Link copied to clipboard
data class LocalDiskInitializeParamsResponse(val description: String, val diskName: String, val diskSizeGb: String, val diskType: String, val labels: Map<String, String>)

Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new runtime. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Link copied to clipboard
data class LocalDiskResponse(val autoDelete: Boolean, val boot: Boolean, val deviceName: String, val guestOsFeatures: List<RuntimeGuestOsFeatureResponse>, val index: Int, val initializeParams: LocalDiskInitializeParamsResponse, val interface: String, val kind: String, val licenses: List<String>, val mode: String, val source: String, val type: String)

A Local attached disk resource.

Link copied to clipboard
data class ReservationAffinityResponse(val consumeReservationType: String, val key: String, val values: List<String>)

Reservation Affinity for consuming Zonal reservation.

Link copied to clipboard
data class RuntimeAcceleratorConfigResponse(val coreCount: String, val type: String)

Definition of the types of hardware accelerators that can be used. Definition of the types of hardware accelerators that can be used. See Compute Engine AcceleratorTypes. Examples: * nvidia-tesla-k80 * nvidia-tesla-p100 * nvidia-tesla-v100 * nvidia-tesla-p4 * nvidia-tesla-t4 * nvidia-tesla-a100

Link copied to clipboard
data class RuntimeAccessConfigResponse(val accessType: String, val proxyUri: String, val runtimeOwner: String)

Specifies the login configuration for Runtime

Link copied to clipboard

Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features for boot disk.

Link copied to clipboard
data class RuntimeMetricsResponse(val systemMetrics: Map<String, String>)

Contains runtime daemon metrics, such as OS and kernels and sessions stats.

Link copied to clipboard
data class RuntimeShieldedInstanceConfigResponse(val enableIntegrityMonitoring: Boolean, val enableSecureBoot: Boolean, val enableVtpm: Boolean)

A set of Shielded Instance options. Check Images using supported Shielded VM features. Not all combinations are valid.

Link copied to clipboard
data class RuntimeSoftwareConfigResponse(val customGpuDriverPath: String, val disableTerminal: Boolean, val enableHealthMonitoring: Boolean, val idleShutdown: Boolean, val idleShutdownTimeout: Int, val installGpuDriver: Boolean, val kernels: List<ContainerImageResponse>, val mixerDisabled: Boolean, val notebookUpgradeSchedule: String, val postStartupScript: String, val postStartupScriptBehavior: String, val upgradeable: Boolean, val version: String)

Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in key:value format, for example: * idle_shutdown: true * idle_shutdown_timeout: 180 * enable_health_monitoring: true

Link copied to clipboard
data class SchedulerAcceleratorConfigResponse(val coreCount: String, val type: String)

Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported.

Link copied to clipboard
data class ShieldedInstanceConfigResponse(val enableIntegrityMonitoring: Boolean, val enableSecureBoot: Boolean, val enableVtpm: Boolean)

A set of Shielded Instance options. Check Images using supported Shielded VM features. Not all combinations are valid.

Link copied to clipboard
data class UpgradeHistoryEntryResponse(val action: String, val containerImage: String, val createTime: String, val framework: String, val snapshot: String, val state: String, val targetImage: String, val targetVersion: String, val version: String, val vmImage: String)

The entry of VM image upgrade history.

Link copied to clipboard
data class VertexAIParametersResponse(val env: Map<String, String>, val network: String)

Parameters used in Vertex AI JobType executions.

Link copied to clipboard
data class VirtualMachineConfigResponse(val acceleratorConfig: RuntimeAcceleratorConfigResponse, val bootImage: BootImageResponse, val containerImages: List<ContainerImageResponse>, val dataDisk: LocalDiskResponse, val encryptionConfig: EncryptionConfigResponse, val guestAttributes: Map<String, String>, val internalIpOnly: Boolean, val labels: Map<String, String>, val machineType: String, val metadata: Map<String, String>, val network: String, val nicType: String, val reservedIpRange: String, val shieldedInstanceConfig: RuntimeShieldedInstanceConfigResponse, val subnet: String, val tags: List<String>, val zone: String)

The config settings for virtual machine.

Link copied to clipboard
data class VirtualMachineResponse(val instanceId: String, val instanceName: String, val virtualMachineConfig: VirtualMachineConfigResponse)

Runtime using Virtual Machine for computing.

Link copied to clipboard
data class VmImageResponse(val imageFamily: String, val imageName: String, val project: String)

Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.