Class Instance.Disk (1.11.0)

public static final class Instance.Disk extends GeneratedMessageV3 implements Instance.DiskOrBuilder

An instance-attached disk resource.

Protobuf type google.cloud.notebooks.v1.Instance.Disk

Static Fields

AUTO_DELETE_FIELD_NUMBER

public static final int AUTO_DELETE_FIELD_NUMBER
Field Value
TypeDescription
int

BOOT_FIELD_NUMBER

public static final int BOOT_FIELD_NUMBER
Field Value
TypeDescription
int

DEVICE_NAME_FIELD_NUMBER

public static final int DEVICE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

DISK_SIZE_GB_FIELD_NUMBER

public static final int DISK_SIZE_GB_FIELD_NUMBER
Field Value
TypeDescription
int

GUEST_OS_FEATURES_FIELD_NUMBER

public static final int GUEST_OS_FEATURES_FIELD_NUMBER
Field Value
TypeDescription
int

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
TypeDescription
int

INTERFACE_FIELD_NUMBER

public static final int INTERFACE_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

LICENSES_FIELD_NUMBER

public static final int LICENSES_FIELD_NUMBER
Field Value
TypeDescription
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Instance.Disk getDefaultInstance()
Returns
TypeDescription
Instance.Disk

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Instance.Disk.Builder newBuilder()
Returns
TypeDescription
Instance.Disk.Builder

newBuilder(Instance.Disk prototype)

public static Instance.Disk.Builder newBuilder(Instance.Disk prototype)
Parameter
NameDescription
prototypeInstance.Disk
Returns
TypeDescription
Instance.Disk.Builder

parseDelimitedFrom(InputStream input)

public static Instance.Disk parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance.Disk parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Instance.Disk parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Instance.Disk parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Instance.Disk parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Instance.Disk parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Instance.Disk parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance.Disk parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Instance.Disk parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Instance.Disk parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Instance.Disk parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Instance.Disk parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance.Disk
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Instance.Disk> parser()
Returns
TypeDescription
Parser<Disk>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAutoDelete()

public boolean getAutoDelete()

Indicates 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;

Returns
TypeDescription
boolean

The autoDelete.

getBoot()

public boolean getBoot()

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;

Returns
TypeDescription
boolean

The boot.

getDefaultInstanceForType()

public Instance.Disk getDefaultInstanceForType()
Returns
TypeDescription
Instance.Disk

getDeviceName()

public String getDeviceName()

Indicates 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;

Returns
TypeDescription
String

The deviceName.

getDeviceNameBytes()

public ByteString getDeviceNameBytes()

Indicates 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;

Returns
TypeDescription
ByteString

The bytes for deviceName.

getDiskSizeGb()

public long getDiskSizeGb()

Indicates the size of the disk in base-2 GB.

int64 disk_size_gb = 4;

Returns
TypeDescription
long

The diskSizeGb.

getGuestOsFeatures(int index)

public Instance.Disk.GuestOsFeature getGuestOsFeatures(int index)

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.Instance.Disk.GuestOsFeature guest_os_features = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Instance.Disk.GuestOsFeature

getGuestOsFeaturesCount()

public int getGuestOsFeaturesCount()

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.Instance.Disk.GuestOsFeature guest_os_features = 5;

Returns
TypeDescription
int

getGuestOsFeaturesList()

public List<Instance.Disk.GuestOsFeature> getGuestOsFeaturesList()

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.Instance.Disk.GuestOsFeature guest_os_features = 5;

Returns
TypeDescription
List<GuestOsFeature>

getGuestOsFeaturesOrBuilder(int index)

public Instance.Disk.GuestOsFeatureOrBuilder getGuestOsFeaturesOrBuilder(int index)

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.Instance.Disk.GuestOsFeature guest_os_features = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Instance.Disk.GuestOsFeatureOrBuilder

getGuestOsFeaturesOrBuilderList()

public List<? extends Instance.Disk.GuestOsFeatureOrBuilder> getGuestOsFeaturesOrBuilderList()

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.Instance.Disk.GuestOsFeature guest_os_features = 5;

Returns
TypeDescription
List<? extends com.google.cloud.notebooks.v1.Instance.Disk.GuestOsFeatureOrBuilder>

getIndex()

public long getIndex()

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.

int64 index = 6;

Returns
TypeDescription
long

The index.

getInterface()

public String getInterface()

Indicates 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
TypeDescription
String

The interface.

getInterfaceBytes()

public ByteString getInterfaceBytes()

Indicates 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
TypeDescription
ByteString

The bytes for interface.

getKind()

public String getKind()

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

string kind = 8;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

string kind = 8;

Returns
TypeDescription
ByteString

The bytes for kind.

getLicenses(int index)

public String getLicenses(int index)

A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

repeated string licenses = 9;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The licenses at the given index.

getLicensesBytes(int index)

public ByteString getLicensesBytes(int index)

A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

repeated string licenses = 9;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the licenses at the given index.

getLicensesCount()

public int getLicensesCount()

A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

repeated string licenses = 9;

Returns
TypeDescription
int

The count of licenses.

getLicensesList()

public ProtocolStringList getLicensesList()

A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

repeated string licenses = 9;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for mode.

getParserForType()

public Parser<Instance.Disk> getParserForType()
Returns
TypeDescription
Parser<Disk>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSource()

public String getSource()

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

string source = 11;

Returns
TypeDescription
String

The source.

getSourceBytes()

public ByteString getSourceBytes()

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

string source = 11;

Returns
TypeDescription
ByteString

The bytes for source.

getType()

public String getType()

Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values:

  • PERSISTENT
  • SCRATCH

string type = 12;

Returns
TypeDescription
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values:

  • PERSISTENT
  • SCRATCH

string type = 12;

Returns
TypeDescription
ByteString

The bytes for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Instance.Disk.Builder newBuilderForType()
Returns
TypeDescription
Instance.Disk.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Instance.Disk.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Instance.Disk.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Instance.Disk.Builder toBuilder()
Returns
TypeDescription
Instance.Disk.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException