Class LocalDisk (1.44.0)

public final class LocalDisk extends GeneratedMessageV3 implements LocalDiskOrBuilder

A Local attached disk resource.

Protobuf type google.cloud.notebooks.v1.LocalDisk

Implements

LocalDiskOrBuilder

Static Fields

AUTO_DELETE_FIELD_NUMBER

public static final int AUTO_DELETE_FIELD_NUMBER
Field Value
Type Description
int

BOOT_FIELD_NUMBER

public static final int BOOT_FIELD_NUMBER
Field Value
Type Description
int

DEVICE_NAME_FIELD_NUMBER

public static final int DEVICE_NAME_FIELD_NUMBER
Field Value
Type Description
int

GUEST_OS_FEATURES_FIELD_NUMBER

public static final int GUEST_OS_FEATURES_FIELD_NUMBER
Field Value
Type Description
int

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
Type Description
int

INITIALIZE_PARAMS_FIELD_NUMBER

public static final int INITIALIZE_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

INTERFACE_FIELD_NUMBER

public static final int INTERFACE_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

LICENSES_FIELD_NUMBER

public static final int LICENSES_FIELD_NUMBER
Field Value
Type Description
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LocalDisk getDefaultInstance()
Returns
Type Description
LocalDisk

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static LocalDisk.Builder newBuilder()
Returns
Type Description
LocalDisk.Builder

newBuilder(LocalDisk prototype)

public static LocalDisk.Builder newBuilder(LocalDisk prototype)
Parameter
Name Description
prototype LocalDisk
Returns
Type Description
LocalDisk.Builder

parseDelimitedFrom(InputStream input)

public static LocalDisk parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LocalDisk
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalDisk parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDisk
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LocalDisk parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LocalDisk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LocalDisk parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDisk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LocalDisk parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LocalDisk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LocalDisk parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDisk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LocalDisk parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LocalDisk
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalDisk parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDisk
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LocalDisk parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LocalDisk
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocalDisk parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDisk
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LocalDisk parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LocalDisk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LocalDisk parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDisk
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LocalDisk> parser()
Returns
Type Description
Parser<LocalDisk>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAutoDelete()

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

getDefaultInstanceForType()

public LocalDisk getDefaultInstanceForType()
Returns
Type Description
LocalDisk

getDeviceName()

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 ProtocolStringList getLicensesList()

Output only. Any valid publicly visible licenses.

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

Returns
Type Description
ProtocolStringList

A list containing the licenses.

getMode()

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

getParserForType()

public Parser<LocalDisk> getParserForType()
Returns
Type Description
Parser<LocalDisk>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSource()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LocalDisk.Builder newBuilderForType()
Returns
Type Description
LocalDisk.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LocalDisk.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LocalDisk.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public LocalDisk.Builder toBuilder()
Returns
Type Description
LocalDisk.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException