Interface GceSetupOrBuilder (1.51.0)

Version latest

• 1.51.0 (latest)
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.3
• 1.0.6
• 0.6.2

public interface GceSetupOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract boolean containsMetadata(String key)

Optional. Custom metadata to apply to this instance.

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

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAcceleratorConfigs(int index)

public abstract 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. Currently supports only one accelerator configuration.

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

Parameter
Name	Description
index	int

Returns
Type	Description
AcceleratorConfig

getAcceleratorConfigsCount()

public abstract 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. Currently supports only one accelerator configuration.

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

Returns
Type	Description
int

getAcceleratorConfigsList()

public abstract 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. Currently supports only one accelerator configuration.

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

Returns
Type	Description
List<AcceleratorConfig>

getAcceleratorConfigsOrBuilder(int index)

public abstract 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. Currently supports only one accelerator configuration.

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

Parameter
Name	Description
index	int

Returns
Type	Description
AcceleratorConfigOrBuilder

getAcceleratorConfigsOrBuilderList()

public abstract 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. Currently supports only one accelerator configuration.

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

Returns
Type	Description
List<? extends com.google.cloud.notebooks.v2.AcceleratorConfigOrBuilder>

getBootDisk()

public abstract BootDisk getBootDisk()

Optional. The boot disk for the VM.

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

Returns
Type	Description
BootDisk	The bootDisk.

getBootDiskOrBuilder()

public abstract BootDiskOrBuilder getBootDiskOrBuilder()

Optional. The boot disk for the VM.

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

Returns
Type	Description
BootDiskOrBuilder

getContainerImage()

public abstract 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
Type	Description
ContainerImage	The containerImage.

getContainerImageOrBuilder()

public abstract 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];

Returns
Type	Description
ContainerImageOrBuilder

getDataDisks(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
DataDisk

getDataDisksCount()

public abstract 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];

Returns
Type	Description
int

getDataDisksList()

public abstract 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];

Returns
Type	Description
List<DataDisk>

getDataDisksOrBuilder(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
DataDiskOrBuilder

getDataDisksOrBuilderList()

public abstract 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];

Returns
Type	Description
List<? extends com.google.cloud.notebooks.v2.DataDiskOrBuilder>

getDisablePublicIp()

public abstract 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
Type	Description
boolean	The disablePublicIp.

getEnableIpForwarding()

public abstract 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
Type	Description
boolean	The enableIpForwarding.

getGpuDriverConfig()

public abstract GPUDriverConfig getGpuDriverConfig()

Optional. Configuration for GPU drivers.

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

Returns
Type	Description
GPUDriverConfig	The gpuDriverConfig.

getGpuDriverConfigOrBuilder()

public abstract GPUDriverConfigOrBuilder getGpuDriverConfigOrBuilder()

Optional. Configuration for GPU drivers.

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

Returns
Type	Description
GPUDriverConfigOrBuilder

getImageCase()

public abstract GceSetup.ImageCase getImageCase()

Returns
Type	Description
GceSetup.ImageCase

getMachineType()

public abstract 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
Type	Description
String	The machineType.

getMachineTypeBytes()

public abstract 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
Type	Description
ByteString	The bytes for machineType.

getMetadata() (deprecated)

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type	Description
Map<String,String>

getMetadataCount()

public abstract int getMetadataCount()

Optional. Custom metadata to apply to this instance.

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

Returns
Type	Description
int

getMetadataMap()

public abstract Map<String,String> getMetadataMap()

Optional. Custom metadata to apply to this instance.

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

Returns
Type	Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public abstract String getMetadataOrDefault(String key, String defaultValue)

Optional. Custom metadata to apply to this instance.

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

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getMetadataOrThrow(String key)

public abstract String getMetadataOrThrow(String key)

Optional. Custom metadata to apply to this instance.

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

Parameter
Name	Description
key	String

Returns
Type	Description
String

getNetworkInterfaces(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
NetworkInterface

getNetworkInterfacesCount()

public abstract 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];

Returns
Type	Description
int

getNetworkInterfacesList()

public abstract 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];

Returns
Type	Description
List<NetworkInterface>

getNetworkInterfacesOrBuilder(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
NetworkInterfaceOrBuilder

getNetworkInterfacesOrBuilderList()

public abstract 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];

Returns
Type	Description
List<? extends com.google.cloud.notebooks.v2.NetworkInterfaceOrBuilder>

getServiceAccounts(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
ServiceAccount

getServiceAccountsCount()

public abstract 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];

Returns
Type	Description
int

getServiceAccountsList()

public abstract 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];

Returns
Type	Description
List<ServiceAccount>

getServiceAccountsOrBuilder(int index)

public abstract 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];

Parameter
Name	Description
index	int

Returns
Type	Description
ServiceAccountOrBuilder

getServiceAccountsOrBuilderList()

public abstract 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];

Returns
Type	Description
List<? extends com.google.cloud.notebooks.v2.ServiceAccountOrBuilder>

getShieldedInstanceConfig()

public abstract ShieldedInstanceConfig getShieldedInstanceConfig()

Optional. Shielded VM configuration. Images using supported Shielded VM features.

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

Returns
Type	Description
ShieldedInstanceConfig	The shieldedInstanceConfig.

getShieldedInstanceConfigOrBuilder()

public abstract ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

Optional. Shielded VM configuration. Images using supported Shielded VM features.

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

Returns
Type	Description
ShieldedInstanceConfigOrBuilder

getTags(int index)

public abstract String getTags(int index)

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

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

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The tags at the given index.

getTagsBytes(int index)

public abstract ByteString getTagsBytes(int index)

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

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

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the tags at the given index.

getTagsCount()

public abstract int getTagsCount()

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

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

Returns
Type	Description
int	The count of tags.

getTagsList()

public abstract List<String> getTagsList()

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

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

Returns
Type	Description
List<String>	A list containing the tags.

getVmImage()

public abstract 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
Type	Description
VmImage	The vmImage.

getVmImageOrBuilder()

public abstract 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];

Returns
Type	Description
VmImageOrBuilder

hasBootDisk()

public abstract boolean hasBootDisk()

Optional. The boot disk for the VM.

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

Returns
Type	Description
boolean	Whether the bootDisk field is set.

hasContainerImage()

public abstract 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
Type	Description
boolean	Whether the containerImage field is set.

hasGpuDriverConfig()

public abstract boolean hasGpuDriverConfig()

Optional. Configuration for GPU drivers.

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

Returns
Type	Description
boolean	Whether the gpuDriverConfig field is set.

hasShieldedInstanceConfig()

public abstract boolean hasShieldedInstanceConfig()

Optional. Shielded VM configuration. Images using supported Shielded VM features.

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

Returns
Type	Description
boolean	Whether the shieldedInstanceConfig field is set.

hasVmImage()

public abstract 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
Type	Description
boolean	Whether the vmImage field is set.