Class AllocationPolicy.Disk.Builder (0.23.0)

Version 0.23.0

• 0.51.0 (latest)
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.2
• 0.2.2
• 0.1.1

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.v1.AllocationPolicy.Disk

Inheritance

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

Implements

AllocationPolicy.DiskOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearImage()

public AllocationPolicy.Disk.Builder clearImage()

Name of an image used as the data source. For example, the following are all valid URLs:

• Specify the image by its family name: <pre><code>projects/<var class="apiparam">project</var>/global/images/family/<var class="apiparam">image_family</var></code></pre>

• Specify the image version: <pre>projects/<var class="apiparam">project</var>/global/images/<var class="apiparam">image_version</var></code></pre> 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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSizeGb()

public AllocationPolicy.Disk.Builder clearSizeGb()

Disk size in GB.

For persistent disk, this field is ignored if data_source is image or snapshot. For local SSD, size_gb should be a multiple of 375GB, otherwise, the final size will be the next greater multiple of 375 GB. For 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.

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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()

Name of an image used as the data source. For example, the following are all valid URLs:

• Specify the image by its family name: <pre><code>projects/<var class="apiparam">project</var>/global/images/family/<var class="apiparam">image_family</var></code></pre>

• Specify the image version: <pre>projects/<var class="apiparam">project</var>/global/images/<var class="apiparam">image_version</var></code></pre> 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()

Name of an image used as the data source. For example, the following are all valid URLs:

• Specify the image by its family name: <pre><code>projects/<var class="apiparam">project</var>/global/images/family/<var class="apiparam">image_family</var></code></pre>

• Specify the image version: <pre>projects/<var class="apiparam">project</var>/global/images/<var class="apiparam">image_version</var></code></pre> 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.

For persistent disk, this field is ignored if data_source is image or snapshot. For local SSD, size_gb should be a multiple of 375GB, otherwise, the final size will be the next greater multiple of 375 GB. For 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.

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()

Name of an image used as the data source. For example, the following are all valid URLs:

• Specify the image by its family name: <pre><code>projects/<var class="apiparam">project</var>/global/images/family/<var class="apiparam">image_family</var></code></pre>

• Specify the image version: <pre>projects/<var class="apiparam">project</var>/global/images/<var class="apiparam">image_version</var></code></pre> 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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AllocationPolicy.Disk.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
AllocationPolicy.Disk.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

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

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setImage(String value)

public AllocationPolicy.Disk.Builder setImage(String value)

Name of an image used as the data source. For example, the following are all valid URLs:

• Specify the image by its family name: <pre><code>projects/<var class="apiparam">project</var>/global/images/family/<var class="apiparam">image_family</var></code></pre>

• Specify the image version: <pre>projects/<var class="apiparam">project</var>/global/images/<var class="apiparam">image_version</var></code></pre> 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)

Name of an image used as the data source. For example, the following are all valid URLs:

• Specify the image by its family name: <pre><code>projects/<var class="apiparam">project</var>/global/images/family/<var class="apiparam">image_family</var></code></pre>

• Specify the image version: <pre>projects/<var class="apiparam">project</var>/global/images/<var class="apiparam">image_version</var></code></pre> 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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSizeGb(long value)

public AllocationPolicy.Disk.Builder setSizeGb(long value)

Disk size in GB.

For persistent disk, this field is ignored if data_source is image or snapshot. For local SSD, size_gb should be a multiple of 375GB, otherwise, the final size will be the next greater multiple of 375 GB. For 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.

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)