- 1.53.0 (latest)
- 1.52.0
- 1.51.0
- 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 final class Instance extends GeneratedMessageV3 implements InstanceOrBuilderThe definition of a notebook instance.
Protobuf type google.cloud.notebooks.v1.Instance
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InstanceImplements
InstanceOrBuilderStatic Fields
ACCELERATOR_CONFIG_FIELD_NUMBER
public static final int ACCELERATOR_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BOOT_DISK_SIZE_GB_FIELD_NUMBER
public static final int BOOT_DISK_SIZE_GB_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BOOT_DISK_TYPE_FIELD_NUMBER
public static final int BOOT_DISK_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CAN_IP_FORWARD_FIELD_NUMBER
public static final int CAN_IP_FORWARD_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CONTAINER_IMAGE_FIELD_NUMBER
public static final int CONTAINER_IMAGE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATOR_FIELD_NUMBER
public static final int CREATOR_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER
public static final int CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DATA_DISK_SIZE_GB_FIELD_NUMBER
public static final int DATA_DISK_SIZE_GB_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DATA_DISK_TYPE_FIELD_NUMBER
public static final int DATA_DISK_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DISKS_FIELD_NUMBER
public static final int DISKS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DISK_ENCRYPTION_FIELD_NUMBER
public static final int DISK_ENCRYPTION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INSTALL_GPU_DRIVER_FIELD_NUMBER
public static final int INSTALL_GPU_DRIVER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INSTANCE_OWNERS_FIELD_NUMBER
public static final int INSTANCE_OWNERS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
KMS_KEY_FIELD_NUMBER
public static final int KMS_KEY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MACHINE_TYPE_FIELD_NUMBER
public static final int MACHINE_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NIC_TYPE_FIELD_NUMBER
public static final int NIC_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NO_PROXY_ACCESS_FIELD_NUMBER
public static final int NO_PROXY_ACCESS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NO_PUBLIC_IP_FIELD_NUMBER
public static final int NO_PUBLIC_IP_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NO_REMOVE_DATA_DISK_FIELD_NUMBER
public static final int NO_REMOVE_DATA_DISK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
POST_STARTUP_SCRIPT_FIELD_NUMBER
public static final int POST_STARTUP_SCRIPT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PROXY_URI_FIELD_NUMBER
public static final int PROXY_URI_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RESERVATION_AFFINITY_FIELD_NUMBER
public static final int RESERVATION_AFFINITY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SERVICE_ACCOUNT_SCOPES_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_SCOPES_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 |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SUBNET_FIELD_NUMBER
public static final int SUBNET_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPGRADE_HISTORY_FIELD_NUMBER
public static final int UPGRADE_HISTORY_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 Instance getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Instance |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Instance.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Instance.Builder |
|
newBuilder(Instance prototype)
public static Instance.Builder newBuilder(Instance prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Instance |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder |
|
parseDelimitedFrom(InputStream input)
public static Instance parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Instance parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Instance parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Instance parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Instance parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Instance parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Instance> parser()| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
containsMetadata(String key)
public boolean containsMetadata(String key)Custom metadata to apply to this instance.
map<string, string> metadata = 22;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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.v1.Instance.AcceleratorConfig accelerator_config = 9;
| Returns | |
|---|---|
| Type | Description |
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.v1.Instance.AcceleratorConfig accelerator_config = 9;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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.v1.Instance.DiskType boot_disk_type = 13 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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.v1.Instance.DiskType boot_disk_type = 13 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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 = 39 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The canIpForward. |
getContainerImage()
public ContainerImage getContainerImage()Use a container image to start the notebook instance.
.google.cloud.notebooks.v1.ContainerImage container_image = 3;
| Returns | |
|---|---|
| Type | Description |
ContainerImage |
The containerImage. |
getContainerImageOrBuilder()
public ContainerImageOrBuilder getContainerImageOrBuilder()Use a container image to start the notebook instance.
.google.cloud.notebooks.v1.ContainerImage container_image = 3;
| Returns | |
|---|---|
| Type | Description |
ContainerImageOrBuilder |
|
getCreateTime()
public Timestamp getCreateTime()Output only. Instance creation time.
.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getCreator()
public String getCreator()Output only. Email address of entity that sent original CreateInstance request.
string creator = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The creator. |
getCreatorBytes()
public ByteString getCreatorBytes()Output only. Email address of entity that sent original CreateInstance request.
string creator = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for creator. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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.v1.Instance.DiskType data_disk_type = 25 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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.v1.Instance.DiskType data_disk_type = 25 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for dataDiskType. |
getDefaultInstanceForType()
public Instance getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Instance |
|
getDiskEncryption()
public Instance.DiskEncryption getDiskEncryption()Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
.google.cloud.notebooks.v1.Instance.DiskEncryption disk_encryption = 15 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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.v1.Instance.DiskEncryption disk_encryption = 15 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for diskEncryption. |
getDisks(int index)
public Instance.Disk getDisks(int index)Output only. Attached disks to notebook instance.
repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Instance.Disk |
|
getDisksCount()
public int getDisksCount()Output only. Attached disks to notebook instance.
repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getDisksList()
public List<Instance.Disk> getDisksList()Output only. Attached disks to notebook instance.
repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Disk> |
|
getDisksOrBuilder(int index)
public Instance.DiskOrBuilder getDisksOrBuilder(int index)Output only. Attached disks to notebook instance.
repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Instance.DiskOrBuilder |
|
getDisksOrBuilderList()
public List<? extends Instance.DiskOrBuilder> getDisksOrBuilderList()Output only. Attached disks to notebook instance.
repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.notebooks.v1.Instance.DiskOrBuilder> |
|
getEnvironmentCase()
public Instance.EnvironmentCase getEnvironmentCase()| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for kmsKey. |
getLabels() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMachineType()
public String getMachineType()Required. The Compute Engine machine type of this instance.
string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for machineType. |
getMetadata() (deprecated)
public Map<String,String> getMetadata()Use #getMetadataMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMetadataCount()
public int getMetadataCount()Custom metadata to apply to this instance.
map<string, string> metadata = 22;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetadataMap()
public Map<String,String> getMetadataMap()Custom metadata to apply to this instance.
map<string, string> metadata = 22;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMetadataOrThrow(String key)
public String getMetadataOrThrow(String key)Custom metadata to apply to this instance.
map<string, string> metadata = 22;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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.v1.Instance.NicType nic_type = 33 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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.v1.Instance.NicType nic_type = 33 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
The noProxyAccess. |
getNoPublicIp()
public boolean getNoPublicIp()If true, no public IP will be assigned to this instance.
bool no_public_ip = 17;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
The noRemoveDataDisk. |
getParserForType()
public Parser<Instance> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Instance> |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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.v1.ReservationAffinity reservation_affinity = 34 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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.v1.ReservationAffinity reservation_affinity = 34 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ReservationAffinityOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccount. |
getServiceAccountScopes(int index)
public String getServiceAccountScopes(int index)Optional. The URIs of service account scopes to be included in Compute Engine instances.
If not specified, the following scopes are defined:
- https://www.googleapis.com/auth/cloud-platform
- https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The serviceAccountScopes at the given index. |
getServiceAccountScopesBytes(int index)
public ByteString getServiceAccountScopesBytes(int index)Optional. The URIs of service account scopes to be included in Compute Engine instances.
If not specified, the following scopes are defined:
- https://www.googleapis.com/auth/cloud-platform
- https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the serviceAccountScopes at the given index. |
getServiceAccountScopesCount()
public int getServiceAccountScopesCount()Optional. The URIs of service account scopes to be included in Compute Engine instances.
If not specified, the following scopes are defined:
- https://www.googleapis.com/auth/cloud-platform
- https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of serviceAccountScopes. |
getServiceAccountScopesList()
public ProtocolStringList getServiceAccountScopesList()Optional. The URIs of service account scopes to be included in Compute Engine instances.
If not specified, the following scopes are defined:
- https://www.googleapis.com/auth/cloud-platform
- https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the serviceAccountScopes. |
getShieldedInstanceConfig()
public Instance.ShieldedInstanceConfig getShieldedInstanceConfig()Optional. Shielded VM configuration. Images using supported Shielded VM features.
.google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig shielded_instance_config = 30 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Instance.ShieldedInstanceConfig |
The shieldedInstanceConfig. |
getShieldedInstanceConfigOrBuilder()
public Instance.ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()Optional. Shielded VM configuration. Images using supported Shielded VM features.
.google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig shielded_instance_config = 30 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Instance.ShieldedInstanceConfigOrBuilder |
|
getState()
public Instance.State getState()Output only. The state of this instance.
.google.cloud.notebooks.v1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Instance.State |
The state. |
getStateValue()
public int getStateValue()Output only. The state of this instance.
.google.cloud.notebooks.v1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for subnet. |
getTags(int index)
public String getTags(int index)Optional. The Compute Engine tags to add to runtime (see Tagging instances).
repeated string tags = 32 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The tags at the given index. |
getTagsBytes(int index)
public ByteString getTagsBytes(int index)Optional. The Compute Engine tags to add to runtime (see Tagging instances).
repeated string tags = 32 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the tags at the given index. |
getTagsCount()
public int getTagsCount()Optional. The Compute Engine tags to add to runtime (see Tagging instances).
repeated string tags = 32 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of tags. |
getTagsList()
public ProtocolStringList getTagsList()Optional. The Compute Engine tags to add to runtime (see Tagging instances).
repeated string tags = 32 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the tags. |
getUpdateTime()
public Timestamp getUpdateTime()Output only. Instance update time.
.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getUpgradeHistory(int index)
public Instance.UpgradeHistoryEntry getUpgradeHistory(int index)The upgrade history of this instance.
repeated .google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry upgrade_history = 29;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Instance.UpgradeHistoryEntry |
|
getUpgradeHistoryCount()
public int getUpgradeHistoryCount()The upgrade history of this instance.
repeated .google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry upgrade_history = 29;
| Returns | |
|---|---|
| Type | Description |
int |
|
getUpgradeHistoryList()
public List<Instance.UpgradeHistoryEntry> getUpgradeHistoryList()The upgrade history of this instance.
repeated .google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry upgrade_history = 29;
| Returns | |
|---|---|
| Type | Description |
List<UpgradeHistoryEntry> |
|
getUpgradeHistoryOrBuilder(int index)
public Instance.UpgradeHistoryEntryOrBuilder getUpgradeHistoryOrBuilder(int index)The upgrade history of this instance.
repeated .google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry upgrade_history = 29;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Instance.UpgradeHistoryEntryOrBuilder |
|
getUpgradeHistoryOrBuilderList()
public List<? extends Instance.UpgradeHistoryEntryOrBuilder> getUpgradeHistoryOrBuilderList()The upgrade history of this instance.
repeated .google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry upgrade_history = 29;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.notebooks.v1.Instance.UpgradeHistoryEntryOrBuilder> |
|
getVmImage()
public VmImage getVmImage()Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1.VmImage vm_image = 2;
| Returns | |
|---|---|
| Type | Description |
VmImage |
The vmImage. |
getVmImageOrBuilder()
public VmImageOrBuilder getVmImageOrBuilder()Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1.VmImage vm_image = 2;
| Returns | |
|---|---|
| Type | Description |
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.v1.Instance.AcceleratorConfig accelerator_config = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the acceleratorConfig field is set. |
hasContainerImage()
public boolean hasContainerImage()Use a container image to start the notebook instance.
.google.cloud.notebooks.v1.ContainerImage container_image = 3;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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.v1.ReservationAffinity reservation_affinity = 34 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reservationAffinity field is set. |
hasShieldedInstanceConfig()
public boolean hasShieldedInstanceConfig()Optional. Shielded VM configuration. Images using supported Shielded VM features.
.google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig shielded_instance_config = 30 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the shieldedInstanceConfig 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 | |
|---|---|
| Type | Description |
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.v1.VmImage vm_image = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the vmImage field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Instance.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Instance.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public Instance.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Instance.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|