Class LocalDisk.Builder (1.53.0)

public static final class LocalDisk.Builder extends GeneratedMessageV3.Builder<LocalDisk.Builder> implements LocalDiskOrBuilder

A Local attached disk resource.

Protobuf type google.cloud.notebooks.v1.LocalDisk

Implements

LocalDiskOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllGuestOsFeatures(Iterable<? extends LocalDisk.RuntimeGuestOsFeature> values)

public LocalDisk.Builder addAllGuestOsFeatures(Iterable<? extends LocalDisk.RuntimeGuestOsFeature> values)

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
values Iterable<? extends com.google.cloud.notebooks.v1.LocalDisk.RuntimeGuestOsFeature>
Returns
Type Description
LocalDisk.Builder

addAllLicenses(Iterable<String> values)

public LocalDisk.Builder addAllLicenses(Iterable<String> values)

Output only. Any valid publicly visible licenses.

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

Parameter
Name Description
values Iterable<String>

The licenses to add.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

addGuestOsFeatures(LocalDisk.RuntimeGuestOsFeature value)

public LocalDisk.Builder addGuestOsFeatures(LocalDisk.RuntimeGuestOsFeature value)

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
value LocalDisk.RuntimeGuestOsFeature
Returns
Type Description
LocalDisk.Builder

addGuestOsFeatures(LocalDisk.RuntimeGuestOsFeature.Builder builderForValue)

public LocalDisk.Builder addGuestOsFeatures(LocalDisk.RuntimeGuestOsFeature.Builder builderForValue)

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
builderForValue LocalDisk.RuntimeGuestOsFeature.Builder
Returns
Type Description
LocalDisk.Builder

addGuestOsFeatures(int index, LocalDisk.RuntimeGuestOsFeature value)

public LocalDisk.Builder addGuestOsFeatures(int index, LocalDisk.RuntimeGuestOsFeature value)

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

Parameters
Name Description
index int
value LocalDisk.RuntimeGuestOsFeature
Returns
Type Description
LocalDisk.Builder

addGuestOsFeatures(int index, LocalDisk.RuntimeGuestOsFeature.Builder builderForValue)

public LocalDisk.Builder addGuestOsFeatures(int index, LocalDisk.RuntimeGuestOsFeature.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue LocalDisk.RuntimeGuestOsFeature.Builder
Returns
Type Description
LocalDisk.Builder

addGuestOsFeaturesBuilder()

public LocalDisk.RuntimeGuestOsFeature.Builder addGuestOsFeaturesBuilder()

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
LocalDisk.RuntimeGuestOsFeature.Builder

addGuestOsFeaturesBuilder(int index)

public LocalDisk.RuntimeGuestOsFeature.Builder addGuestOsFeaturesBuilder(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.Builder

addLicenses(String value)

public LocalDisk.Builder addLicenses(String value)

Output only. Any valid publicly visible licenses.

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

Parameter
Name Description
value String

The licenses to add.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

addLicensesBytes(ByteString value)

public LocalDisk.Builder addLicensesBytes(ByteString value)

Output only. Any valid publicly visible licenses.

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

Parameter
Name Description
value ByteString

The bytes of the licenses to add.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LocalDisk.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LocalDisk.Builder
Overrides

build()

public LocalDisk build()
Returns
Type Description
LocalDisk

buildPartial()

public LocalDisk buildPartial()
Returns
Type Description
LocalDisk

clear()

public LocalDisk.Builder clear()
Returns
Type Description
LocalDisk.Builder
Overrides

clearAutoDelete()

public LocalDisk.Builder clearAutoDelete()

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
LocalDisk.Builder

This builder for chaining.

clearBoot()

public LocalDisk.Builder clearBoot()

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
LocalDisk.Builder

This builder for chaining.

clearDeviceName()

public LocalDisk.Builder clearDeviceName()

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
LocalDisk.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public LocalDisk.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
LocalDisk.Builder
Overrides

clearGuestOsFeatures()

public LocalDisk.Builder clearGuestOsFeatures()

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
LocalDisk.Builder

clearIndex()

public LocalDisk.Builder clearIndex()

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
LocalDisk.Builder

This builder for chaining.

clearInitializeParams()

public LocalDisk.Builder clearInitializeParams()

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
LocalDisk.Builder

clearInterface()

public LocalDisk.Builder clearInterface()

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
LocalDisk.Builder

This builder for chaining.

clearKind()

public LocalDisk.Builder clearKind()

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

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

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

clearLicenses()

public LocalDisk.Builder clearLicenses()

Output only. Any valid publicly visible licenses.

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

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

clearMode()

public LocalDisk.Builder clearMode()

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
LocalDisk.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LocalDisk.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
LocalDisk.Builder
Overrides

clearSource()

public LocalDisk.Builder clearSource()

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

string source = 11;

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

clearType()

public LocalDisk.Builder clearType()

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
LocalDisk.Builder

This builder for chaining.

clone()

public LocalDisk.Builder clone()
Returns
Type Description
LocalDisk.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getGuestOsFeaturesBuilder(int index)

public LocalDisk.RuntimeGuestOsFeature.Builder getGuestOsFeaturesBuilder(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.Builder

getGuestOsFeaturesBuilderList()

public List<LocalDisk.RuntimeGuestOsFeature.Builder> getGuestOsFeaturesBuilderList()

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<Builder>

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.

getInitializeParamsBuilder()

public LocalDiskInitializeParams.Builder getInitializeParamsBuilder()

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(LocalDisk other)

public LocalDisk.Builder mergeFrom(LocalDisk other)
Parameter
Name Description
other LocalDisk
Returns
Type Description
LocalDisk.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LocalDisk.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalDisk.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public LocalDisk.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
LocalDisk.Builder
Overrides

mergeInitializeParams(LocalDiskInitializeParams value)

public LocalDisk.Builder mergeInitializeParams(LocalDiskInitializeParams value)

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

Parameter
Name Description
value LocalDiskInitializeParams
Returns
Type Description
LocalDisk.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LocalDisk.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LocalDisk.Builder
Overrides

removeGuestOsFeatures(int index)

public LocalDisk.Builder removeGuestOsFeatures(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.Builder

setAutoDelete(boolean value)

public LocalDisk.Builder setAutoDelete(boolean value)

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

Parameter
Name Description
value boolean

The autoDelete to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setBoot(boolean value)

public LocalDisk.Builder setBoot(boolean value)

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

Parameter
Name Description
value boolean

The boot to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setDeviceName(String value)

public LocalDisk.Builder setDeviceName(String value)

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

Parameter
Name Description
value String

The deviceName to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setDeviceNameBytes(ByteString value)

public LocalDisk.Builder setDeviceNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for deviceName to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public LocalDisk.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LocalDisk.Builder
Overrides

setGuestOsFeatures(int index, LocalDisk.RuntimeGuestOsFeature value)

public LocalDisk.Builder setGuestOsFeatures(int index, LocalDisk.RuntimeGuestOsFeature value)

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

Parameters
Name Description
index int
value LocalDisk.RuntimeGuestOsFeature
Returns
Type Description
LocalDisk.Builder

setGuestOsFeatures(int index, LocalDisk.RuntimeGuestOsFeature.Builder builderForValue)

public LocalDisk.Builder setGuestOsFeatures(int index, LocalDisk.RuntimeGuestOsFeature.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue LocalDisk.RuntimeGuestOsFeature.Builder
Returns
Type Description
LocalDisk.Builder

setIndex(int value)

public LocalDisk.Builder setIndex(int value)

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

Parameter
Name Description
value int

The index to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setInitializeParams(LocalDiskInitializeParams value)

public LocalDisk.Builder setInitializeParams(LocalDiskInitializeParams value)

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

Parameter
Name Description
value LocalDiskInitializeParams
Returns
Type Description
LocalDisk.Builder

setInitializeParams(LocalDiskInitializeParams.Builder builderForValue)

public LocalDisk.Builder setInitializeParams(LocalDiskInitializeParams.Builder builderForValue)

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

Parameter
Name Description
builderForValue LocalDiskInitializeParams.Builder
Returns
Type Description
LocalDisk.Builder

setInterface(String value)

public LocalDisk.Builder setInterface(String value)

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;

Parameter
Name Description
value String

The interface to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setInterfaceBytes(ByteString value)

public LocalDisk.Builder setInterfaceBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for interface to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setKind(String value)

public LocalDisk.Builder setKind(String value)

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

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

Parameter
Name Description
value String

The kind to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setKindBytes(ByteString value)

public LocalDisk.Builder setKindBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for kind to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setLicenses(int index, String value)

public LocalDisk.Builder setLicenses(int index, String value)

Output only. Any valid publicly visible licenses.

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

Parameters
Name Description
index int

The index to set the value at.

value String

The licenses to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setMode(String value)

public LocalDisk.Builder setMode(String value)

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;

Parameter
Name Description
value String

The mode to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setModeBytes(ByteString value)

public LocalDisk.Builder setModeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for mode to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public LocalDisk.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
LocalDisk.Builder
Overrides

setSource(String value)

public LocalDisk.Builder setSource(String value)

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

string source = 11;

Parameter
Name Description
value String

The source to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setSourceBytes(ByteString value)

public LocalDisk.Builder setSourceBytes(ByteString value)

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

string source = 11;

Parameter
Name Description
value ByteString

The bytes for source to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setType(String value)

public LocalDisk.Builder setType(String value)

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

  • PERSISTENT
  • SCRATCH

string type = 12;

Parameter
Name Description
value String

The type to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public LocalDisk.Builder setTypeBytes(ByteString value)

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

  • PERSISTENT
  • SCRATCH

string type = 12;

Parameter
Name Description
value ByteString

The bytes for type to set.

Returns
Type Description
LocalDisk.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final LocalDisk.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LocalDisk.Builder
Overrides