Class 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.GeneratedMessageV3.Builder<ResourcePool.Builder>
    implements ResourcePoolOrBuilder
     Represents the spec a group of resources of same type, e.g. machine, disk
     and accelerators, in a PersistentResource.
     
    Protobuf type google.cloud.aiplatform.v1beta1.ResourcePool
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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
      • clone

        public ResourcePool.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ResourcePool.Builder>
      • setField

        public ResourcePool.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourcePool.Builder>
      • clearField

        public ResourcePool.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourcePool.Builder>
      • clearOneof

        public ResourcePool.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ResourcePool.Builder>
      • setRepeatedField

        public ResourcePool.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourcePool.Builder>
      • addRepeatedField

        public ResourcePool.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourcePool.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>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.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 to refer the this resource
         pool. User can specify it if need to use it, otherwise we will generate it
         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 to refer the this resource
         pool. User can specify it if need to use it, otherwise we will generate it
         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 to refer the this resource
         pool. User can specify it if need to use it, otherwise we will generate it
         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 to refer the this resource
         pool. User can specify it if need to use it, otherwise we will generate it
         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 to refer the this resource
         pool. User can specify it if need to use it, otherwise we will generate it
         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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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 autoscaling
         
        .google.cloud.aiplatform.v1beta1.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 autoscaling
         
        .google.cloud.aiplatform.v1beta1.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 autoscaling
         
        .google.cloud.aiplatform.v1beta1.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 autoscaling
         
        .google.cloud.aiplatform.v1beta1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];
      • mergeAutoscalingSpec

        public ResourcePool.Builder mergeAutoscalingSpec​(ResourcePool.AutoscalingSpec value)
         Optional. Optional spec to configure GKE autoscaling
         
        .google.cloud.aiplatform.v1beta1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];
      • clearAutoscalingSpec

        public ResourcePool.Builder clearAutoscalingSpec()
         Optional. Optional spec to configure GKE autoscaling
         
        .google.cloud.aiplatform.v1beta1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];
      • getAutoscalingSpecBuilder

        public ResourcePool.AutoscalingSpec.Builder getAutoscalingSpecBuilder()
         Optional. Optional spec to configure GKE autoscaling
         
        .google.cloud.aiplatform.v1beta1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];
      • setUnknownFields

        public final ResourcePool.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ResourcePool.Builder>
      • mergeUnknownFields

        public final ResourcePool.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ResourcePool.Builder>