Class ComputeResource (0.24.0) 

public final class ComputeResource extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ComputeResource

Static Fields

BOOT_DISK_MIB_FIELD_NUMBER

public static final int BOOT_DISK_MIB_FIELD_NUMBER
Field Value
Type Description
int

CPU_MILLI_FIELD_NUMBER

public static final int CPU_MILLI_FIELD_NUMBER
Field Value
Type Description
int

GPU_COUNT_FIELD_NUMBER

public static final int GPU_COUNT_FIELD_NUMBER
Field Value
Type Description
int

MEMORY_MIB_FIELD_NUMBER

public static final int MEMORY_MIB_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ComputeResource getDefaultInstance()
Returns
Type Description
ComputeResource

getDescriptor()

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

newBuilder()

public static ComputeResource.Builder newBuilder()
Returns
Type Description
ComputeResource.Builder

newBuilder(ComputeResource prototype)

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

parseDelimitedFrom(InputStream input)

public static ComputeResource parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ComputeResource
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ComputeResource parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ComputeResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ComputeResource parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ComputeResource
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ComputeResource parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ComputeResource
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ComputeResource parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ComputeResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ComputeResource> parser()
Returns
Type Description
Parser<ComputeResource>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

getParserForType()

public Parser<ComputeResource> getParserForType()
Returns
Type Description
Parser<ComputeResource>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ComputeResource.Builder toBuilder()
Returns
Type Description
ComputeResource.Builder

writeTo(CodedOutputStream output)

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