Class AllocationPolicy.Disk.Builder (0.27.0) 

public static final class AllocationPolicy.Disk.Builder extends GeneratedMessageV3.Builder<AllocationPolicy.Disk.Builder> implements AllocationPolicy.DiskOrBuilder

A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. See https://cloud.google.com/compute/docs/disks#pdspecs and https://cloud.google.com/compute/docs/disks#localssds.

Protobuf type google.cloud.batch.v1alpha.AllocationPolicy.Disk

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AllocationPolicy.Disk.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public AllocationPolicy.Disk build()
Returns
Type Description
AllocationPolicy.Disk

buildPartial()

public AllocationPolicy.Disk buildPartial()
Returns
Type Description
AllocationPolicy.Disk

clear()

public AllocationPolicy.Disk.Builder clear()
Returns
Type Description
AllocationPolicy.Disk.Builder
Overrides

clearDataSource()

public AllocationPolicy.Disk.Builder clearDataSource()
Returns
Type Description
AllocationPolicy.Disk.Builder

clearDiskInterface()

public AllocationPolicy.Disk.Builder clearDiskInterface()

Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.

string disk_interface = 6;

Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearImage()

public AllocationPolicy.Disk.Builder clearImage()

URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs:

  • Specify the image by its family name: projects/{project}/global/images/family/{image_family}

  • Specify the image version: projects/{project}/global/images/{image_version}

    You can also use Batch customized image in short names. The following image values are supported for a boot disk:

  • batch-debian: use Batch Debian images.

  • batch-centos: use Batch CentOS images.
  • batch-cos: use Batch Container-Optimized images.
  • batch-hpc-centos: use Batch HPC CentOS images.

string image = 4;

Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSizeGb()

public AllocationPolicy.Disk.Builder clearSizeGb()

Disk size in GB.

Non-Boot Disk: If the type specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB.

Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec's compute_resource are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.

int64 size_gb = 2;

Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

clearSnapshot()

public AllocationPolicy.Disk.Builder clearSnapshot()

Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.

string snapshot = 5;

Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

clearType()

public AllocationPolicy.Disk.Builder clearType()

Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".

string type = 1;

Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

clone()

public AllocationPolicy.Disk.Builder clone()
Returns
Type Description
AllocationPolicy.Disk.Builder
Overrides

getDataSourceCase()

public AllocationPolicy.Disk.DataSourceCase getDataSourceCase()
Returns
Type Description
AllocationPolicy.Disk.DataSourceCase

getDefaultInstanceForType()

public AllocationPolicy.Disk getDefaultInstanceForType()
Returns
Type Description
AllocationPolicy.Disk

getDescriptorForType()

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

getDiskInterface()

public String getDiskInterface()

Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.

string disk_interface = 6;

Returns
Type Description
String

The diskInterface.

getDiskInterfaceBytes()

public ByteString getDiskInterfaceBytes()

Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.

string disk_interface = 6;

Returns
Type Description
ByteString

The bytes for diskInterface.

getImage()

public String getImage()

URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs:

  • Specify the image by its family name: projects/{project}/global/images/family/{image_family}

  • Specify the image version: projects/{project}/global/images/{image_version}

    You can also use Batch customized image in short names. The following image values are supported for a boot disk:

  • batch-debian: use Batch Debian images.

  • batch-centos: use Batch CentOS images.
  • batch-cos: use Batch Container-Optimized images.
  • batch-hpc-centos: use Batch HPC CentOS images.

string image = 4;

Returns
Type Description
String

The image.

getImageBytes()

public ByteString getImageBytes()

URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs:

  • Specify the image by its family name: projects/{project}/global/images/family/{image_family}

  • Specify the image version: projects/{project}/global/images/{image_version}

    You can also use Batch customized image in short names. The following image values are supported for a boot disk:

  • batch-debian: use Batch Debian images.

  • batch-centos: use Batch CentOS images.
  • batch-cos: use Batch Container-Optimized images.
  • batch-hpc-centos: use Batch HPC CentOS images.

string image = 4;

Returns
Type Description
ByteString

The bytes for image.

getSizeGb()

public long getSizeGb()

Disk size in GB.

Non-Boot Disk: If the type specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB.

Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec's compute_resource are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.

int64 size_gb = 2;

Returns
Type Description
long

The sizeGb.

getSnapshot()

public String getSnapshot()

Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.

string snapshot = 5;

Returns
Type Description
String

The snapshot.

getSnapshotBytes()

public ByteString getSnapshotBytes()

Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.

string snapshot = 5;

Returns
Type Description
ByteString

The bytes for snapshot.

getType()

public String getType()

Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".

string type = 1;

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".

string type = 1;

Returns
Type Description
ByteString

The bytes for type.

hasImage()

public boolean hasImage()

URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs:

  • Specify the image by its family name: projects/{project}/global/images/family/{image_family}

  • Specify the image version: projects/{project}/global/images/{image_version}

    You can also use Batch customized image in short names. The following image values are supported for a boot disk:

  • batch-debian: use Batch Debian images.

  • batch-centos: use Batch CentOS images.
  • batch-cos: use Batch Container-Optimized images.
  • batch-hpc-centos: use Batch HPC CentOS images.

string image = 4;

Returns
Type Description
boolean

Whether the image field is set.

hasSnapshot()

public boolean hasSnapshot()

Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.

string snapshot = 5;

Returns
Type Description
boolean

Whether the snapshot field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AllocationPolicy.Disk other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDiskInterface(String value)

public AllocationPolicy.Disk.Builder setDiskInterface(String value)

Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.

string disk_interface = 6;

Parameter
Name Description
value String

The diskInterface to set.
Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

setDiskInterfaceBytes(ByteString value)

public AllocationPolicy.Disk.Builder setDiskInterfaceBytes(ByteString value)

Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.

string disk_interface = 6;

Parameter
Name Description
value ByteString

The bytes for diskInterface to set.
Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setImage(String value)

public AllocationPolicy.Disk.Builder setImage(String value)

URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs:

  • Specify the image by its family name: projects/{project}/global/images/family/{image_family}

  • Specify the image version: projects/{project}/global/images/{image_version}

    You can also use Batch customized image in short names. The following image values are supported for a boot disk:

  • batch-debian: use Batch Debian images.

  • batch-centos: use Batch CentOS images.
  • batch-cos: use Batch Container-Optimized images.
  • batch-hpc-centos: use Batch HPC CentOS images.

string image = 4;

Parameter
Name Description
value String

The image to set.
Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

setImageBytes(ByteString value)

public AllocationPolicy.Disk.Builder setImageBytes(ByteString value)

URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs:

  • Specify the image by its family name: projects/{project}/global/images/family/{image_family}

  • Specify the image version: projects/{project}/global/images/{image_version}

    You can also use Batch customized image in short names. The following image values are supported for a boot disk:

  • batch-debian: use Batch Debian images.

  • batch-centos: use Batch CentOS images.
  • batch-cos: use Batch Container-Optimized images.
  • batch-hpc-centos: use Batch HPC CentOS images.

string image = 4;

Parameter
Name Description
value ByteString

The bytes for image to set.
Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

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

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

setSizeGb(long value)

public AllocationPolicy.Disk.Builder setSizeGb(long value)

Disk size in GB.

Non-Boot Disk: If the type specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB.

Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec's compute_resource are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.

int64 size_gb = 2;

Parameter
Name Description
value long

The sizeGb to set.
Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

setSnapshot(String value)

public AllocationPolicy.Disk.Builder setSnapshot(String value)

Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.

string snapshot = 5;

Parameter
Name Description
value String

The snapshot to set.
Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

setSnapshotBytes(ByteString value)

public AllocationPolicy.Disk.Builder setSnapshotBytes(ByteString value)

Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.

string snapshot = 5;

Parameter
Name Description
value ByteString

The bytes for snapshot to set.
Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

setType(String value)

public AllocationPolicy.Disk.Builder setType(String value)

Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".

string type = 1;

Parameter
Name Description
value String

The type to set.
Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public AllocationPolicy.Disk.Builder setTypeBytes(ByteString value)

Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".

string type = 1;

Parameter
Name Description
value ByteString

The bytes for type to set.
Returns
Type Description
AllocationPolicy.Disk.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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