Class ComputeResource.Builder (0.28.0)

public static final class ComputeResource.Builder extends GeneratedMessageV3.Builder<ComputeResource.Builder> implements ComputeResourceOrBuilder

Compute resource requirements.

ComputeResource defines the amount of resources required for each task. Make sure your tasks have enough resources to successfully run. If you also define the types of resources for a job to use with the InstancePolicyOrTemplate field, make sure both fields are compatible with each other.

Protobuf type google.cloud.batch.v1alpha.ComputeResource

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ComputeResource build()
Returns
Type Description
ComputeResource

buildPartial()

public ComputeResource buildPartial()
Returns
Type Description
ComputeResource

clear()

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

clearBootDiskMib()

public ComputeResource.Builder clearBootDiskMib()

Extra boot disk size in MiB for each task.

int64 boot_disk_mib = 4;

Returns
Type Description
ComputeResource.Builder

This builder for chaining.

clearCpuMilli()

public ComputeResource.Builder clearCpuMilli()

The milliCPU count.

cpuMilli defines the amount of CPU resources per task in milliCPU units. For example, 1000 corresponds to 1 vCPU per task. If undefined, the default value is 2000.

If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time.

For example, if you specify the n2-standard-2 machine type, which has 2 vCPUs each, you are recommended to set cpuMilli no more than 2000, or you are recommended to run two tasks on the same VM if you set cpuMilli to 1000 or less.

int64 cpu_milli = 1;

Returns
Type Description
ComputeResource.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearGpuCount()

public ComputeResource.Builder clearGpuCount()

The GPU count.

Not yet implemented.

int64 gpu_count = 3;

Returns
Type Description
ComputeResource.Builder

This builder for chaining.

clearMemoryMib()

public ComputeResource.Builder clearMemoryMib()

Memory in MiB.

memoryMib defines the amount of memory per task in MiB units. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time.

For example, if you specify the n2-standard-2 machine type, which has 8 GiB each, you are recommended to set memoryMib to no more than 8192, or you are recommended to run two tasks on the same VM if you set memoryMib to 4096 or less.

int64 memory_mib = 2;

Returns
Type Description
ComputeResource.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public ComputeResource.Builder clone()
Returns
Type Description
ComputeResource.Builder
Overrides

getBootDiskMib()

public long getBootDiskMib()

Extra boot disk size in MiB for each task.

int64 boot_disk_mib = 4;

Returns
Type Description
long

The bootDiskMib.

getCpuMilli()

public long getCpuMilli()

The milliCPU count.

cpuMilli defines the amount of CPU resources per task in milliCPU units. For example, 1000 corresponds to 1 vCPU per task. If undefined, the default value is 2000.

If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time.

For example, if you specify the n2-standard-2 machine type, which has 2 vCPUs each, you are recommended to set cpuMilli no more than 2000, or you are recommended to run two tasks on the same VM if you set cpuMilli to 1000 or less.

int64 cpu_milli = 1;

Returns
Type Description
long

The cpuMilli.

getDefaultInstanceForType()

public ComputeResource getDefaultInstanceForType()
Returns
Type Description
ComputeResource

getDescriptorForType()

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

getGpuCount()

public long getGpuCount()

The GPU count.

Not yet implemented.

int64 gpu_count = 3;

Returns
Type Description
long

The gpuCount.

getMemoryMib()

public long getMemoryMib()

Memory in MiB.

memoryMib defines the amount of memory per task in MiB units. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time.

For example, if you specify the n2-standard-2 machine type, which has 8 GiB each, you are recommended to set memoryMib to no more than 8192, or you are recommended to run two tasks on the same VM if you set memoryMib to 4096 or less.

int64 memory_mib = 2;

Returns
Type Description
long

The memoryMib.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ComputeResource other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBootDiskMib(long value)

public ComputeResource.Builder setBootDiskMib(long value)

Extra boot disk size in MiB for each task.

int64 boot_disk_mib = 4;

Parameter
Name Description
value long

The bootDiskMib to set.

Returns
Type Description
ComputeResource.Builder

This builder for chaining.

setCpuMilli(long value)

public ComputeResource.Builder setCpuMilli(long value)

The milliCPU count.

cpuMilli defines the amount of CPU resources per task in milliCPU units. For example, 1000 corresponds to 1 vCPU per task. If undefined, the default value is 2000.

If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time.

For example, if you specify the n2-standard-2 machine type, which has 2 vCPUs each, you are recommended to set cpuMilli no more than 2000, or you are recommended to run two tasks on the same VM if you set cpuMilli to 1000 or less.

int64 cpu_milli = 1;

Parameter
Name Description
value long

The cpuMilli to set.

Returns
Type Description
ComputeResource.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setGpuCount(long value)

public ComputeResource.Builder setGpuCount(long value)

The GPU count.

Not yet implemented.

int64 gpu_count = 3;

Parameter
Name Description
value long

The gpuCount to set.

Returns
Type Description
ComputeResource.Builder

This builder for chaining.

setMemoryMib(long value)

public ComputeResource.Builder setMemoryMib(long value)

Memory in MiB.

memoryMib defines the amount of memory per task in MiB units. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time.

For example, if you specify the n2-standard-2 machine type, which has 8 GiB each, you are recommended to set memoryMib to no more than 8192, or you are recommended to run two tasks on the same VM if you set memoryMib to 4096 or less.

int64 memory_mib = 2;

Parameter
Name Description
value long

The memoryMib to set.

Returns
Type Description
ComputeResource.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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