public final class GceSetup extends GeneratedMessageV3 implements GceSetupOrBuilder
The definition of how to configure a VM instance outside of Resources and
Identity.
Protobuf type google.cloud.notebooks.v2.GceSetup
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ACCELERATOR_CONFIGS_FIELD_NUMBER
public static final int ACCELERATOR_CONFIGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BOOT_DISK_FIELD_NUMBER
public static final int BOOT_DISK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONTAINER_IMAGE_FIELD_NUMBER
public static final int CONTAINER_IMAGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATA_DISKS_FIELD_NUMBER
public static final int DATA_DISKS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISABLE_PUBLIC_IP_FIELD_NUMBER
public static final int DISABLE_PUBLIC_IP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENABLE_IP_FORWARDING_FIELD_NUMBER
public static final int ENABLE_IP_FORWARDING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GPU_DRIVER_CONFIG_FIELD_NUMBER
public static final int GPU_DRIVER_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MACHINE_TYPE_FIELD_NUMBER
public static final int MACHINE_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NETWORK_INTERFACES_FIELD_NUMBER
public static final int NETWORK_INTERFACES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SERVICE_ACCOUNTS_FIELD_NUMBER
public static final int SERVICE_ACCOUNTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
public static final int SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TAGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VM_IMAGE_FIELD_NUMBER
public static final int VM_IMAGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static GceSetup getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static GceSetup.Builder newBuilder()
newBuilder(GceSetup prototype)
public static GceSetup.Builder newBuilder(GceSetup prototype)
| Parameter |
| Name |
Description |
prototype |
GceSetup
|
public static GceSetup parseDelimitedFrom(InputStream input)
public static GceSetup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static GceSetup parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GceSetup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static GceSetup parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GceSetup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GceSetup parseFrom(CodedInputStream input)
public static GceSetup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GceSetup parseFrom(InputStream input)
public static GceSetup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static GceSetup parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GceSetup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<GceSetup> parser()
Methods
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAcceleratorConfigs(int index)
public 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
|
getAcceleratorConfigsCount()
public 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 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];
getAcceleratorConfigsOrBuilder(int index)
public 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
|
getAcceleratorConfigsOrBuilderList()
public 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 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 BootDiskOrBuilder getBootDiskOrBuilder()
Optional. The boot disk for the VM.
.google.cloud.notebooks.v2.BootDisk boot_disk = 6 [(.google.api.field_behavior) = OPTIONAL];
getContainerImage()
public 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];
getContainerImageOrBuilder()
public 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];
getDataDisks(int index)
public 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
|
getDataDisksCount()
public 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 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];
getDataDisksOrBuilder(int index)
public 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
|
getDataDisksOrBuilderList()
public 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> |
|
getDefaultInstanceForType()
public GceSetup getDefaultInstanceForType()
getDisablePublicIp()
public 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 boolean getEnableIpForwarding()
| Returns |
| Type |
Description |
boolean |
The enableIpForwarding.
|
getGpuDriverConfig()
public GPUDriverConfig getGpuDriverConfig()
Optional. Configuration for GPU drivers.
.google.cloud.notebooks.v2.GPUDriverConfig gpu_driver_config = 14 [(.google.api.field_behavior) = OPTIONAL];
getGpuDriverConfigOrBuilder()
public GPUDriverConfigOrBuilder getGpuDriverConfigOrBuilder()
Optional. Configuration for GPU drivers.
.google.cloud.notebooks.v2.GPUDriverConfig gpu_driver_config = 14 [(.google.api.field_behavior) = OPTIONAL];
getImageCase()
public GceSetup.ImageCase getImageCase()
getMachineType()
public String getMachineType()
| Returns |
| Type |
Description |
String |
The machineType.
|
getMachineTypeBytes()
public ByteString getMachineTypeBytes()
| Returns |
| Type |
Description |
ByteString |
The bytes for machineType.
|
public Map<String,String> getMetadata()
public int getMetadataCount()
Optional. Custom metadata to apply to this instance.
map<string, string> metadata = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public Map<String,String> getMetadataMap()
Optional. Custom metadata to apply to this instance.
map<string, string> metadata = 12 [(.google.api.field_behavior) = OPTIONAL];
public String getMetadataOrDefault(String key, String defaultValue)
Optional. Custom metadata to apply to this instance.
map<string, string> metadata = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
public 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 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
|
getNetworkInterfacesCount()
public 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 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];
getNetworkInterfacesOrBuilder(int index)
public 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
|
getNetworkInterfacesOrBuilderList()
public 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> |
|
getParserForType()
public Parser<GceSetup> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getServiceAccounts(int index)
public 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
|
getServiceAccountsCount()
public 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 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];
getServiceAccountsOrBuilder(int index)
public 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
|
getServiceAccountsOrBuilderList()
public 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 ShieldedInstanceConfig getShieldedInstanceConfig()
getShieldedInstanceConfigOrBuilder()
public ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()
public 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.
|
public 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.
|
public 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.
|
public ProtocolStringList getTagsList()
Optional. The Compute Engine tags to add to runtime (see Tagging
instances).
repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];
getVmImage()
public 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 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];
hasBootDisk()
public 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 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 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 boolean hasShieldedInstanceConfig()
| Returns |
| Type |
Description |
boolean |
Whether the shieldedInstanceConfig field is set.
|
hasVmImage()
public 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public GceSetup.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GceSetup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public GceSetup.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
