Package com.google.cloud.aiplatform.v1

Class MachineSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.MachineSpec
All Implemented Interfaces:
MachineSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class MachineSpec extends com.google.protobuf.GeneratedMessage implements MachineSpecOrBuilder
 Specification of a single machine.
Protobuf type google.cloud.aiplatform.v1.MachineSpec
See Also:

  • Field Details

    • MACHINE_TYPE_FIELD_NUMBER

      public static final int MACHINE_TYPE_FIELD_NUMBER
      See Also:

    • ACCELERATOR_TYPE_FIELD_NUMBER

      public static final int ACCELERATOR_TYPE_FIELD_NUMBER
      See Also:

    • ACCELERATOR_COUNT_FIELD_NUMBER

      public static final int ACCELERATOR_COUNT_FIELD_NUMBER
      See Also:

    • GPU_PARTITION_SIZE_FIELD_NUMBER

      public static final int GPU_PARTITION_SIZE_FIELD_NUMBER
      See Also:

    • TPU_TOPOLOGY_FIELD_NUMBER

      public static final int TPU_TOPOLOGY_FIELD_NUMBER
      See Also:

    • RESERVATION_AFFINITY_FIELD_NUMBER

      public static final int RESERVATION_AFFINITY_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

    • getMachineType

      public String getMachineType()
       Immutable. The type of the machine.

 See the [list of machine types supported for
 prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types)

 See the [list of machine types supported for custom
 training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types).

 For [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] this field is
 optional, and the default value is `n1-standard-2`. For
 [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] or as
 part of [WorkerPoolSpec][google.cloud.aiplatform.v1.WorkerPoolSpec] this
 field is required.
      string machine_type = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getMachineType in interface MachineSpecOrBuilder
      Returns:
      The machineType.

    • getMachineTypeBytes

      public com.google.protobuf.ByteString getMachineTypeBytes()
       Immutable. The type of the machine.

 See the [list of machine types supported for
 prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types)

 See the [list of machine types supported for custom
 training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types).

 For [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] this field is
 optional, and the default value is `n1-standard-2`. For
 [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] or as
 part of [WorkerPoolSpec][google.cloud.aiplatform.v1.WorkerPoolSpec] this
 field is required.
      string machine_type = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getMachineTypeBytes in interface MachineSpecOrBuilder
      Returns:
      The bytes for machineType.

    • getAcceleratorTypeValue

      public int getAcceleratorTypeValue()
       Immutable. The type of accelerator(s) that may be attached to the machine
 as per
 [accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count].
      .google.cloud.aiplatform.v1.AcceleratorType accelerator_type = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getAcceleratorTypeValue in interface MachineSpecOrBuilder
      Returns:
      The enum numeric value on the wire for acceleratorType.

    • getAcceleratorType

      public AcceleratorType getAcceleratorType()
       Immutable. The type of accelerator(s) that may be attached to the machine
 as per
 [accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count].
      .google.cloud.aiplatform.v1.AcceleratorType accelerator_type = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getAcceleratorType in interface MachineSpecOrBuilder
      Returns:
      The acceleratorType.

    • getAcceleratorCount

      public int getAcceleratorCount()
       The number of accelerators to attach to the machine.
      int32 accelerator_count = 3;
      Specified by:
      getAcceleratorCount in interface MachineSpecOrBuilder
      Returns:
      The acceleratorCount.

    • getGpuPartitionSize

      public String getGpuPartitionSize()
       Optional. Immutable. The Nvidia GPU partition size.

 When specified, the requested accelerators will be partitioned into
 smaller GPU partitions. For example, if the request is for 8 units of
 NVIDIA A100 GPUs, and gpu_partition_size="1g.10gb", the service will
 create 8 * 7 = 56 partitioned MIG instances.

 The partition size must be a value supported by the requested accelerator.
 Refer to
 [Nvidia GPU
 Partitioning](https://cloud.google.com/kubernetes-engine/docs/how-to/gpus-multi#multi-instance_gpu_partitions)
 for the available partition sizes.

 If set, the accelerator_count should be set to 1.
      string gpu_partition_size = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGpuPartitionSize in interface MachineSpecOrBuilder
      Returns:
      The gpuPartitionSize.

    • getGpuPartitionSizeBytes

      public com.google.protobuf.ByteString getGpuPartitionSizeBytes()
       Optional. Immutable. The Nvidia GPU partition size.

 When specified, the requested accelerators will be partitioned into
 smaller GPU partitions. For example, if the request is for 8 units of
 NVIDIA A100 GPUs, and gpu_partition_size="1g.10gb", the service will
 create 8 * 7 = 56 partitioned MIG instances.

 The partition size must be a value supported by the requested accelerator.
 Refer to
 [Nvidia GPU
 Partitioning](https://cloud.google.com/kubernetes-engine/docs/how-to/gpus-multi#multi-instance_gpu_partitions)
 for the available partition sizes.

 If set, the accelerator_count should be set to 1.
      string gpu_partition_size = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGpuPartitionSizeBytes in interface MachineSpecOrBuilder
      Returns:
      The bytes for gpuPartitionSize.

    • getTpuTopology

      public String getTpuTopology()
       Immutable. The topology of the TPUs. Corresponds to the TPU topologies
 available from GKE. (Example: tpu_topology: "2x2x1").
      string tpu_topology = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getTpuTopology in interface MachineSpecOrBuilder
      Returns:
      The tpuTopology.

    • getTpuTopologyBytes

      public com.google.protobuf.ByteString getTpuTopologyBytes()
       Immutable. The topology of the TPUs. Corresponds to the TPU topologies
 available from GKE. (Example: tpu_topology: "2x2x1").
      string tpu_topology = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getTpuTopologyBytes in interface MachineSpecOrBuilder
      Returns:
      The bytes for tpuTopology.

    • hasReservationAffinity

      public boolean hasReservationAffinity()
       Optional. Immutable. Configuration controlling how this resource pool
 consumes reservation.
      .google.cloud.aiplatform.v1.ReservationAffinity reservation_affinity = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasReservationAffinity in interface MachineSpecOrBuilder
      Returns:
      Whether the reservationAffinity field is set.

    • getReservationAffinity

      public ReservationAffinity getReservationAffinity()
       Optional. Immutable. Configuration controlling how this resource pool
 consumes reservation.
      .google.cloud.aiplatform.v1.ReservationAffinity reservation_affinity = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getReservationAffinity in interface MachineSpecOrBuilder
      Returns:
      The reservationAffinity.

    • getReservationAffinityOrBuilder

      public ReservationAffinityOrBuilder getReservationAffinityOrBuilder()
       Optional. Immutable. Configuration controlling how this resource pool
 consumes reservation.
      .google.cloud.aiplatform.v1.ReservationAffinity reservation_affinity = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getReservationAffinityOrBuilder in interface MachineSpecOrBuilder

    • 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 MachineSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static MachineSpec.Builder newBuilder()

    • newBuilder

      public static MachineSpec.Builder newBuilder(MachineSpec prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static MachineSpec getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<MachineSpec> 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 MachineSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder