Package com.google.cloud.notebooks.v2

Interface GceSetupOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GceSetup, GceSetup.Builder

public interface GceSetupOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsMetadata(String key)	Optional.
AcceleratorConfig	getAcceleratorConfigs(int index)	Optional.
int	getAcceleratorConfigsCount()	Optional.
List<AcceleratorConfig>	getAcceleratorConfigsList()	Optional.
AcceleratorConfigOrBuilder	getAcceleratorConfigsOrBuilder(int index)	Optional.
List<? extends AcceleratorConfigOrBuilder>	getAcceleratorConfigsOrBuilderList()	Optional.
BootDisk	getBootDisk()	Optional.
BootDiskOrBuilder	getBootDiskOrBuilder()	Optional.
ContainerImage	getContainerImage()	Optional.
ContainerImageOrBuilder	getContainerImageOrBuilder()	Optional.
DataDisk	getDataDisks(int index)	Optional.
int	getDataDisksCount()	Optional.
List<DataDisk>	getDataDisksList()	Optional.
DataDiskOrBuilder	getDataDisksOrBuilder(int index)	Optional.
List<? extends DataDiskOrBuilder>	getDataDisksOrBuilderList()	Optional.
boolean	getDisablePublicIp()	Optional.
boolean	getEnableIpForwarding()	Optional.
GPUDriverConfig	getGpuDriverConfig()	Optional.
GPUDriverConfigOrBuilder	getGpuDriverConfigOrBuilder()	Optional.
GceSetup.ImageCase	getImageCase()
String	getMachineType()	Optional.
com.google.protobuf.ByteString	getMachineTypeBytes()	Optional.
Map<String,String>	getMetadata()	Deprecated.
int	getMetadataCount()	Optional.
Map<String,String>	getMetadataMap()	Optional.
String	getMetadataOrDefault(String key, String defaultValue)	Optional.
String	getMetadataOrThrow(String key)	Optional.
NetworkInterface	getNetworkInterfaces(int index)	Optional.
int	getNetworkInterfacesCount()	Optional.
List<NetworkInterface>	getNetworkInterfacesList()	Optional.
NetworkInterfaceOrBuilder	getNetworkInterfacesOrBuilder(int index)	Optional.
List<? extends NetworkInterfaceOrBuilder>	getNetworkInterfacesOrBuilderList()	Optional.
ServiceAccount	getServiceAccounts(int index)	Optional.
int	getServiceAccountsCount()	Optional.
List<ServiceAccount>	getServiceAccountsList()	Optional.
ServiceAccountOrBuilder	getServiceAccountsOrBuilder(int index)	Optional.
List<? extends ServiceAccountOrBuilder>	getServiceAccountsOrBuilderList()	Optional.
ShieldedInstanceConfig	getShieldedInstanceConfig()	Optional.
ShieldedInstanceConfigOrBuilder	getShieldedInstanceConfigOrBuilder()	Optional.
String	getTags(int index)	Optional.
com.google.protobuf.ByteString	getTagsBytes(int index)	Optional.
int	getTagsCount()	Optional.
List<String>	getTagsList()	Optional.
VmImage	getVmImage()	Optional.
VmImageOrBuilder	getVmImageOrBuilder()	Optional.
boolean	hasBootDisk()	Optional.
boolean	hasContainerImage()	Optional.
boolean	hasGpuDriverConfig()	Optional.
boolean	hasShieldedInstanceConfig()	Optional.
boolean	hasVmImage()	Optional.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getMachineType

String getMachineType()

 Optional. The machine type of the VM instance.
 https://cloud.google.com/compute/docs/machine-resource
 

string machine_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The machineType.

getMachineTypeBytes

com.google.protobuf.ByteString getMachineTypeBytes()

 Optional. The machine type of the VM instance.
 https://cloud.google.com/compute/docs/machine-resource
 

string machine_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for machineType.

getAcceleratorConfigsList

List<AcceleratorConfig> getAcceleratorConfigsList()

 Optional. The hardware accelerators used on this instance. If you use
 accelerators, make sure that your configuration has
 [enough vCPUs and memory to support the `machine_type` you have
 selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
 Currently supports only one accelerator configuration.
 

repeated .google.cloud.notebooks.v2.AcceleratorConfig accelerator_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

getAcceleratorConfigs

AcceleratorConfig getAcceleratorConfigs(int index)

 Optional. The hardware accelerators used on this instance. If you use
 accelerators, make sure that your configuration has
 [enough vCPUs and memory to support the `machine_type` you have
 selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
 Currently supports only one accelerator configuration.
 

repeated .google.cloud.notebooks.v2.AcceleratorConfig accelerator_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

getAcceleratorConfigsCount

int getAcceleratorConfigsCount()

 Optional. The hardware accelerators used on this instance. If you use
 accelerators, make sure that your configuration has
 [enough vCPUs and memory to support the `machine_type` you have
 selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
 Currently supports only one accelerator configuration.
 

repeated .google.cloud.notebooks.v2.AcceleratorConfig accelerator_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

getAcceleratorConfigsOrBuilderList

List<? extends AcceleratorConfigOrBuilder> getAcceleratorConfigsOrBuilderList()

 Optional. The hardware accelerators used on this instance. If you use
 accelerators, make sure that your configuration has
 [enough vCPUs and memory to support the `machine_type` you have
 selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
 Currently supports only one accelerator configuration.
 

repeated .google.cloud.notebooks.v2.AcceleratorConfig accelerator_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

getAcceleratorConfigsOrBuilder

AcceleratorConfigOrBuilder getAcceleratorConfigsOrBuilder(int index)

 Optional. The hardware accelerators used on this instance. If you use
 accelerators, make sure that your configuration has
 [enough vCPUs and memory to support the `machine_type` you have
 selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
 Currently supports only one accelerator configuration.
 

repeated .google.cloud.notebooks.v2.AcceleratorConfig accelerator_configs = 2 [(.google.api.field_behavior) = OPTIONAL];

getServiceAccountsList

List<ServiceAccount> getServiceAccountsList()

 Optional. The service account that serves as an identity for the VM
 instance. Currently supports only one service account.
 

repeated .google.cloud.notebooks.v2.ServiceAccount service_accounts = 3 [(.google.api.field_behavior) = OPTIONAL];

getServiceAccounts

ServiceAccount getServiceAccounts(int index)

 Optional. The service account that serves as an identity for the VM
 instance. Currently supports only one service account.
 

repeated .google.cloud.notebooks.v2.ServiceAccount service_accounts = 3 [(.google.api.field_behavior) = OPTIONAL];

getServiceAccountsCount

int getServiceAccountsCount()

 Optional. The service account that serves as an identity for the VM
 instance. Currently supports only one service account.
 

repeated .google.cloud.notebooks.v2.ServiceAccount service_accounts = 3 [(.google.api.field_behavior) = OPTIONAL];

getServiceAccountsOrBuilderList

List<? extends ServiceAccountOrBuilder> getServiceAccountsOrBuilderList()

 Optional. The service account that serves as an identity for the VM
 instance. Currently supports only one service account.
 

repeated .google.cloud.notebooks.v2.ServiceAccount service_accounts = 3 [(.google.api.field_behavior) = OPTIONAL];

getServiceAccountsOrBuilder

ServiceAccountOrBuilder getServiceAccountsOrBuilder(int index)

 Optional. The service account that serves as an identity for the VM
 instance. Currently supports only one service account.
 

repeated .google.cloud.notebooks.v2.ServiceAccount service_accounts = 3 [(.google.api.field_behavior) = OPTIONAL];

hasVmImage

boolean hasVmImage()

 Optional. Use a Compute Engine VM image to start the notebook instance.
 

.google.cloud.notebooks.v2.VmImage vm_image = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the vmImage field is set.

getVmImage

VmImage getVmImage()

 Optional. Use a Compute Engine VM image to start the notebook instance.
 

.google.cloud.notebooks.v2.VmImage vm_image = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The vmImage.

getVmImageOrBuilder

VmImageOrBuilder getVmImageOrBuilder()

 Optional. Use a Compute Engine VM image to start the notebook instance.
 

.google.cloud.notebooks.v2.VmImage vm_image = 4 [(.google.api.field_behavior) = OPTIONAL];

hasContainerImage

boolean hasContainerImage()

 Optional. Use a container image to start the notebook instance.
 

.google.cloud.notebooks.v2.ContainerImage container_image = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the containerImage field is set.

getContainerImage

ContainerImage getContainerImage()

 Optional. Use a container image to start the notebook instance.
 

.google.cloud.notebooks.v2.ContainerImage container_image = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The containerImage.

getContainerImageOrBuilder

ContainerImageOrBuilder getContainerImageOrBuilder()

 Optional. Use a container image to start the notebook instance.
 

.google.cloud.notebooks.v2.ContainerImage container_image = 5 [(.google.api.field_behavior) = OPTIONAL];

hasBootDisk

boolean hasBootDisk()

 Optional. The boot disk for the VM.
 

.google.cloud.notebooks.v2.BootDisk boot_disk = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the bootDisk field is set.

getBootDisk

BootDisk getBootDisk()

 Optional. The boot disk for the VM.
 

.google.cloud.notebooks.v2.BootDisk boot_disk = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bootDisk.

getBootDiskOrBuilder

BootDiskOrBuilder getBootDiskOrBuilder()

 Optional. The boot disk for the VM.
 

.google.cloud.notebooks.v2.BootDisk boot_disk = 6 [(.google.api.field_behavior) = OPTIONAL];

getDataDisksList

List<DataDisk> getDataDisksList()

 Optional. Data disks attached to the VM instance.
 Currently supports only one data disk.
 

repeated .google.cloud.notebooks.v2.DataDisk data_disks = 7 [(.google.api.field_behavior) = OPTIONAL];

getDataDisks

DataDisk getDataDisks(int index)

 Optional. Data disks attached to the VM instance.
 Currently supports only one data disk.
 

repeated .google.cloud.notebooks.v2.DataDisk data_disks = 7 [(.google.api.field_behavior) = OPTIONAL];

getDataDisksCount

int getDataDisksCount()

 Optional. Data disks attached to the VM instance.
 Currently supports only one data disk.
 

repeated .google.cloud.notebooks.v2.DataDisk data_disks = 7 [(.google.api.field_behavior) = OPTIONAL];

getDataDisksOrBuilderList

List<? extends DataDiskOrBuilder> getDataDisksOrBuilderList()

 Optional. Data disks attached to the VM instance.
 Currently supports only one data disk.
 

repeated .google.cloud.notebooks.v2.DataDisk data_disks = 7 [(.google.api.field_behavior) = OPTIONAL];

getDataDisksOrBuilder

DataDiskOrBuilder getDataDisksOrBuilder(int index)

 Optional. Data disks attached to the VM instance.
 Currently supports only one data disk.
 

repeated .google.cloud.notebooks.v2.DataDisk data_disks = 7 [(.google.api.field_behavior) = OPTIONAL];

hasShieldedInstanceConfig

boolean hasShieldedInstanceConfig()

 Optional. Shielded VM configuration.
 [Images using supported Shielded VM
 features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
 

.google.cloud.notebooks.v2.ShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the shieldedInstanceConfig field is set.

getShieldedInstanceConfig

ShieldedInstanceConfig getShieldedInstanceConfig()

 Optional. Shielded VM configuration.
 [Images using supported Shielded VM
 features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
 

.google.cloud.notebooks.v2.ShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The shieldedInstanceConfig.

getShieldedInstanceConfigOrBuilder

ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

 Optional. Shielded VM configuration.
 [Images using supported Shielded VM
 features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
 

.google.cloud.notebooks.v2.ShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];

getNetworkInterfacesList

List<NetworkInterface> getNetworkInterfacesList()

 Optional. The network interfaces for the VM.
 Supports only one interface.
 

repeated .google.cloud.notebooks.v2.NetworkInterface network_interfaces = 9 [(.google.api.field_behavior) = OPTIONAL];

getNetworkInterfaces

NetworkInterface getNetworkInterfaces(int index)

 Optional. The network interfaces for the VM.
 Supports only one interface.
 

repeated .google.cloud.notebooks.v2.NetworkInterface network_interfaces = 9 [(.google.api.field_behavior) = OPTIONAL];

getNetworkInterfacesCount

int getNetworkInterfacesCount()

 Optional. The network interfaces for the VM.
 Supports only one interface.
 

repeated .google.cloud.notebooks.v2.NetworkInterface network_interfaces = 9 [(.google.api.field_behavior) = OPTIONAL];

getNetworkInterfacesOrBuilderList

List<? extends NetworkInterfaceOrBuilder> getNetworkInterfacesOrBuilderList()

 Optional. The network interfaces for the VM.
 Supports only one interface.
 

repeated .google.cloud.notebooks.v2.NetworkInterface network_interfaces = 9 [(.google.api.field_behavior) = OPTIONAL];

getNetworkInterfacesOrBuilder

NetworkInterfaceOrBuilder getNetworkInterfacesOrBuilder(int index)

 Optional. The network interfaces for the VM.
 Supports only one interface.
 

repeated .google.cloud.notebooks.v2.NetworkInterface network_interfaces = 9 [(.google.api.field_behavior) = OPTIONAL];

getDisablePublicIp

boolean getDisablePublicIp()

 Optional. If true, no external IP will be assigned to this VM instance.
 

bool disable_public_ip = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The disablePublicIp.

getTagsList

List<String> getTagsList()

 Optional. The Compute Engine tags to add to runtime (see [Tagging
 instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the tags.

getTagsCount

int getTagsCount()

 Optional. The Compute Engine tags to add to runtime (see [Tagging
 instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The count of tags.

getTags

String getTags(int index)

 Optional. The Compute Engine tags to add to runtime (see [Tagging
 instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the element to return.

Returns:

The tags at the given index.

getTagsBytes

com.google.protobuf.ByteString getTagsBytes(int index)

 Optional. The Compute Engine tags to add to runtime (see [Tagging
 instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the tags at the given index.

getMetadataCount

int getMetadataCount()

 Optional. Custom metadata to apply to this instance.
 

map<string, string> metadata = 12 [(.google.api.field_behavior) = OPTIONAL];

containsMetadata

boolean containsMetadata(String key)

 Optional. Custom metadata to apply to this instance.
 

map<string, string> metadata = 12 [(.google.api.field_behavior) = OPTIONAL];

getMetadata

@Deprecated
Map<String,String> getMetadata()

Deprecated.

Use getMetadataMap() instead.

getMetadataMap

Map<String,String> getMetadataMap()

 Optional. Custom metadata to apply to this instance.
 

map<string, string> metadata = 12 [(.google.api.field_behavior) = OPTIONAL];

getMetadataOrDefault

String getMetadataOrDefault(String key,
                            String defaultValue)

 Optional. Custom metadata to apply to this instance.
 

map<string, string> metadata = 12 [(.google.api.field_behavior) = OPTIONAL];

getMetadataOrThrow

String getMetadataOrThrow(String key)

 Optional. Custom metadata to apply to this instance.
 

map<string, string> metadata = 12 [(.google.api.field_behavior) = OPTIONAL];

getEnableIpForwarding

boolean getEnableIpForwarding()

 Optional. Flag to enable ip forwarding or not, default false/off.
 https://cloud.google.com/vpc/docs/using-routes#canipforward
 

bool enable_ip_forwarding = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The enableIpForwarding.

hasGpuDriverConfig

boolean hasGpuDriverConfig()

 Optional. Configuration for GPU drivers.
 

.google.cloud.notebooks.v2.GPUDriverConfig gpu_driver_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the gpuDriverConfig field is set.

getGpuDriverConfig

GPUDriverConfig getGpuDriverConfig()

 Optional. Configuration for GPU drivers.
 

.google.cloud.notebooks.v2.GPUDriverConfig gpu_driver_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The gpuDriverConfig.

getGpuDriverConfigOrBuilder

GPUDriverConfigOrBuilder getGpuDriverConfigOrBuilder()

 Optional. Configuration for GPU drivers.
 

.google.cloud.notebooks.v2.GPUDriverConfig gpu_driver_config = 14 [(.google.api.field_behavior) = OPTIONAL];

getImageCase

GceSetup.ImageCase getImageCase()