Package com.google.cloud.aiplatform.v1

Class ResourcePool.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ResourcePool.Builder>
com.google.cloud.aiplatform.v1.ResourcePool.Builder
All Implemented Interfaces:
ResourcePoolOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ResourcePool
public static final class ResourcePool.Builder extends com.google.protobuf.GeneratedMessage.Builder<ResourcePool.Builder> implements ResourcePoolOrBuilder
 Represents the spec of a group of resources of the same type,
 for example machine type, disk, and accelerators, in a PersistentResource.
Protobuf type google.cloud.aiplatform.v1.ResourcePool

  • 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.Builder<ResourcePool.Builder>

    • clear

      public ResourcePool.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ResourcePool.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ResourcePool.Builder>

    • getDefaultInstanceForType

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

    • build

      public ResourcePool build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ResourcePool buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ResourcePool.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ResourcePool.Builder>

    • mergeFrom

      public ResourcePool.Builder mergeFrom(ResourcePool other)

    • isInitialized

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

    • mergeFrom

      public ResourcePool.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ResourcePool.Builder>
      Throws:
      IOException

    • getId

      public String getId()
       Immutable. The unique ID in a PersistentResource for referring to this
 resource pool. User can specify it if necessary. Otherwise, it's generated
 automatically.
      string id = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getId in interface ResourcePoolOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       Immutable. The unique ID in a PersistentResource for referring to this
 resource pool. User can specify it if necessary. Otherwise, it's generated
 automatically.
      string id = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getIdBytes in interface ResourcePoolOrBuilder
      Returns:
      The bytes for id.

    • setId

      public ResourcePool.Builder setId(String value)
       Immutable. The unique ID in a PersistentResource for referring to this
 resource pool. User can specify it if necessary. Otherwise, it's generated
 automatically.
      string id = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.

    • clearId

      public ResourcePool.Builder clearId()
       Immutable. The unique ID in a PersistentResource for referring to this
 resource pool. User can specify it if necessary. Otherwise, it's generated
 automatically.
      string id = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • setIdBytes

      public ResourcePool.Builder setIdBytes(com.google.protobuf.ByteString value)
       Immutable. The unique ID in a PersistentResource for referring to this
 resource pool. User can specify it if necessary. Otherwise, it's generated
 automatically.
      string id = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The bytes for id to set.
      Returns:
      This builder for chaining.

    • hasMachineSpec

      public boolean hasMachineSpec()
       Required. Immutable. The specification of a single machine.
      .google.cloud.aiplatform.v1.MachineSpec machine_spec = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      hasMachineSpec in interface ResourcePoolOrBuilder
      Returns:
      Whether the machineSpec field is set.

    • getMachineSpec

      public MachineSpec getMachineSpec()
       Required. Immutable. The specification of a single machine.
      .google.cloud.aiplatform.v1.MachineSpec machine_spec = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getMachineSpec in interface ResourcePoolOrBuilder
      Returns:
      The machineSpec.

    • setMachineSpec

      public ResourcePool.Builder setMachineSpec(MachineSpec value)
       Required. Immutable. The specification of a single machine.
      .google.cloud.aiplatform.v1.MachineSpec machine_spec = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

    • setMachineSpec

      public ResourcePool.Builder setMachineSpec(MachineSpec.Builder builderForValue)
       Required. Immutable. The specification of a single machine.
      .google.cloud.aiplatform.v1.MachineSpec machine_spec = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

    • mergeMachineSpec

      public ResourcePool.Builder mergeMachineSpec(MachineSpec value)
       Required. Immutable. The specification of a single machine.
      .google.cloud.aiplatform.v1.MachineSpec machine_spec = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

    • clearMachineSpec

      public ResourcePool.Builder clearMachineSpec()
       Required. Immutable. The specification of a single machine.
      .google.cloud.aiplatform.v1.MachineSpec machine_spec = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

    • getMachineSpecBuilder

      public MachineSpec.Builder getMachineSpecBuilder()
       Required. Immutable. The specification of a single machine.
      .google.cloud.aiplatform.v1.MachineSpec machine_spec = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

    • getMachineSpecOrBuilder

      public MachineSpecOrBuilder getMachineSpecOrBuilder()
       Required. Immutable. The specification of a single machine.
      .google.cloud.aiplatform.v1.MachineSpec machine_spec = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getMachineSpecOrBuilder in interface ResourcePoolOrBuilder

    • hasReplicaCount

      public boolean hasReplicaCount()
       Optional. The total number of machines to use for this resource pool.
      optional int64 replica_count = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasReplicaCount in interface ResourcePoolOrBuilder
      Returns:
      Whether the replicaCount field is set.

    • getReplicaCount

      public long getReplicaCount()
       Optional. The total number of machines to use for this resource pool.
      optional int64 replica_count = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getReplicaCount in interface ResourcePoolOrBuilder
      Returns:
      The replicaCount.

    • setReplicaCount

      public ResourcePool.Builder setReplicaCount(long value)
       Optional. The total number of machines to use for this resource pool.
      optional int64 replica_count = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The replicaCount to set.
      Returns:
      This builder for chaining.

    • clearReplicaCount

      public ResourcePool.Builder clearReplicaCount()
       Optional. The total number of machines to use for this resource pool.
      optional int64 replica_count = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasDiskSpec

      public boolean hasDiskSpec()
       Optional. Disk spec for the machine in this node pool.
      .google.cloud.aiplatform.v1.DiskSpec disk_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasDiskSpec in interface ResourcePoolOrBuilder
      Returns:
      Whether the diskSpec field is set.

    • getDiskSpec

      public DiskSpec getDiskSpec()
       Optional. Disk spec for the machine in this node pool.
      .google.cloud.aiplatform.v1.DiskSpec disk_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDiskSpec in interface ResourcePoolOrBuilder
      Returns:
      The diskSpec.

    • setDiskSpec

      public ResourcePool.Builder setDiskSpec(DiskSpec value)
       Optional. Disk spec for the machine in this node pool.
      .google.cloud.aiplatform.v1.DiskSpec disk_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

    • setDiskSpec

      public ResourcePool.Builder setDiskSpec(DiskSpec.Builder builderForValue)
       Optional. Disk spec for the machine in this node pool.
      .google.cloud.aiplatform.v1.DiskSpec disk_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

    • mergeDiskSpec

      public ResourcePool.Builder mergeDiskSpec(DiskSpec value)
       Optional. Disk spec for the machine in this node pool.
      .google.cloud.aiplatform.v1.DiskSpec disk_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

    • clearDiskSpec

      public ResourcePool.Builder clearDiskSpec()
       Optional. Disk spec for the machine in this node pool.
      .google.cloud.aiplatform.v1.DiskSpec disk_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getDiskSpecBuilder

      public DiskSpec.Builder getDiskSpecBuilder()
       Optional. Disk spec for the machine in this node pool.
      .google.cloud.aiplatform.v1.DiskSpec disk_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getDiskSpecOrBuilder

      public DiskSpecOrBuilder getDiskSpecOrBuilder()
       Optional. Disk spec for the machine in this node pool.
      .google.cloud.aiplatform.v1.DiskSpec disk_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDiskSpecOrBuilder in interface ResourcePoolOrBuilder

    • getUsedReplicaCount

      public long getUsedReplicaCount()
       Output only. The number of machines currently in use by training jobs for
 this resource pool. Will replace idle_replica_count.
      int64 used_replica_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUsedReplicaCount in interface ResourcePoolOrBuilder
      Returns:
      The usedReplicaCount.

    • setUsedReplicaCount

      public ResourcePool.Builder setUsedReplicaCount(long value)
       Output only. The number of machines currently in use by training jobs for
 this resource pool. Will replace idle_replica_count.
      int64 used_replica_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The usedReplicaCount to set.
      Returns:
      This builder for chaining.

    • clearUsedReplicaCount

      public ResourcePool.Builder clearUsedReplicaCount()
       Output only. The number of machines currently in use by training jobs for
 this resource pool. Will replace idle_replica_count.
      int64 used_replica_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasAutoscalingSpec

      public boolean hasAutoscalingSpec()
       Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling
      .google.cloud.aiplatform.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAutoscalingSpec in interface ResourcePoolOrBuilder
      Returns:
      Whether the autoscalingSpec field is set.

    • getAutoscalingSpec

      public ResourcePool.AutoscalingSpec getAutoscalingSpec()
       Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling
      .google.cloud.aiplatform.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAutoscalingSpec in interface ResourcePoolOrBuilder
      Returns:
      The autoscalingSpec.

    • setAutoscalingSpec

      public ResourcePool.Builder setAutoscalingSpec(ResourcePool.AutoscalingSpec value)
       Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling
      .google.cloud.aiplatform.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];

    • setAutoscalingSpec

      public ResourcePool.Builder setAutoscalingSpec(ResourcePool.AutoscalingSpec.Builder builderForValue)
       Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling
      .google.cloud.aiplatform.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];

    • mergeAutoscalingSpec

      public ResourcePool.Builder mergeAutoscalingSpec(ResourcePool.AutoscalingSpec value)
       Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling
      .google.cloud.aiplatform.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];

    • clearAutoscalingSpec

      public ResourcePool.Builder clearAutoscalingSpec()
       Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling
      .google.cloud.aiplatform.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getAutoscalingSpecBuilder

      public ResourcePool.AutoscalingSpec.Builder getAutoscalingSpecBuilder()
       Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling
      .google.cloud.aiplatform.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getAutoscalingSpecOrBuilder

      public ResourcePool.AutoscalingSpecOrBuilder getAutoscalingSpecOrBuilder()
       Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling
      .google.cloud.aiplatform.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAutoscalingSpecOrBuilder in interface ResourcePoolOrBuilder