Package com.google.cloud.batch.v1alpha

Class ComputeResource

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.batch.v1alpha.ComputeResource
All Implemented Interfaces:
ComputeResourceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ComputeResource extends com.google.protobuf.GeneratedMessage 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](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate)
 field, make sure both fields are compatible with each other.
Protobuf type google.cloud.batch.v1alpha.ComputeResource
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ComputeResource.Builder
    Compute resource requirements.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BOOT_DISK_MIB_FIELD_NUMBER
     
    static final int
    CPU_MILLI_FIELD_NUMBER
     
    static final int
    GPU_COUNT_FIELD_NUMBER
     
    static final int
    MEMORY_MIB_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    long
    getBootDiskMib()
    Extra boot disk size in MiB for each task.
    long
    getCpuMilli()
    The milliCPU count.
    static ComputeResource
    getDefaultInstance()
     
    ComputeResource
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    long
    getGpuCount()
    The GPU count.
    long
    getMemoryMib()
    Memory in MiB.
    com.google.protobuf.Parser<ComputeResource>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ComputeResource.Builder
    newBuilder()
     
    static ComputeResource.Builder
    newBuilder(ComputeResource prototype)
     
    ComputeResource.Builder
    newBuilderForType()
     
    protected ComputeResource.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ComputeResource
    parseDelimitedFrom(InputStream input)
     
    static ComputeResource
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ComputeResource
    parseFrom(byte[] data)
     
    static ComputeResource
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ComputeResource
    parseFrom(com.google.protobuf.ByteString data)
     
    static ComputeResource
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ComputeResource
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ComputeResource
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ComputeResource
    parseFrom(InputStream input)
     
    static ComputeResource
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ComputeResource
    parseFrom(ByteBuffer data)
     
    static ComputeResource
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ComputeResource>
    parser()
     
    ComputeResource.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • CPU_MILLI_FIELD_NUMBER

      public static final int CPU_MILLI_FIELD_NUMBER
      See Also:

    • MEMORY_MIB_FIELD_NUMBER

      public static final int MEMORY_MIB_FIELD_NUMBER
      See Also:

    • GPU_COUNT_FIELD_NUMBER

      public static final int GPU_COUNT_FIELD_NUMBER
      See Also:

    • BOOT_DISK_MIB_FIELD_NUMBER

      public static final int BOOT_DISK_MIB_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy)
 field or inside the `instanceTemplate` in the
 [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#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;
      Specified by:
      getCpuMilli in interface ComputeResourceOrBuilder
      Returns:
      The cpuMilli.

    • 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](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy)
 field or inside the `instanceTemplate` in the
 [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#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;
      Specified by:
      getMemoryMib in interface ComputeResourceOrBuilder
      Returns:
      The memoryMib.

    • getGpuCount

      public long getGpuCount()
       The GPU count.

 Not yet implemented.
      int64 gpu_count = 3;
      Specified by:
      getGpuCount in interface ComputeResourceOrBuilder
      Returns:
      The gpuCount.

    • getBootDiskMib

      public long getBootDiskMib()
       Extra boot disk size in MiB for each task.
      int64 boot_disk_mib = 4;
      Specified by:
      getBootDiskMib in interface ComputeResourceOrBuilder
      Returns:
      The bootDiskMib.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ComputeResource parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComputeResource parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComputeResource parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComputeResource parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComputeResource parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComputeResource parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComputeResource parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ComputeResource parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ComputeResource parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ComputeResource parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ComputeResource parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ComputeResource parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ComputeResource.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ComputeResource.Builder newBuilder()

    • newBuilder

      public static ComputeResource.Builder newBuilder(ComputeResource prototype)

    • toBuilder

      public ComputeResource.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ComputeResource.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ComputeResource getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ComputeResource> parser()

    • getParserForType

      public com.google.protobuf.Parser<ComputeResource> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ComputeResource getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder