Class: Google::Apis::NotebooksV1::Instance

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/notebooks_v1/classes.rb,
lib/google/apis/notebooks_v1/representations.rb,
lib/google/apis/notebooks_v1/representations.rb

Overview

The definition of a notebook instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



810
811
812
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 810

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#accelerator_config ⇒ Google::Apis::NotebooksV1::AcceleratorConfig

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. Corresponds to the JSON property acceleratorConfig

Returns:



613
614
615
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 613

def accelerator_config
  @accelerator_config
end

#boot_disk_size_gb ⇒ Fixnum

Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100. Corresponds to the JSON property bootDiskSizeGb

Returns:

  • (Fixnum) 


620
621
622
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 620

def boot_disk_size_gb
  @boot_disk_size_gb
end

#boot_disk_type ⇒ String

Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD). Corresponds to the JSON property bootDiskType

Returns:

  • (String) 


626
627
628
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 626

def boot_disk_type
  @boot_disk_type
end

#container_image ⇒ Google::Apis::NotebooksV1::ContainerImage

Definition of a container image for starting a notebook instance with the environment installed in a container. Corresponds to the JSON property containerImage

Returns:



632
633
634
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 632

def container_image
  @container_image
end

#create_time ⇒ String

Output only. Instance creation time. Corresponds to the JSON property createTime

Returns:

  • (String) 


637
638
639
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 637

def create_time
  @create_time
end

#custom_gpu_driver_path ⇒ String

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. Corresponds to the JSON property customGpuDriverPath

Returns:

  • (String) 


643
644
645
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 643

def custom_gpu_driver_path
  @custom_gpu_driver_path
end

#data_disk_size_gb ⇒ Fixnum

Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100. Corresponds to the JSON property dataDiskSizeGb

Returns:

  • (Fixnum) 


650
651
652
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 650

def data_disk_size_gb
  @data_disk_size_gb
end

#data_disk_type ⇒ String

Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD). Corresponds to the JSON property dataDiskType

Returns:

  • (String) 


656
657
658
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 656

def data_disk_type
  @data_disk_type
end

#disk_encryption ⇒ String

Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. Corresponds to the JSON property diskEncryption

Returns:

  • (String) 


662
663
664
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 662

def disk_encryption
  @disk_encryption
end

#disks ⇒ Array<Google::Apis::NotebooksV1::Disk>

Output only. Attached disks to notebook instance. Corresponds to the JSON property disks

Returns:



667
668
669
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 667

def disks
  @disks
end

#install_gpu_driver ⇒ Boolean Also known as: install_gpu_driver?

Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs. Corresponds to the JSON property installGpuDriver

Returns:

  • (Boolean) 


674
675
676
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 674

def install_gpu_driver
  @install_gpu_driver
end

#instance_owners ⇒ Array<String>

Input only. The owner of this instance after creation. Format: alias@example. com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance. Corresponds to the JSON property instanceOwners

Returns:

  • (Array<String>) 


682
683
684
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 682

def instance_owners
  @instance_owners
end

#kms_key ⇒ String

Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: projects/project_id/locations/location/ keyRings/key_ring_id/cryptoKeys/key_id`Learn more about [using your own encryption keys](/kms/docs/quickstart). Corresponds to the JSON propertykmsKey`

Returns:

  • (String) 


690
691
692
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 690

def kms_key
  @kms_key
end

#labels ⇒ Hash<String,String>

Labels to apply to this instance. These can be later modified by the setLabels method. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


696
697
698
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 696

def labels
  @labels
end

#machine_type ⇒ String

Required. The Compute Engine machine type of this instance. Corresponds to the JSON property machineType

Returns:

  • (String) 


702
703
704
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 702

def machine_type
  @machine_type
end

#metadata ⇒ Hash<String,String>

Custom metadata to apply to this instance. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,String>) 


707
708
709
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 707

def metadata
  @metadata
end

#name ⇒ String

Output only. The name of this notebook instance. Format: projects/project_id /locations/location/instances/instance_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


713
714
715
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 713

def name
  @name
end

#network ⇒ String

The name of the VPC that this instance is in. Format: projects/project_id/ global/networks/network_id` Corresponds to the JSON propertynetwork`

Returns:

  • (String) 


719
720
721
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 719

def network
  @network
end

#no_proxy_access ⇒ Boolean Also known as: no_proxy_access?

If true, the notebook instance will not register with the proxy. Corresponds to the JSON property noProxyAccess

Returns:

  • (Boolean) 


724
725
726
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 724

def no_proxy_access
  @no_proxy_access
end

#no_public_ip ⇒ Boolean Also known as: no_public_ip?

If true, no public IP will be assigned to this instance. Corresponds to the JSON property noPublicIp

Returns:

  • (Boolean) 


730
731
732
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 730

def no_public_ip
  @no_public_ip
end

#no_remove_data_disk ⇒ Boolean Also known as: no_remove_data_disk?

Input only. If true, the data disk will not be auto deleted when deleting the instance. Corresponds to the JSON property noRemoveDataDisk

Returns:

  • (Boolean) 


737
738
739
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 737

def no_remove_data_disk
  @no_remove_data_disk
end

#post_startup_script ⇒ String

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file- name). Corresponds to the JSON property postStartupScript

Returns:

  • (String) 


745
746
747
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 745

def post_startup_script
  @post_startup_script
end

#proxy_uri ⇒ String

Output only. The proxy endpoint that is used to access the Jupyter notebook. Corresponds to the JSON property proxyUri

Returns:

  • (String) 


750
751
752
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 750

def proxy_uri
  @proxy_uri
end

#service_account ⇒ String

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


759
760
761
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 759

def 
  @service_account
end

#service_account_scopes ⇒ Array<String>

Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https:// www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/ userinfo.email If not using default scopes, you need at least: https://www. googleapis.com/auth/compute Corresponds to the JSON property serviceAccountScopes

Returns:

  • (Array<String>) 


769
770
771
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 769

def 
  @service_account_scopes
end

#shielded_instance_config ⇒ Google::Apis::NotebooksV1::ShieldedInstanceConfig

A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid. Corresponds to the JSON property shieldedInstanceConfig

Returns:



775
776
777
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 775

def shielded_instance_config
  @shielded_instance_config
end

#state ⇒ String

Output only. The state of this instance. Corresponds to the JSON property state

Returns:

  • (String) 


780
781
782
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 780

def state
  @state
end

#subnet ⇒ String

The name of the subnet that this instance is in. Format: projects/project_id /regions/region/subnetworks/subnetwork_id` Corresponds to the JSON propertysubnet`

Returns:

  • (String) 


786
787
788
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 786

def subnet
  @subnet
end

#tags ⇒ Array<String>

Optional. The Compute Engine tags to add to runtime (see Tagging instances). Corresponds to the JSON property tags

Returns:

  • (Array<String>) 


792
793
794
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 792

def tags
  @tags
end

#update_time ⇒ String

Output only. Instance update time. Corresponds to the JSON property updateTime

Returns:

  • (String) 


797
798
799
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 797

def update_time
  @update_time
end

#upgrade_history ⇒ Array<Google::Apis::NotebooksV1::UpgradeHistoryEntry>

The upgrade history of this instance. Corresponds to the JSON property upgradeHistory

Returns:



802
803
804
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 802

def upgrade_history
  @upgrade_history
end

#vm_image ⇒ Google::Apis::NotebooksV1::VmImage

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

Returns:



808
809
810
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 808

def vm_image
  @vm_image
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 815

def update!(**args)
  @accelerator_config = args[:accelerator_config] if args.key?(:accelerator_config)
  @boot_disk_size_gb = args[:boot_disk_size_gb] if args.key?(:boot_disk_size_gb)
  @boot_disk_type = args[:boot_disk_type] if args.key?(:boot_disk_type)
  @container_image = args[:container_image] if args.key?(:container_image)
  @create_time = args[:create_time] if args.key?(:create_time)
  @custom_gpu_driver_path = args[:custom_gpu_driver_path] if args.key?(:custom_gpu_driver_path)
  @data_disk_size_gb = args[:data_disk_size_gb] if args.key?(:data_disk_size_gb)
  @data_disk_type = args[:data_disk_type] if args.key?(:data_disk_type)
  @disk_encryption = args[:disk_encryption] if args.key?(:disk_encryption)
  @disks = args[:disks] if args.key?(:disks)
  @install_gpu_driver = args[:install_gpu_driver] if args.key?(:install_gpu_driver)
  @instance_owners = args[:instance_owners] if args.key?(:instance_owners)
  @kms_key = args[:kms_key] if args.key?(:kms_key)
  @labels = args[:labels] if args.key?(:labels)
  @machine_type = args[:machine_type] if args.key?(:machine_type)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @no_proxy_access = args[:no_proxy_access] if args.key?(:no_proxy_access)
  @no_public_ip = args[:no_public_ip] if args.key?(:no_public_ip)
  @no_remove_data_disk = args[:no_remove_data_disk] if args.key?(:no_remove_data_disk)
  @post_startup_script = args[:post_startup_script] if args.key?(:post_startup_script)
  @proxy_uri = args[:proxy_uri] if args.key?(:proxy_uri)
  @service_account = args[:service_account] if args.key?(:service_account)
  @service_account_scopes = args[:service_account_scopes] if args.key?(:service_account_scopes)
  @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config)
  @state = args[:state] if args.key?(:state)
  @subnet = args[:subnet] if args.key?(:subnet)
  @tags = args[:tags] if args.key?(:tags)
  @update_time = args[:update_time] if args.key?(:update_time)
  @upgrade_history = args[:upgrade_history] if args.key?(:upgrade_history)
  @vm_image = args[:vm_image] if args.key?(:vm_image)
end