Class Instance (1.28.0)

public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder

The definition of a notebook instance.

Protobuf type google.cloud.notebooks.v1beta1.Instance

Implements

InstanceOrBuilder

Static Fields

ACCELERATOR_CONFIG_FIELD_NUMBER

public static final int ACCELERATOR_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

BOOT_DISK_SIZE_GB_FIELD_NUMBER

public static final int BOOT_DISK_SIZE_GB_FIELD_NUMBER
Field Value
TypeDescription
int

BOOT_DISK_TYPE_FIELD_NUMBER

public static final int BOOT_DISK_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

CAN_IP_FORWARD_FIELD_NUMBER

public static final int CAN_IP_FORWARD_FIELD_NUMBER
Field Value
TypeDescription
int

CONTAINER_IMAGE_FIELD_NUMBER

public static final int CONTAINER_IMAGE_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER

public static final int CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_DISK_SIZE_GB_FIELD_NUMBER

public static final int DATA_DISK_SIZE_GB_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_DISK_TYPE_FIELD_NUMBER

public static final int DATA_DISK_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

DISK_ENCRYPTION_FIELD_NUMBER

public static final int DISK_ENCRYPTION_FIELD_NUMBER
Field Value
TypeDescription
int

INSTALL_GPU_DRIVER_FIELD_NUMBER

public static final int INSTALL_GPU_DRIVER_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_OWNERS_FIELD_NUMBER

public static final int INSTANCE_OWNERS_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MACHINE_TYPE_FIELD_NUMBER

public static final int MACHINE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

NIC_TYPE_FIELD_NUMBER

public static final int NIC_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

NO_PROXY_ACCESS_FIELD_NUMBER

public static final int NO_PROXY_ACCESS_FIELD_NUMBER
Field Value
TypeDescription
int

NO_PUBLIC_IP_FIELD_NUMBER

public static final int NO_PUBLIC_IP_FIELD_NUMBER
Field Value
TypeDescription
int

NO_REMOVE_DATA_DISK_FIELD_NUMBER

public static final int NO_REMOVE_DATA_DISK_FIELD_NUMBER
Field Value
TypeDescription
int

POST_STARTUP_SCRIPT_FIELD_NUMBER

public static final int POST_STARTUP_SCRIPT_FIELD_NUMBER
Field Value
TypeDescription
int

PROXY_URI_FIELD_NUMBER

public static final int PROXY_URI_FIELD_NUMBER
Field Value
TypeDescription
int

RESERVATION_AFFINITY_FIELD_NUMBER

public static final int RESERVATION_AFFINITY_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNET_FIELD_NUMBER

public static final int SUBNET_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

VM_IMAGE_FIELD_NUMBER

public static final int VM_IMAGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Instance getDefaultInstance()
Returns
TypeDescription
Instance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Instance.Builder newBuilder()
Returns
TypeDescription
Instance.Builder

newBuilder(Instance prototype)

public static Instance.Builder newBuilder(Instance prototype)
Parameter
NameDescription
prototypeInstance
Returns
TypeDescription
Instance.Builder

parseDelimitedFrom(InputStream input)

public static Instance parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Instance parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Instance parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Instance parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Instance parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Instance parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Instance> parser()
Returns
TypeDescription
Parser<Instance>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 21;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsMetadata(String key)

public boolean containsMetadata(String key)

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAcceleratorConfig()

public Instance.AcceleratorConfig getAcceleratorConfig()

The hardware accelerator 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.

.google.cloud.notebooks.v1beta1.Instance.AcceleratorConfig accelerator_config = 9;

Returns
TypeDescription
Instance.AcceleratorConfig

The acceleratorConfig.

getAcceleratorConfigOrBuilder()

public Instance.AcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()

The hardware accelerator 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.

.google.cloud.notebooks.v1beta1.Instance.AcceleratorConfig accelerator_config = 9;

Returns
TypeDescription
Instance.AcceleratorConfigOrBuilder

getBootDiskSizeGb()

public long getBootDiskSizeGb()

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.

int64 boot_disk_size_gb = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
long

The bootDiskSizeGb.

getBootDiskType()

public Instance.DiskType getBootDiskType()

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

.google.cloud.notebooks.v1beta1.Instance.DiskType boot_disk_type = 13 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
Instance.DiskType

The bootDiskType.

getBootDiskTypeValue()

public int getBootDiskTypeValue()

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

.google.cloud.notebooks.v1beta1.Instance.DiskType boot_disk_type = 13 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for bootDiskType.

getCanIpForward()

public boolean getCanIpForward()

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

bool can_ip_forward = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The canIpForward.

getContainerImage()

public ContainerImage getContainerImage()

Use a container image to start the notebook instance.

.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;

Returns
TypeDescription
ContainerImage

The containerImage.

getContainerImageOrBuilder()

public ContainerImageOrBuilder getContainerImageOrBuilder()

Use a container image to start the notebook instance.

.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;

Returns
TypeDescription
ContainerImageOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Instance creation time.

.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Instance creation time.

.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getCustomGpuDriverPath()

public String getCustomGpuDriverPath()

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

string custom_gpu_driver_path = 12;

Returns
TypeDescription
String

The customGpuDriverPath.

getCustomGpuDriverPathBytes()

public ByteString getCustomGpuDriverPathBytes()

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

string custom_gpu_driver_path = 12;

Returns
TypeDescription
ByteString

The bytes for customGpuDriverPath.

getDataDiskSizeGb()

public long getDataDiskSizeGb()

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.

int64 data_disk_size_gb = 26 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
long

The dataDiskSizeGb.

getDataDiskType()

public Instance.DiskType getDataDiskType()

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

.google.cloud.notebooks.v1beta1.Instance.DiskType data_disk_type = 25 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
Instance.DiskType

The dataDiskType.

getDataDiskTypeValue()

public int getDataDiskTypeValue()

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

.google.cloud.notebooks.v1beta1.Instance.DiskType data_disk_type = 25 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for dataDiskType.

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
TypeDescription
Instance

getDiskEncryption()

public Instance.DiskEncryption getDiskEncryption()

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

.google.cloud.notebooks.v1beta1.Instance.DiskEncryption disk_encryption = 15 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
Instance.DiskEncryption

The diskEncryption.

getDiskEncryptionValue()

public int getDiskEncryptionValue()

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

.google.cloud.notebooks.v1beta1.Instance.DiskEncryption disk_encryption = 15 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for diskEncryption.

getEnvironmentCase()

public Instance.EnvironmentCase getEnvironmentCase()
Returns
TypeDescription
Instance.EnvironmentCase

getInstallGpuDriver()

public boolean getInstallGpuDriver()

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.

bool install_gpu_driver = 11;

Returns
TypeDescription
boolean

The installGpuDriver.

getInstanceOwners(int index)

public String getInstanceOwners(int index)

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.

repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The instanceOwners at the given index.

getInstanceOwnersBytes(int index)

public ByteString getInstanceOwnersBytes(int index)

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.

repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the instanceOwners at the given index.

getInstanceOwnersCount()

public int getInstanceOwnersCount()

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.

repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
int

The count of instanceOwners.

getInstanceOwnersList()

public ProtocolStringList getInstanceOwnersList()

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.

repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
ProtocolStringList

A list containing the instanceOwners.

getKmsKey()

public String getKmsKey()

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.

string kms_key = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

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.

string kms_key = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for kmsKey.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 21;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 21;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 21;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 21;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMachineType()

public String getMachineType()

Required. The Compute Engine machine type of this instance.

string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The machineType.

getMachineTypeBytes()

public ByteString getMachineTypeBytes()

Required. The Compute Engine machine type of this instance.

string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for machineType.

getMetadata()

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,String>

getMetadataCount()

public int getMetadataCount()

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Returns
TypeDescription
int

getMetadataMap()

public Map<String,String> getMetadataMap()

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Returns
TypeDescription
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public String getMetadataOrDefault(String key, String defaultValue)

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getMetadataOrThrow(String key)

public String getMetadataOrThrow(String key)

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getNetwork()

public String getNetwork()

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

string network = 19;

Returns
TypeDescription
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

string network = 19;

Returns
TypeDescription
ByteString

The bytes for network.

getNicType()

public Instance.NicType getNicType()

Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

.google.cloud.notebooks.v1beta1.Instance.NicType nic_type = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Instance.NicType

The nicType.

getNicTypeValue()

public int getNicTypeValue()

Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

.google.cloud.notebooks.v1beta1.Instance.NicType nic_type = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The enum numeric value on the wire for nicType.

getNoProxyAccess()

public boolean getNoProxyAccess()

If true, the notebook instance will not register with the proxy.

bool no_proxy_access = 18;

Returns
TypeDescription
boolean

The noProxyAccess.

getNoPublicIp()

public boolean getNoPublicIp()

If true, no public IP will be assigned to this instance.

bool no_public_ip = 17;

Returns
TypeDescription
boolean

The noPublicIp.

getNoRemoveDataDisk()

public boolean getNoRemoveDataDisk()

Input only. If true, the data disk will not be auto deleted when deleting the instance.

bool no_remove_data_disk = 27 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
boolean

The noRemoveDataDisk.

getParserForType()

public Parser<Instance> getParserForType()
Returns
TypeDescription
Parser<Instance>
Overrides

getPostStartupScript()

public String getPostStartupScript()

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).

string post_startup_script = 4;

Returns
TypeDescription
String

The postStartupScript.

getPostStartupScriptBytes()

public ByteString getPostStartupScriptBytes()

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).

string post_startup_script = 4;

Returns
TypeDescription
ByteString

The bytes for postStartupScript.

getProxyUri()

public String getProxyUri()

Output only. The proxy endpoint that is used to access the Jupyter notebook.

string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The proxyUri.

getProxyUriBytes()

public ByteString getProxyUriBytes()

Output only. The proxy endpoint that is used to access the Jupyter notebook.

string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for proxyUri.

getReservationAffinity()

public ReservationAffinity getReservationAffinity()

Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.

.google.cloud.notebooks.v1beta1.ReservationAffinity reservation_affinity = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ReservationAffinity

The reservationAffinity.

getReservationAffinityOrBuilder()

public ReservationAffinityOrBuilder getReservationAffinityOrBuilder()

Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.

.google.cloud.notebooks.v1beta1.ReservationAffinity reservation_affinity = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ReservationAffinityOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServiceAccount()

public String getServiceAccount()

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.

string service_account = 7;

Returns
TypeDescription
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

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.

string service_account = 7;

Returns
TypeDescription
ByteString

The bytes for serviceAccount.

getState()

public Instance.State getState()

Output only. The state of this instance.

.google.cloud.notebooks.v1beta1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Instance.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of this instance.

.google.cloud.notebooks.v1beta1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getSubnet()

public String getSubnet()

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

string subnet = 20;

Returns
TypeDescription
String

The subnet.

getSubnetBytes()

public ByteString getSubnetBytes()

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

string subnet = 20;

Returns
TypeDescription
ByteString

The bytes for subnet.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Instance update time.

.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Instance update time.

.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getVmImage()

public VmImage getVmImage()

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

.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;

Returns
TypeDescription
VmImage

The vmImage.

getVmImageOrBuilder()

public VmImageOrBuilder getVmImageOrBuilder()

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

.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;

Returns
TypeDescription
VmImageOrBuilder

hasAcceleratorConfig()

public boolean hasAcceleratorConfig()

The hardware accelerator 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.

.google.cloud.notebooks.v1beta1.Instance.AcceleratorConfig accelerator_config = 9;

Returns
TypeDescription
boolean

Whether the acceleratorConfig field is set.

hasContainerImage()

public boolean hasContainerImage()

Use a container image to start the notebook instance.

.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;

Returns
TypeDescription
boolean

Whether the containerImage field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Instance creation time.

.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasReservationAffinity()

public boolean hasReservationAffinity()

Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.

.google.cloud.notebooks.v1beta1.ReservationAffinity reservation_affinity = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the reservationAffinity field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Instance update time.

.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hasVmImage()

public boolean hasVmImage()

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

.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;

Returns
TypeDescription
boolean

Whether the vmImage field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Instance.Builder newBuilderForType()
Returns
TypeDescription
Instance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Instance.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Instance.Builder toBuilder()
Returns
TypeDescription
Instance.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException