- 1.51.0 (latest)
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.3
- 1.0.6
- 0.6.2
public static final class Instance.Builder extends GeneratedMessageV3.Builder<Instance.Builder> implements InstanceOrBuilderThe definition of a notebook instance.
Protobuf type google.cloud.notebooks.v1beta1.Instance
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Instance.BuilderImplements
InstanceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllInstanceOwners(Iterable<String> values)
public Instance.Builder addAllInstanceOwners(Iterable<String> values) 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 |
values | Iterable<String>The instanceOwners to add. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
addInstanceOwners(String value)
public Instance.Builder addInstanceOwners(String value) 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 |
value | StringThe instanceOwners to add. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
addInstanceOwnersBytes(ByteString value)
public Instance.Builder addInstanceOwnersBytes(ByteString value) 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 |
value | ByteStringThe bytes of the instanceOwners to add. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Instance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
build()
public Instance build()| Returns | |
|---|---|
| Type | Description |
Instance | |
buildPartial()
public Instance buildPartial()| Returns | |
|---|---|
| Type | Description |
Instance | |
clear()
public Instance.Builder clear()| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearAcceleratorConfig()
public Instance.Builder clearAcceleratorConfig() 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 | |
|---|---|
| Type | Description |
Instance.Builder | |
clearBootDiskSizeGb()
public Instance.Builder clearBootDiskSizeGb()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 |
Instance.Builder | This builder for chaining. |
clearBootDiskType()
public Instance.Builder clearBootDiskType() 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 | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearCanIpForward()
public Instance.Builder clearCanIpForward()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 | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearContainerImage()
public Instance.Builder clearContainerImage()Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearCreateTime()
public Instance.Builder clearCreateTime()Output only. Instance creation time.
.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearCustomGpuDriverPath()
public Instance.Builder clearCustomGpuDriverPath()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 |
Instance.Builder | This builder for chaining. |
clearDataDiskSizeGb()
public Instance.Builder clearDataDiskSizeGb()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 |
Instance.Builder | This builder for chaining. |
clearDataDiskType()
public Instance.Builder clearDataDiskType() 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 | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearDiskEncryption()
public Instance.Builder clearDiskEncryption()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 | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearEnvironment()
public Instance.Builder clearEnvironment()| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearField(Descriptors.FieldDescriptor field)
public Instance.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearInstallGpuDriver()
public Instance.Builder clearInstallGpuDriver()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 |
Instance.Builder | This builder for chaining. |
clearInstanceOwners()
public Instance.Builder clearInstanceOwners() 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 |
Instance.Builder | This builder for chaining. |
clearKmsKey()
public Instance.Builder clearKmsKey() 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 |
Instance.Builder | This builder for chaining. |
clearLabels()
public Instance.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearMachineType()
public Instance.Builder clearMachineType()Required. The Compute Engine machine type of this instance.
string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearMetadata()
public Instance.Builder clearMetadata()| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearName()
public Instance.Builder clearName() 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 |
Instance.Builder | This builder for chaining. |
clearNetwork()
public Instance.Builder clearNetwork() The name of the VPC that this instance is in.
Format:
projects/{project_id}/global/networks/{network_id}
string network = 19;
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearNicType()
public Instance.Builder clearNicType()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 | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearNoProxyAccess()
public Instance.Builder clearNoProxyAccess()If true, the notebook instance will not register with the proxy.
bool no_proxy_access = 18;
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearNoPublicIp()
public Instance.Builder clearNoPublicIp()If true, no public IP will be assigned to this instance.
bool no_public_ip = 17;
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearNoRemoveDataDisk()
public Instance.Builder clearNoRemoveDataDisk()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 |
Instance.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Instance.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearPostStartupScript()
public Instance.Builder clearPostStartupScript() 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 |
Instance.Builder | This builder for chaining. |
clearProxyUri()
public Instance.Builder clearProxyUri()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 |
Instance.Builder | This builder for chaining. |
clearReservationAffinity()
public Instance.Builder clearReservationAffinity()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 | |
|---|---|
| Type | Description |
Instance.Builder | |
clearServiceAccount()
public Instance.Builder clearServiceAccount()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 |
Instance.Builder | This builder for chaining. |
clearState()
public Instance.Builder clearState()Output only. The state of this instance.
.google.cloud.notebooks.v1beta1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
clearSubnet()
public Instance.Builder clearSubnet() 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 |
Instance.Builder | This builder for chaining. |
clearUpdateTime()
public Instance.Builder clearUpdateTime()Output only. Instance update time.
.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clearVmImage()
public Instance.Builder clearVmImage()Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
clone()
public Instance.Builder clone()| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
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 | |
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 | |
|---|---|
| Type | Description |
Instance.AcceleratorConfig | The acceleratorConfig. |
getAcceleratorConfigBuilder()
public Instance.AcceleratorConfig.Builder getAcceleratorConfigBuilder() 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 | |
|---|---|
| Type | Description |
Instance.AcceleratorConfig.Builder | |
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 | |
|---|---|
| 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.v1beta1.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.v1beta1.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 = 31 [(.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.v1beta1.ContainerImage container_image = 3;
| Returns | |
|---|---|
| Type | Description |
ContainerImage | The containerImage. |
getContainerImageBuilder()
public ContainerImage.Builder getContainerImageBuilder()Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;
| Returns | |
|---|---|
| Type | Description |
ContainerImage.Builder | |
getContainerImageOrBuilder()
public ContainerImageOrBuilder getContainerImageOrBuilder()Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Instance creation time.
.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
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 | |
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.v1beta1.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.v1beta1.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 | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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 | |
|---|---|
| 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.v1beta1.Instance.DiskEncryption disk_encryption = 15 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for diskEncryption. |
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 | |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getMutableMetadata() (deprecated)
public Map<String,String> getMutableMetadata()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,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.v1beta1.Instance.NicType nic_type = 28 [(.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.v1beta1.Instance.NicType nic_type = 28 [(.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. |
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.v1beta1.ReservationAffinity reservation_affinity = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ReservationAffinity | The reservationAffinity. |
getReservationAffinityBuilder()
public ReservationAffinity.Builder getReservationAffinityBuilder()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 | |
|---|---|
| Type | Description |
ReservationAffinity.Builder | |
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 | |
|---|---|
| Type | Description |
ReservationAffinityOrBuilder | |
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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. Instance update time.
.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
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 | |
getVmImage()
public VmImage getVmImage()Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;
| Returns | |
|---|---|
| Type | Description |
VmImage | The vmImage. |
getVmImageBuilder()
public VmImage.Builder getVmImageBuilder()Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;
| Returns | |
|---|---|
| Type | Description |
VmImage.Builder | |
getVmImageOrBuilder()
public VmImageOrBuilder getVmImageOrBuilder()Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.ReservationAffinity reservation_affinity = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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.v1beta1.VmImage vm_image = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the vmImage field is set. |
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 | |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeAcceleratorConfig(Instance.AcceleratorConfig value)
public Instance.Builder mergeAcceleratorConfig(Instance.AcceleratorConfig value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | Instance.AcceleratorConfig |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeContainerImage(ContainerImage value)
public Instance.Builder mergeContainerImage(ContainerImage value)Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;
| Parameter | |
|---|---|
| Name | Description |
value | ContainerImage |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeCreateTime(Timestamp value)
public Instance.Builder mergeCreateTime(Timestamp value)Output only. Instance creation time.
.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeFrom(Instance other)
public Instance.Builder mergeFrom(Instance other)| Parameter | |
|---|---|
| Name | Description |
other | Instance |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Instance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Instance.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeReservationAffinity(ReservationAffinity value)
public Instance.Builder mergeReservationAffinity(ReservationAffinity value)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];
| Parameter | |
|---|---|
| Name | Description |
value | ReservationAffinity |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Instance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeUpdateTime(Timestamp value)
public Instance.Builder mergeUpdateTime(Timestamp value)Output only. Instance update time.
.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
mergeVmImage(VmImage value)
public Instance.Builder mergeVmImage(VmImage value)Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;
| Parameter | |
|---|---|
| Name | Description |
value | VmImage |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
putAllLabels(Map<String,String> values)
public Instance.Builder putAllLabels(Map<String,String> values)Labels to apply to this instance. These can be later modified by the setLabels method.
map<string, string> labels = 21;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
putAllMetadata(Map<String,String> values)
public Instance.Builder putAllMetadata(Map<String,String> values)Custom metadata to apply to this instance.
map<string, string> metadata = 22;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
putLabels(String key, String value)
public Instance.Builder putLabels(String key, String value)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 |
value | String |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
putMetadata(String key, String value)
public Instance.Builder putMetadata(String key, String value)Custom metadata to apply to this instance.
map<string, string> metadata = 22;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
removeLabels(String key)
public Instance.Builder removeLabels(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 |
Instance.Builder | |
removeMetadata(String key)
public Instance.Builder removeMetadata(String key)Custom metadata to apply to this instance.
map<string, string> metadata = 22;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setAcceleratorConfig(Instance.AcceleratorConfig value)
public Instance.Builder setAcceleratorConfig(Instance.AcceleratorConfig value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | Instance.AcceleratorConfig |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setAcceleratorConfig(Instance.AcceleratorConfig.Builder builderForValue)
public Instance.Builder setAcceleratorConfig(Instance.AcceleratorConfig.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Instance.AcceleratorConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setBootDiskSizeGb(long value)
public Instance.Builder setBootDiskSizeGb(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value | longThe bootDiskSizeGb to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setBootDiskType(Instance.DiskType value)
public Instance.Builder setBootDiskType(Instance.DiskType value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | Instance.DiskTypeThe bootDiskType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setBootDiskTypeValue(int value)
public Instance.Builder setBootDiskTypeValue(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for bootDiskType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setCanIpForward(boolean value)
public Instance.Builder setCanIpForward(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe canIpForward to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setContainerImage(ContainerImage value)
public Instance.Builder setContainerImage(ContainerImage value)Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;
| Parameter | |
|---|---|
| Name | Description |
value | ContainerImage |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setContainerImage(ContainerImage.Builder builderForValue)
public Instance.Builder setContainerImage(ContainerImage.Builder builderForValue)Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ContainerImage.Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setCreateTime(Timestamp value)
public Instance.Builder setCreateTime(Timestamp value)Output only. Instance creation time.
.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setCreateTime(Timestamp.Builder builderForValue)
public Instance.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Instance creation time.
.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setCustomGpuDriverPath(String value)
public Instance.Builder setCustomGpuDriverPath(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe customGpuDriverPath to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setCustomGpuDriverPathBytes(ByteString value)
public Instance.Builder setCustomGpuDriverPathBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for customGpuDriverPath to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setDataDiskSizeGb(long value)
public Instance.Builder setDataDiskSizeGb(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value | longThe dataDiskSizeGb to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setDataDiskType(Instance.DiskType value)
public Instance.Builder setDataDiskType(Instance.DiskType value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | Instance.DiskTypeThe dataDiskType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setDataDiskTypeValue(int value)
public Instance.Builder setDataDiskTypeValue(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for dataDiskType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setDiskEncryption(Instance.DiskEncryption value)
public Instance.Builder setDiskEncryption(Instance.DiskEncryption value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Instance.DiskEncryptionThe diskEncryption to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setDiskEncryptionValue(int value)
public Instance.Builder setDiskEncryptionValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for diskEncryption to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Instance.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setInstallGpuDriver(boolean value)
public Instance.Builder setInstallGpuDriver(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe installGpuDriver to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setInstanceOwners(int index, String value)
public Instance.Builder setInstanceOwners(int index, String value) 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];
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe instanceOwners to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setKmsKey(String value)
public Instance.Builder setKmsKey(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe kmsKey to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setKmsKeyBytes(ByteString value)
public Instance.Builder setKmsKeyBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for kmsKey to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setMachineType(String value)
public Instance.Builder setMachineType(String value)Required. The Compute Engine machine type of this instance.
string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe machineType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setMachineTypeBytes(ByteString value)
public Instance.Builder setMachineTypeBytes(ByteString value)Required. The Compute Engine machine type of this instance.
string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for machineType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setName(String value)
public Instance.Builder setName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Instance.Builder setNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setNetwork(String value)
public Instance.Builder setNetwork(String value) The name of the VPC that this instance is in.
Format:
projects/{project_id}/global/networks/{network_id}
string network = 19;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe network to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setNetworkBytes(ByteString value)
public Instance.Builder setNetworkBytes(ByteString value) The name of the VPC that this instance is in.
Format:
projects/{project_id}/global/networks/{network_id}
string network = 19;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for network to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setNicType(Instance.NicType value)
public Instance.Builder setNicType(Instance.NicType value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Instance.NicTypeThe nicType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setNicTypeValue(int value)
public Instance.Builder setNicTypeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for nicType to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setNoProxyAccess(boolean value)
public Instance.Builder setNoProxyAccess(boolean value)If true, the notebook instance will not register with the proxy.
bool no_proxy_access = 18;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe noProxyAccess to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setNoPublicIp(boolean value)
public Instance.Builder setNoPublicIp(boolean value)If true, no public IP will be assigned to this instance.
bool no_public_ip = 17;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe noPublicIp to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setNoRemoveDataDisk(boolean value)
public Instance.Builder setNoRemoveDataDisk(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe noRemoveDataDisk to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setPostStartupScript(String value)
public Instance.Builder setPostStartupScript(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe postStartupScript to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setPostStartupScriptBytes(ByteString value)
public Instance.Builder setPostStartupScriptBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for postStartupScript to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setProxyUri(String value)
public Instance.Builder setProxyUri(String value)Output only. The proxy endpoint that is used to access the Jupyter notebook.
string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe proxyUri to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setProxyUriBytes(ByteString value)
public Instance.Builder setProxyUriBytes(ByteString value)Output only. The proxy endpoint that is used to access the Jupyter notebook.
string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for proxyUri to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Instance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setReservationAffinity(ReservationAffinity value)
public Instance.Builder setReservationAffinity(ReservationAffinity value)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];
| Parameter | |
|---|---|
| Name | Description |
value | ReservationAffinity |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setReservationAffinity(ReservationAffinity.Builder builderForValue)
public Instance.Builder setReservationAffinity(ReservationAffinity.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ReservationAffinity.Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setServiceAccount(String value)
public Instance.Builder setServiceAccount(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setServiceAccountBytes(ByteString value)
public Instance.Builder setServiceAccountBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setState(Instance.State value)
public Instance.Builder setState(Instance.State value)Output only. The state of this instance.
.google.cloud.notebooks.v1beta1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Instance.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setStateValue(int value)
public Instance.Builder setStateValue(int value)Output only. The state of this instance.
.google.cloud.notebooks.v1beta1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setSubnet(String value)
public Instance.Builder setSubnet(String value) The name of the subnet that this instance is in.
Format:
projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
string subnet = 20;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe subnet to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setSubnetBytes(ByteString value)
public Instance.Builder setSubnetBytes(ByteString value) The name of the subnet that this instance is in.
Format:
projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
string subnet = 20;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for subnet to set. |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Instance.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setUpdateTime(Timestamp value)
public Instance.Builder setUpdateTime(Timestamp value)Output only. Instance update time.
.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setUpdateTime(Timestamp.Builder builderForValue)
public Instance.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Instance update time.
.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setVmImage(VmImage value)
public Instance.Builder setVmImage(VmImage value)Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;
| Parameter | |
|---|---|
| Name | Description |
value | VmImage |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |
setVmImage(VmImage.Builder builderForValue)
public Instance.Builder setVmImage(VmImage.Builder builderForValue)Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | VmImage.Builder |
| Returns | |
|---|---|
| Type | Description |
Instance.Builder | |