AI Platform Notebooks V1 API - Class Google::Cloud::Notebooks::V1::VirtualMachineConfig (v0.4.2)

Reference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::VirtualMachineConfig.

The config settings for virtual machine.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#accelerator_config

def accelerator_config() -> ::Google::Cloud::Notebooks::V1::RuntimeAcceleratorConfig
Returns

#accelerator_config=

def accelerator_config=(value) -> ::Google::Cloud::Notebooks::V1::RuntimeAcceleratorConfig
Parameter
Returns

#boot_image

def boot_image() -> ::Google::Cloud::Notebooks::V1::VirtualMachineConfig::BootImage
Returns

#boot_image=

def boot_image=(value) -> ::Google::Cloud::Notebooks::V1::VirtualMachineConfig::BootImage
Parameter
Returns

#container_images

def container_images() -> ::Array<::Google::Cloud::Notebooks::V1::ContainerImage>
Returns

#container_images=

def container_images=(value) -> ::Array<::Google::Cloud::Notebooks::V1::ContainerImage>
Parameter
Returns

#data_disk

def data_disk() -> ::Google::Cloud::Notebooks::V1::LocalDisk
Returns

#data_disk=

def data_disk=(value) -> ::Google::Cloud::Notebooks::V1::LocalDisk
Parameter
Returns

#encryption_config

def encryption_config() -> ::Google::Cloud::Notebooks::V1::EncryptionConfig
Returns

#encryption_config=

def encryption_config=(value) -> ::Google::Cloud::Notebooks::V1::EncryptionConfig
Parameter
Returns

#guest_attributes

def guest_attributes() -> ::Google::Protobuf::Map{::String => ::String}
Returns

#internal_ip_only

def internal_ip_only() -> ::Boolean
Returns
  • (::Boolean) — Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.

#internal_ip_only=

def internal_ip_only=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.
Returns
  • (::Boolean) — Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

#machine_type

def machine_type() -> ::String
Returns
  • (::String) —

    Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples:

    • n1-standard-2
    • e2-standard-8

#machine_type=

def machine_type=(value) -> ::String
Parameter
  • value (::String) —

    Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples:

    • n1-standard-2
    • e2-standard-8
Returns
  • (::String) —

    Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples:

    • n1-standard-2
    • e2-standard-8

#metadata

def metadata() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).

#metadata=

def metadata=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).

#network

def network() -> ::String
Returns
  • (::String) —

    Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists.

    A full URL or partial URI. Examples:

    • https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
    • projects/[project_id]/global/networks/default

    Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:

    • Google Managed Network (Network & subnet are empty)
    • Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
    • Shared VPC (network & subnet are required). Requires configuring Private Service Access.

#network=

def network=(value) -> ::String
Parameter
  • value (::String) —

    Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists.

    A full URL or partial URI. Examples:

    • https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
    • projects/[project_id]/global/networks/default

    Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:

    • Google Managed Network (Network & subnet are empty)
    • Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
    • Shared VPC (network & subnet are required). Requires configuring Private Service Access.
Returns
  • (::String) —

    Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists.

    A full URL or partial URI. Examples:

    • https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
    • projects/[project_id]/global/networks/default

    Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:

    • Google Managed Network (Network & subnet are empty)
    • Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
    • Shared VPC (network & subnet are required). Requires configuring Private Service Access.

#nic_type

def nic_type() -> ::Google::Cloud::Notebooks::V1::VirtualMachineConfig::NicType
Returns

#nic_type=

def nic_type=(value) -> ::Google::Cloud::Notebooks::V1::VirtualMachineConfig::NicType
Parameter
Returns

#reserved_ip_range

def reserved_ip_range() -> ::String
Returns
  • (::String) — Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned.

    Example: managed-notebooks-range-c

    PEERING_RANGE_NAME_3=managed-notebooks-range-c
gcloud compute addresses create $PEERING_RANGE_NAME_3 \
  --global \
  --prefix-length=24 \
  --description="Google Cloud Managed Notebooks Range 24 c" \
  --network=$NETWORK \
  --addresses=192.168.0.0 \
  --purpose=VPC_PEERING

    Field value will be: managed-notebooks-range-c

#reserved_ip_range=

def reserved_ip_range=(value) -> ::String
Parameter
  • value (::String) — Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned.

    Example: managed-notebooks-range-c

    PEERING_RANGE_NAME_3=managed-notebooks-range-c
gcloud compute addresses create $PEERING_RANGE_NAME_3 \
  --global \
  --prefix-length=24 \
  --description="Google Cloud Managed Notebooks Range 24 c" \
  --network=$NETWORK \
  --addresses=192.168.0.0 \
  --purpose=VPC_PEERING

    Field value will be: managed-notebooks-range-c

Returns
  • (::String) — Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned.

    Example: managed-notebooks-range-c

    PEERING_RANGE_NAME_3=managed-notebooks-range-c
gcloud compute addresses create $PEERING_RANGE_NAME_3 \
  --global \
  --prefix-length=24 \
  --description="Google Cloud Managed Notebooks Range 24 c" \
  --network=$NETWORK \
  --addresses=192.168.0.0 \
  --purpose=VPC_PEERING

    Field value will be: managed-notebooks-range-c

#shielded_instance_config

def shielded_instance_config() -> ::Google::Cloud::Notebooks::V1::RuntimeShieldedInstanceConfig
Returns

#shielded_instance_config=

def shielded_instance_config=(value) -> ::Google::Cloud::Notebooks::V1::RuntimeShieldedInstanceConfig
Parameter
Returns

#subnet

def subnet() -> ::String
Returns
  • (::String) —

    Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network.

    A full URL or partial URI are valid. Examples:

    • https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
    • projects/[project_id]/regions/us-east1/subnetworks/sub0

#subnet=

def subnet=(value) -> ::String
Parameter
  • value (::String) —

    Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network.

    A full URL or partial URI are valid. Examples:

    • https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
    • projects/[project_id]/regions/us-east1/subnetworks/sub0
Returns
  • (::String) —

    Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network.

    A full URL or partial URI are valid. Examples:

    • https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
    • projects/[project_id]/regions/us-east1/subnetworks/sub0

#tags

def tags() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. The Compute Engine tags to add to runtime (see Tagging instances).

#tags=

def tags=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. The Compute Engine tags to add to runtime (see Tagging instances).
Returns
  • (::Array<::String>) — Optional. The Compute Engine tags to add to runtime (see Tagging instances).

#zone

def zone() -> ::String
Returns
  • (::String) —

    Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example:

    • us-central1-b