public final class Instance extends com.google.protobuf.GeneratedMessageV3 implements InstanceOrBuilder
The definition of a notebook instance.Protobuf type
google.cloud.notebooks.v1beta1.Instance| Modifier and Type | Class and Description |
|---|---|
static class |
Instance.AcceleratorConfig
Definition of a hardware accelerator.
|
static interface |
Instance.AcceleratorConfigOrBuilder |
static class |
Instance.AcceleratorType
Definition of the types of hardware accelerators that can be used on this
instance.
|
static class |
Instance.Builder
The definition of a notebook instance.
|
static class |
Instance.DiskEncryption
Definition of the disk encryption options.
|
static class |
Instance.DiskType
Possible disk types for notebook instances.
|
static class |
Instance.EnvironmentCase |
static class |
Instance.NicType
The type of vNIC driver.
|
static class |
Instance.State
The definition of the states of this instance.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Labels to apply to this instance.
|
boolean |
containsMetadata(String key)
Custom metadata to apply to this instance.
|
boolean |
equals(Object obj) |
Instance.AcceleratorConfig |
getAcceleratorConfig()
The hardware accelerator used on this instance.
|
Instance.AcceleratorConfigOrBuilder |
getAcceleratorConfigOrBuilder()
The hardware accelerator used on this instance.
|
long |
getBootDiskSizeGb()
Input only.
|
Instance.DiskType |
getBootDiskType()
Input only.
|
int |
getBootDiskTypeValue()
Input only.
|
boolean |
getCanIpForward()
Optional.
|
ContainerImage |
getContainerImage()
Use a container image to start the notebook instance.
|
ContainerImageOrBuilder |
getContainerImageOrBuilder()
Use a container image to start the notebook instance.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
String |
getCustomGpuDriverPath()
Specify a custom Cloud Storage path where the GPU driver is stored.
|
com.google.protobuf.ByteString |
getCustomGpuDriverPathBytes()
Specify a custom Cloud Storage path where the GPU driver is stored.
|
long |
getDataDiskSizeGb()
Input only.
|
Instance.DiskType |
getDataDiskType()
Input only.
|
int |
getDataDiskTypeValue()
Input only.
|
static Instance |
getDefaultInstance() |
Instance |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Instance.DiskEncryption |
getDiskEncryption()
Input only.
|
int |
getDiskEncryptionValue()
Input only.
|
Instance.EnvironmentCase |
getEnvironmentCase() |
boolean |
getInstallGpuDriver()
Whether the end user authorizes Google Cloud to install GPU driver
on this instance.
|
String |
getInstanceOwners(int index)
Input only.
|
com.google.protobuf.ByteString |
getInstanceOwnersBytes(int index)
Input only.
|
int |
getInstanceOwnersCount()
Input only.
|
com.google.protobuf.ProtocolStringList |
getInstanceOwnersList()
Input only.
|
String |
getKmsKey()
Input only.
|
com.google.protobuf.ByteString |
getKmsKeyBytes()
Input only.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Labels to apply to this instance.
|
Map<String,String> |
getLabelsMap()
Labels to apply to this instance.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Labels to apply to this instance.
|
String |
getLabelsOrThrow(String key)
Labels to apply to this instance.
|
String |
getMachineType()
Required.
|
com.google.protobuf.ByteString |
getMachineTypeBytes()
Required.
|
Map<String,String> |
getMetadata()
Deprecated.
|
int |
getMetadataCount()
Custom metadata to apply to this instance.
|
Map<String,String> |
getMetadataMap()
Custom metadata to apply to this instance.
|
String |
getMetadataOrDefault(String key,
String defaultValue)
Custom metadata to apply to this instance.
|
String |
getMetadataOrThrow(String key)
Custom metadata to apply to this instance.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
String |
getNetwork()
The name of the VPC that this instance is in.
|
com.google.protobuf.ByteString |
getNetworkBytes()
The name of the VPC that this instance is in.
|
Instance.NicType |
getNicType()
Optional.
|
int |
getNicTypeValue()
Optional.
|
boolean |
getNoProxyAccess()
If true, the notebook instance will not register with the proxy.
|
boolean |
getNoPublicIp()
If true, no public IP will be assigned to this instance.
|
boolean |
getNoRemoveDataDisk()
Input only.
|
com.google.protobuf.Parser<Instance> |
getParserForType() |
String |
getPostStartupScript()
Path to a Bash script that automatically runs after a notebook instance
fully boots up.
|
com.google.protobuf.ByteString |
getPostStartupScriptBytes()
Path to a Bash script that automatically runs after a notebook instance
fully boots up.
|
String |
getProxyUri()
Output only.
|
com.google.protobuf.ByteString |
getProxyUriBytes()
Output only.
|
ReservationAffinity |
getReservationAffinity()
Optional.
|
ReservationAffinityOrBuilder |
getReservationAffinityOrBuilder()
Optional.
|
int |
getSerializedSize() |
String |
getServiceAccount()
The service account on this instance, giving access to other Google
Cloud services.
|
com.google.protobuf.ByteString |
getServiceAccountBytes()
The service account on this instance, giving access to other Google
Cloud services.
|
Instance.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
String |
getSubnet()
The name of the subnet that this instance is in.
|
com.google.protobuf.ByteString |
getSubnetBytes()
The name of the subnet that this instance is in.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
VmImage |
getVmImage()
Use a Compute Engine VM image to start the notebook instance.
|
VmImageOrBuilder |
getVmImageOrBuilder()
Use a Compute Engine VM image to start the notebook instance.
|
boolean |
hasAcceleratorConfig()
The hardware accelerator used on this instance.
|
boolean |
hasContainerImage()
Use a container image to start the notebook instance.
|
boolean |
hasCreateTime()
Output only.
|
int |
hashCode() |
boolean |
hasReservationAffinity()
Optional.
|
boolean |
hasUpdateTime()
Output only.
|
boolean |
hasVmImage()
Use a Compute Engine VM image to start the notebook instance.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static Instance.Builder |
newBuilder() |
static Instance.Builder |
newBuilder(Instance prototype) |
Instance.Builder |
newBuilderForType() |
protected Instance.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Instance |
parseDelimitedFrom(InputStream input) |
static Instance |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(byte[] data) |
static Instance |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(ByteBuffer data) |
static Instance |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(com.google.protobuf.ByteString data) |
static Instance |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Instance |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(InputStream input) |
static Instance |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Instance> |
parser() |
Instance.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int VM_IMAGE_FIELD_NUMBER
public static final int CONTAINER_IMAGE_FIELD_NUMBER
public static final int POST_STARTUP_SCRIPT_FIELD_NUMBER
public static final int PROXY_URI_FIELD_NUMBER
public static final int INSTANCE_OWNERS_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
public static final int MACHINE_TYPE_FIELD_NUMBER
public static final int ACCELERATOR_CONFIG_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int INSTALL_GPU_DRIVER_FIELD_NUMBER
public static final int CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER
public static final int BOOT_DISK_TYPE_FIELD_NUMBER
public static final int BOOT_DISK_SIZE_GB_FIELD_NUMBER
public static final int DATA_DISK_TYPE_FIELD_NUMBER
public static final int DATA_DISK_SIZE_GB_FIELD_NUMBER
public static final int NO_REMOVE_DATA_DISK_FIELD_NUMBER
public static final int DISK_ENCRYPTION_FIELD_NUMBER
public static final int KMS_KEY_FIELD_NUMBER
public static final int NO_PUBLIC_IP_FIELD_NUMBER
public static final int NO_PROXY_ACCESS_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
public static final int SUBNET_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
public static final int NIC_TYPE_FIELD_NUMBER
public static final int RESERVATION_AFFINITY_FIELD_NUMBER
public static final int CAN_IP_FORWARD_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public Instance.EnvironmentCase getEnvironmentCase()
getEnvironmentCase in interface InstanceOrBuilderpublic 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];getName in interface InstanceOrBuilderpublic com.google.protobuf.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];getNameBytes in interface InstanceOrBuilderpublic boolean hasVmImage()
Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;hasVmImage in interface InstanceOrBuilderpublic VmImage getVmImage()
Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;getVmImage in interface InstanceOrBuilderpublic VmImageOrBuilder getVmImageOrBuilder()
Use a Compute Engine VM image to start the notebook instance.
.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;getVmImageOrBuilder in interface InstanceOrBuilderpublic boolean hasContainerImage()
Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;hasContainerImage in interface InstanceOrBuilderpublic ContainerImage getContainerImage()
Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;getContainerImage in interface InstanceOrBuilderpublic ContainerImageOrBuilder getContainerImageOrBuilder()
Use a container image to start the notebook instance.
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;getContainerImageOrBuilder in interface InstanceOrBuilderpublic 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;getPostStartupScript in interface InstanceOrBuilderpublic com.google.protobuf.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;getPostStartupScriptBytes in interface InstanceOrBuilderpublic 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];getProxyUri in interface InstanceOrBuilderpublic com.google.protobuf.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];getProxyUriBytes in interface InstanceOrBuilderpublic com.google.protobuf.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];getInstanceOwnersList in interface InstanceOrBuilderpublic 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];getInstanceOwnersCount in interface InstanceOrBuilderpublic 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];getInstanceOwners in interface InstanceOrBuilderindex - The index of the element to return.public com.google.protobuf.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];getInstanceOwnersBytes in interface InstanceOrBuilderindex - The index of the value to return.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](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
string service_account = 7;getServiceAccount in interface InstanceOrBuilderpublic com.google.protobuf.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](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
string service_account = 7;getServiceAccountBytes in interface InstanceOrBuilderpublic String getMachineType()
Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) of this instance.
string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];getMachineType in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getMachineTypeBytes()
Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) of this instance.
string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];getMachineTypeBytes in interface InstanceOrBuilderpublic 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](https://cloud.google.com/compute/docs/gpus/#gpus-list).
.google.cloud.notebooks.v1beta1.Instance.AcceleratorConfig accelerator_config = 9;hasAcceleratorConfig in interface InstanceOrBuilderpublic 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](https://cloud.google.com/compute/docs/gpus/#gpus-list).
.google.cloud.notebooks.v1beta1.Instance.AcceleratorConfig accelerator_config = 9;getAcceleratorConfig in interface InstanceOrBuilderpublic 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](https://cloud.google.com/compute/docs/gpus/#gpus-list).
.google.cloud.notebooks.v1beta1.Instance.AcceleratorConfig accelerator_config = 9;getAcceleratorConfigOrBuilder in interface InstanceOrBuilderpublic int getStateValue()
Output only. The state of this instance.
.google.cloud.notebooks.v1beta1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface InstanceOrBuilderpublic Instance.State getState()
Output only. The state of this instance.
.google.cloud.notebooks.v1beta1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface InstanceOrBuilderpublic 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;getInstallGpuDriver in interface InstanceOrBuilderpublic 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;getCustomGpuDriverPath in interface InstanceOrBuilderpublic com.google.protobuf.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;getCustomGpuDriverPathBytes in interface InstanceOrBuilderpublic 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];
getBootDiskTypeValue in interface InstanceOrBuilderpublic 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];
getBootDiskType in interface InstanceOrBuilderpublic 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];getBootDiskSizeGb in interface InstanceOrBuilderpublic 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];
getDataDiskTypeValue in interface InstanceOrBuilderpublic 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];
getDataDiskType in interface InstanceOrBuilderpublic 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];getDataDiskSizeGb in interface InstanceOrBuilderpublic 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];getNoRemoveDataDisk in interface InstanceOrBuilderpublic 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];
getDiskEncryptionValue in interface InstanceOrBuilderpublic 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];
getDiskEncryption in interface InstanceOrBuilderpublic 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](https://cloud.google.com/kms/docs/quickstart).
string kms_key = 16 [(.google.api.field_behavior) = INPUT_ONLY];getKmsKey in interface InstanceOrBuilderpublic com.google.protobuf.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](https://cloud.google.com/kms/docs/quickstart).
string kms_key = 16 [(.google.api.field_behavior) = INPUT_ONLY];getKmsKeyBytes in interface InstanceOrBuilderpublic boolean getNoPublicIp()
If true, no public IP will be assigned to this instance.
bool no_public_ip = 17;getNoPublicIp in interface InstanceOrBuilderpublic boolean getNoProxyAccess()
If true, the notebook instance will not register with the proxy.
bool no_proxy_access = 18;getNoProxyAccess in interface InstanceOrBuilderpublic String getNetwork()
The name of the VPC that this instance is in.
Format:
`projects/{project_id}/global/networks/{network_id}`
string network = 19;getNetwork in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getNetworkBytes()
The name of the VPC that this instance is in.
Format:
`projects/{project_id}/global/networks/{network_id}`
string network = 19;getNetworkBytes in interface InstanceOrBuilderpublic String getSubnet()
The name of the subnet that this instance is in.
Format:
`projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
string subnet = 20;getSubnet in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getSubnetBytes()
The name of the subnet that this instance is in.
Format:
`projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
string subnet = 20;getSubnetBytes in interface InstanceOrBuilderpublic int getLabelsCount()
InstanceOrBuilderLabels to apply to this instance. These can be later modified by the setLabels method.
map<string, string> labels = 21;getLabelsCount in interface InstanceOrBuilderpublic boolean containsLabels(String key)
Labels to apply to this instance. These can be later modified by the setLabels method.
map<string, string> labels = 21;containsLabels in interface InstanceOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface InstanceOrBuilderpublic Map<String,String> getLabelsMap()
Labels to apply to this instance. These can be later modified by the setLabels method.
map<string, string> labels = 21;getLabelsMap in interface InstanceOrBuilderpublic 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;getLabelsOrDefault in interface InstanceOrBuilderpublic String getLabelsOrThrow(String key)
Labels to apply to this instance. These can be later modified by the setLabels method.
map<string, string> labels = 21;getLabelsOrThrow in interface InstanceOrBuilderpublic int getMetadataCount()
InstanceOrBuilderCustom metadata to apply to this instance.
map<string, string> metadata = 22;getMetadataCount in interface InstanceOrBuilderpublic boolean containsMetadata(String key)
Custom metadata to apply to this instance.
map<string, string> metadata = 22;containsMetadata in interface InstanceOrBuilder@Deprecated public Map<String,String> getMetadata()
getMetadataMap() instead.getMetadata in interface InstanceOrBuilderpublic Map<String,String> getMetadataMap()
Custom metadata to apply to this instance.
map<string, string> metadata = 22;getMetadataMap in interface InstanceOrBuilderpublic String getMetadataOrDefault(String key, String defaultValue)
Custom metadata to apply to this instance.
map<string, string> metadata = 22;getMetadataOrDefault in interface InstanceOrBuilderpublic String getMetadataOrThrow(String key)
Custom metadata to apply to this instance.
map<string, string> metadata = 22;getMetadataOrThrow in interface InstanceOrBuilderpublic 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];
getNicTypeValue in interface InstanceOrBuilderpublic 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];
getNicType in interface InstanceOrBuilderpublic boolean hasReservationAffinity()
Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook instance.
.google.cloud.notebooks.v1beta1.ReservationAffinity reservation_affinity = 29 [(.google.api.field_behavior) = OPTIONAL];
hasReservationAffinity in interface InstanceOrBuilderpublic ReservationAffinity getReservationAffinity()
Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook instance.
.google.cloud.notebooks.v1beta1.ReservationAffinity reservation_affinity = 29 [(.google.api.field_behavior) = OPTIONAL];
getReservationAffinity in interface InstanceOrBuilderpublic ReservationAffinityOrBuilder getReservationAffinityOrBuilder()
Optional. The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this notebook instance.
.google.cloud.notebooks.v1beta1.ReservationAffinity reservation_affinity = 29 [(.google.api.field_behavior) = OPTIONAL];
getReservationAffinityOrBuilder in interface InstanceOrBuilderpublic 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];getCanIpForward in interface InstanceOrBuilderpublic boolean hasCreateTime()
Output only. Instance creation time.
.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface InstanceOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. Instance creation time.
.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface InstanceOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Instance creation time.
.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface InstanceOrBuilderpublic boolean hasUpdateTime()
Output only. Instance update time.
.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface InstanceOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. Instance update time.
.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface InstanceOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Instance update time.
.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface InstanceOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Instance parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(InputStream input) throws IOException
IOExceptionpublic static Instance parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Instance parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Instance parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Instance parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Instance parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Instance.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Instance.Builder newBuilder()
public static Instance.Builder newBuilder(Instance prototype)
public Instance.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Instance.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Instance getDefaultInstance()
public static com.google.protobuf.Parser<Instance> parser()
public com.google.protobuf.Parser<Instance> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Instance getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.