notebooks library

Classes

AcceleratorConfig
Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. See GPUs on Compute Engine to find a valid combination. TPUs are not supported.
AcceleratorConfigNotebooksV2
An accelerator configuration for a VM instance Definition of a hardware accelerator. Note that there is no check on type and core_count combinations. TPUs are not supported. See GPUs on Compute Engine to find a valid combination.
AcceleratorConfigResponse
Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. See GPUs on Compute Engine to find a valid combination. TPUs are not supported.
AcceleratorConfigResponseNotebooksV2
An accelerator configuration for a VM instance Definition of a hardware accelerator. Note that there is no check on type and core_count combinations. TPUs are not supported. See GPUs on Compute Engine to find a valid combination.
Binding
Associates members, or principals, with a role.
BindingNotebooksV2
Associates members, or principals, with a role.
BindingResponse
Associates members, or principals, with a role.
BindingResponseNotebooksV2
Associates members, or principals, with a role.
BootDisk
The definition of a boot disk.
BootDiskResponse
The definition of a boot disk.
ContainerImage
Definition of a container image for starting a notebook instance with the environment installed in a container.
ContainerImageNotebooksV2
Definition of a container image for starting a notebook instance with the environment installed in a container.
ContainerImageResponse
Definition of a container image for starting a notebook instance with the environment installed in a container.
ContainerImageResponseNotebooksV2
Definition of a container image for starting a notebook instance with the environment installed in a container.
DataDisk
An instance-attached disk resource.
DataDiskResponse
An instance-attached disk resource.
DataprocParameters
Parameters used in Dataproc JobType executions.
DataprocParametersResponse
Parameters used in Dataproc JobType executions.
DiskResponse
An instance-attached disk resource.
EncryptionConfig
Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.
EncryptionConfigResponse
Represents a custom encryption key configuration that can be applied to a resource. This will encrypt all disks in Virtual Machine.
Environment
Creates a new Environment. Auto-naming is currently not supported for this resource.
EnvironmentArgs
The set of arguments for Environment. The set of arguments for Environment.
Execution
Creates a new Execution in a given project and location. Auto-naming is currently not supported for this resource.
ExecutionArgs
The set of arguments for Execution. The set of arguments for Execution.
ExecutionResponse
The definition of a single executed notebook.
ExecutionTemplate
The description a notebook execution workload.
ExecutionTemplateResponse
The description a notebook execution workload.
Expr
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.
ExprNotebooksV2
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.
ExprResponse
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.
ExprResponseNotebooksV2
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.
GceSetup
The definition of how to configure a VM instance outside of Resources and Identity.
GceSetupResponse
The definition of how to configure a VM instance outside of Resources and Identity.
GetEnvironmentArgs
Arguments for getEnvironment. Arguments for getEnvironment.
GetEnvironmentResult
Result data returned by getEnvironment.
GetExecutionArgs
Arguments for getExecution. Arguments for getExecution.
GetExecutionResult
Result data returned by getExecution.
GetInstanceArgs
Arguments for getInstance. Arguments for getInstance.
GetInstanceIamPolicyArgs
Arguments for getInstanceIamPolicy. Arguments for getInstanceIamPolicy.
GetInstanceIamPolicyNotebooksV2Args
Arguments for getInstanceIamPolicy. Arguments for getInstanceIamPolicy.
GetInstanceIamPolicyNotebooksV2Result
Result data returned by getInstanceIamPolicy.
GetInstanceIamPolicyResult
Result data returned by getInstanceIamPolicy.
GetInstanceNotebooksV2Args
Arguments for getInstance. Arguments for getInstance.
GetInstanceNotebooksV2Result
Result data returned by getInstance.
GetInstanceResult
Result data returned by getInstance.
GetRuntimeArgs
Arguments for getRuntime. Arguments for getRuntime.
GetRuntimeIamPolicyArgs
Arguments for getRuntimeIamPolicy. Arguments for getRuntimeIamPolicy.
GetRuntimeIamPolicyResult
Result data returned by getRuntimeIamPolicy.
GetRuntimeResult
Result data returned by getRuntime.
GetScheduleArgs
Arguments for getSchedule. Arguments for getSchedule.
GetScheduleResult
Result data returned by getSchedule.
GPUDriverConfig
A GPU driver configuration
GPUDriverConfigResponse
A GPU driver configuration
GuestOsFeatureResponse
Guest OS features for boot disk.
Instance
Creates a new Instance in a given project and location. Auto-naming is currently not supported for this resource.
InstanceArgs
The set of arguments for Instance. The set of arguments for Instance.
InstanceIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
InstanceIamBindingArgs
The set of arguments for InstanceIamBinding. The set of arguments for InstanceIamBinding.
InstanceIamBindingNotebooksV2
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
InstanceIamBindingNotebooksV2Args
The set of arguments for InstanceIamBinding. The set of arguments for InstanceIamBinding.
InstanceIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
InstanceIamMemberArgs
The set of arguments for InstanceIamMember. The set of arguments for InstanceIamMember.
InstanceIamMemberNotebooksV2
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
InstanceIamMemberNotebooksV2Args
The set of arguments for InstanceIamMember. The set of arguments for InstanceIamMember.
InstanceIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
InstanceIamPolicyArgs
The set of arguments for InstanceIamPolicy. The set of arguments for InstanceIamPolicy.
InstanceIamPolicyNotebooksV2
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
InstanceIamPolicyNotebooksV2Args
The set of arguments for InstanceIamPolicy. The set of arguments for InstanceIamPolicy.
InstanceMigrationEligibilityResponse
InstanceMigrationEligibility represents the feasibility information of a migration from UmN to WbI.
InstanceNotebooksV2
Creates a new Instance in a given project and location. Auto-naming is currently not supported for this resource.
InstanceNotebooksV2Args
The set of arguments for Instance. The set of arguments for Instance.
LocalDisk
A Local attached disk resource.
LocalDiskInitializeParams
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.
LocalDiskInitializeParamsResponse
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.
LocalDiskResponse
A Local attached disk resource.
NetworkInterface
The definition of a network interface resource attached to a VM.
NetworkInterfaceResponse
The definition of a network interface resource attached to a VM.
ReservationAffinity
Reservation Affinity for consuming Zonal reservation.
ReservationAffinityResponse
Reservation Affinity for consuming Zonal reservation.
Runtime
Creates a new Runtime in a given project and location. Auto-naming is currently not supported for this resource.
RuntimeAcceleratorConfig
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
RuntimeAcceleratorConfigResponse
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
RuntimeAccessConfig
Specifies the login configuration for Runtime
RuntimeAccessConfigResponse
Specifies the login configuration for Runtime
RuntimeArgs
The set of arguments for Runtime. The set of arguments for Runtime.
RuntimeGuestOsFeatureResponse
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.
RuntimeIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
RuntimeIamBindingArgs
The set of arguments for RuntimeIamBinding. The set of arguments for RuntimeIamBinding.
RuntimeIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
RuntimeIamMemberArgs
The set of arguments for RuntimeIamMember. The set of arguments for RuntimeIamMember.
RuntimeIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
RuntimeIamPolicyArgs
The set of arguments for RuntimeIamPolicy. The set of arguments for RuntimeIamPolicy.
RuntimeMetricsResponse
Contains runtime daemon metrics, such as OS and kernels and sessions stats.
RuntimeMigrationEligibilityResponse
RuntimeMigrationEligibility represents the feasibility information of a migration from GmN to WbI.
RuntimeShieldedInstanceConfig
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
RuntimeShieldedInstanceConfigResponse
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
RuntimeSoftwareConfig
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
RuntimeSoftwareConfigResponse
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
Schedule
Creates a new Scheduled Notebook in a given project and location. Auto-naming is currently not supported for this resource.
ScheduleArgs
The set of arguments for Schedule. The set of arguments for Schedule.
SchedulerAcceleratorConfig
Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. See GPUs on Compute Engine to find a valid combination. TPUs are not supported.
SchedulerAcceleratorConfigResponse
Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. See GPUs on Compute Engine to find a valid combination. TPUs are not supported.
ServiceAccount
A service account that acts as an identity.
ServiceAccountResponse
A service account that acts as an identity.
ShieldedInstanceConfig
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
ShieldedInstanceConfigNotebooksV2
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
ShieldedInstanceConfigResponse
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
ShieldedInstanceConfigResponseNotebooksV2
A set of Shielded Instance options. See Images using supported Shielded VM features. Not all combinations are valid.
UpgradeHistoryEntry
The entry of VM image upgrade history.
UpgradeHistoryEntryResponse
The entry of VM image upgrade history.
UpgradeHistoryEntryResponseNotebooksV2
The entry of VM image upgrade history.
VertexAIParameters
Parameters used in Vertex AI JobType executions.
VertexAIParametersResponse
Parameters used in Vertex AI JobType executions.
VirtualMachine
Runtime using Virtual Machine for computing.
VirtualMachineConfig
The config settings for virtual machine.
VirtualMachineConfigResponse
The config settings for virtual machine.
VirtualMachineResponse
Runtime using Virtual Machine for computing.
VmImage
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.
VmImageNotebooksV2
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.
VmImageResponse
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.
VmImageResponseNotebooksV2
Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.

Enums

AcceleratorConfigType
Type of this accelerator.
AcceleratorConfigTypeNotebooksV2
Optional. Type of this accelerator.
BootDiskDiskEncryption
Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
BootDiskDiskType
Optional. Indicates the type of the disk.
DataDiskDiskEncryption
Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
DataDiskDiskType
Optional. Input only. Indicates the type of the disk.
ExecutionTemplateJobType
The type of Job to be used on this execution.
ExecutionTemplateScaleTier
Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
InstanceBootDiskType
Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
InstanceDataDiskType
Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
InstanceDiskEncryption
Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
InstanceNicType
Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
LocalDiskInitializeParamsDiskType
Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
NetworkInterfaceNicType
Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
ReservationAffinityConsumeReservationType
Optional. Type of reservation to consume
RuntimeAcceleratorConfigType
Accelerator model.
RuntimeAccessConfigAccessType
The type of access mode this instance.
RuntimeSoftwareConfigPostStartupScriptBehavior
Behavior for the post startup script.
SchedulerAcceleratorConfigType
Type of this accelerator.
ScheduleState
UpgradeHistoryEntryAction
Action. Rolloback or Upgrade.
UpgradeHistoryEntryState
The state of this instance upgrade history entry.
VirtualMachineConfigNicType
Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Functions

getEnvironment(GetEnvironmentArgs args, {InvokeOptions? options}) → Future<GetEnvironmentResult>
Gets details of a single Environment. args Arguments passed to this invoke. Arguments for getEnvironment. options Invoke options controlling this call.
getExecution(GetExecutionArgs args, {InvokeOptions? options}) → Future<GetExecutionResult>
Gets details of executions args Arguments passed to this invoke. Arguments for getExecution. options Invoke options controlling this call.
getInstance(GetInstanceArgs args, {InvokeOptions? options}) → Future<GetInstanceResult>
Gets details of a single Instance. args Arguments passed to this invoke. Arguments for getInstance. options Invoke options controlling this call.
getInstanceIamPolicy(GetInstanceIamPolicyArgs args, {InvokeOptions? options}) → Future<GetInstanceIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getInstanceIamPolicy. options Invoke options controlling this call.
getInstanceIamPolicyNotebooksV2(GetInstanceIamPolicyNotebooksV2Args args, {InvokeOptions? options}) → Future<GetInstanceIamPolicyNotebooksV2Result>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getInstanceIamPolicy. options Invoke options controlling this call.
getInstanceNotebooksV2(GetInstanceNotebooksV2Args args, {InvokeOptions? options}) → Future<GetInstanceNotebooksV2Result>
Gets details of a single Instance. args Arguments passed to this invoke. Arguments for getInstance. options Invoke options controlling this call.
getRuntime(GetRuntimeArgs args, {InvokeOptions? options}) → Future<GetRuntimeResult>
Gets details of a single Runtime. The location must be a regional endpoint rather than zonal. args Arguments passed to this invoke. Arguments for getRuntime. options Invoke options controlling this call.
getRuntimeIamPolicy(GetRuntimeIamPolicyArgs args, {InvokeOptions? options}) → Future<GetRuntimeIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getRuntimeIamPolicy. options Invoke options controlling this call.
getSchedule(GetScheduleArgs args, {InvokeOptions? options}) → Future<GetScheduleResult>
Gets details of schedule args Arguments passed to this invoke. Arguments for getSchedule. options Invoke options controlling this call.