Interface LocalDiskOrBuilder (1.11.0)

Version 1.11.0

• 1.53.0 (latest)
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.3
• 1.0.6
• 0.6.2

public interface LocalDiskOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutoDelete()

public abstract boolean getAutoDelete()

Optional. Output only. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

bool auto_delete = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The autoDelete.

getBoot()

public abstract boolean getBoot()

Optional. Output only. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

bool boot = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The boot.

getDeviceName()

public abstract String getDeviceName()

Optional. Output only. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

string device_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The deviceName.

getDeviceNameBytes()

public abstract ByteString getDeviceNameBytes()

Optional. Output only. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

string device_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for deviceName.

getGuestOsFeatures(int index)

public abstract LocalDisk.RuntimeGuestOsFeature getGuestOsFeatures(int index)

Output only. Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

repeated .google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
LocalDisk.RuntimeGuestOsFeature

getGuestOsFeaturesCount()

public abstract int getGuestOsFeaturesCount()

Output only. Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

repeated .google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getGuestOsFeaturesList()

public abstract List<LocalDisk.RuntimeGuestOsFeature> getGuestOsFeaturesList()

Output only. Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

repeated .google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<RuntimeGuestOsFeature>

getGuestOsFeaturesOrBuilder(int index)

public abstract LocalDisk.RuntimeGuestOsFeatureOrBuilder getGuestOsFeaturesOrBuilder(int index)

Output only. Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

repeated .google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
LocalDisk.RuntimeGuestOsFeatureOrBuilder

getGuestOsFeaturesOrBuilderList()

public abstract List<? extends LocalDisk.RuntimeGuestOsFeatureOrBuilder> getGuestOsFeaturesOrBuilderList()

Output only. Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

repeated .google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeatureOrBuilder>

getIndex()

public abstract int getIndex()

Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

int32 index = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The index.

getInitializeParams()

public abstract LocalDiskInitializeParams getInitializeParams()

Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

.google.cloud.notebooks.v1.LocalDiskInitializeParams initialize_params = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
LocalDiskInitializeParams	The initializeParams.

getInitializeParamsOrBuilder()

public abstract LocalDiskInitializeParamsOrBuilder getInitializeParamsOrBuilder()

Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

.google.cloud.notebooks.v1.LocalDiskInitializeParams initialize_params = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
LocalDiskInitializeParamsOrBuilder

getInterface()

public abstract String getInterface()

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values:

• NVME
• SCSI

string interface = 7;

Returns
Type	Description
String	The interface.

getInterfaceBytes()

public abstract ByteString getInterfaceBytes()

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values:

• NVME
• SCSI

string interface = 7;

Returns
Type	Description
ByteString	The bytes for interface.

getKind()

public abstract String getKind()

Output only. Type of the resource. Always compute#attachedDisk for attached disks.

string kind = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

Output only. Type of the resource. Always compute#attachedDisk for attached disks.

string kind = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for kind.

getLicenses(int index)

public abstract String getLicenses(int index)

Output only. Any valid publicly visible licenses.

repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The licenses at the given index.

getLicensesBytes(int index)

public abstract ByteString getLicensesBytes(int index)

Output only. Any valid publicly visible licenses.

repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the licenses at the given index.

getLicensesCount()

public abstract int getLicensesCount()

Output only. Any valid publicly visible licenses.

repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The count of licenses.

getLicensesList()

public abstract List<String> getLicensesList()

Output only. Any valid publicly visible licenses.

repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<String>	A list containing the licenses.

getMode()

public abstract String getMode()

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values:

• READ_ONLY
• READ_WRITE

string mode = 10;

Returns
Type	Description
String	The mode.

getModeBytes()

public abstract ByteString getModeBytes()

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values:

• READ_ONLY
• READ_WRITE

string mode = 10;

Returns
Type	Description
ByteString	The bytes for mode.

getSource()

public abstract String getSource()

Specifies a valid partial or full URL to an existing Persistent Disk resource.

string source = 11;

Returns
Type	Description
String	The source.

getSourceBytes()

public abstract ByteString getSourceBytes()

Specifies a valid partial or full URL to an existing Persistent Disk resource.

string source = 11;

Returns
Type	Description
ByteString	The bytes for source.

getType()

public abstract String getType()

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Valid values:

• PERSISTENT
• SCRATCH

string type = 12;

Returns
Type	Description
String	The type.

getTypeBytes()

public abstract ByteString getTypeBytes()

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Valid values:

• PERSISTENT
• SCRATCH

string type = 12;

Returns
Type	Description
ByteString	The bytes for type.

hasInitializeParams()

public abstract boolean hasInitializeParams()

Input only. Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

.google.cloud.notebooks.v1.LocalDiskInitializeParams initialize_params = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
boolean	Whether the initializeParams field is set.