Class ResourcePool (3.44.0)

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

Static Fields

AUTOSCALING_SPEC_FIELD_NUMBER

public static final int AUTOSCALING_SPEC_FIELD_NUMBER
Field Value
Type Description
int

DISK_SPEC_FIELD_NUMBER

public static final int DISK_SPEC_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

MACHINE_SPEC_FIELD_NUMBER

public static final int MACHINE_SPEC_FIELD_NUMBER
Field Value
Type Description
int

REPLICA_COUNT_FIELD_NUMBER

public static final int REPLICA_COUNT_FIELD_NUMBER
Field Value
Type Description
int

USED_REPLICA_COUNT_FIELD_NUMBER

public static final int USED_REPLICA_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ResourcePool getDefaultInstance()
Returns
Type Description
ResourcePool

getDescriptor()

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

newBuilder()

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

newBuilder(ResourcePool prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAutoscalingSpec()

public ResourcePool.AutoscalingSpec getAutoscalingSpec()

Optional. Optional spec to configure GKE autoscaling

.google.cloud.aiplatform.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ResourcePool.AutoscalingSpec

The autoscalingSpec.

getAutoscalingSpecOrBuilder()

public ResourcePool.AutoscalingSpecOrBuilder getAutoscalingSpecOrBuilder()

Optional. Optional spec to configure GKE autoscaling

.google.cloud.aiplatform.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ResourcePool.AutoscalingSpecOrBuilder

getDefaultInstanceForType()

public ResourcePool getDefaultInstanceForType()
Returns
Type Description
ResourcePool

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];

Returns
Type Description
DiskSpec

The diskSpec.

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];

Returns
Type Description
DiskSpecOrBuilder

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];

Returns
Type Description
String

The id.

getIdBytes()

public 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];

Returns
Type Description
ByteString

The bytes for id.

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];

Returns
Type Description
MachineSpec

The machineSpec.

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];

Returns
Type Description
MachineSpecOrBuilder

getParserForType()

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

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];

Returns
Type Description
long

The replicaCount.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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];

Returns
Type Description
long

The usedReplicaCount.

hasAutoscalingSpec()

public boolean hasAutoscalingSpec()

Optional. Optional spec to configure GKE autoscaling

.google.cloud.aiplatform.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the autoscalingSpec field is set.

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];

Returns
Type Description
boolean

Whether the diskSpec field is set.

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];

Returns
Type Description
boolean

Whether the machineSpec field is set.

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];

Returns
Type Description
boolean

Whether the replicaCount field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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