Class AllocationPolicy.Disk (0.24.0) 

public static final class AllocationPolicy.Disk extends GeneratedMessageV3 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.v1.AllocationPolicy.Disk

Inheritance

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

Static Fields

DISK_INTERFACE_FIELD_NUMBER

public static final int DISK_INTERFACE_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_FIELD_NUMBER

public static final int IMAGE_FIELD_NUMBER
Field Value
Type Description
int

SIZE_GB_FIELD_NUMBER

public static final int SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

SNAPSHOT_FIELD_NUMBER

public static final int SNAPSHOT_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 AllocationPolicy.Disk getDefaultInstance()
Returns
Type Description
AllocationPolicy.Disk

getDescriptor()

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

newBuilder()

public static AllocationPolicy.Disk.Builder newBuilder()
Returns
Type Description
AllocationPolicy.Disk.Builder

newBuilder(AllocationPolicy.Disk prototype)

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

parseDelimitedFrom(InputStream input)

public static AllocationPolicy.Disk parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AllocationPolicy.Disk
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static AllocationPolicy.Disk parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AllocationPolicy.Disk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static AllocationPolicy.Disk parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AllocationPolicy.Disk
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static AllocationPolicy.Disk parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AllocationPolicy.Disk
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static AllocationPolicy.Disk parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AllocationPolicy.Disk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<AllocationPolicy.Disk> parser()
Returns
Type Description
Parser<Disk>

Methods

equals(Object obj)

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

getDataSourceCase()

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

getDefaultInstanceForType()

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

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. We only support "SCSI" for persistent disks now.

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. We only support "SCSI" for persistent disks now.

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.

getParserForType()

public Parser<AllocationPolicy.Disk> getParserForType()
Returns
Type Description
Parser<Disk>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 AllocationPolicy.Disk.Builder newBuilderForType()
Returns
Type Description
AllocationPolicy.Disk.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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