com.google.cloud.aiplatform.v1

Class ResourcePool

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.ResourcePool

All Implemented Interfaces:

ResourcePoolOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ResourcePool
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourcePool.AutoscalingSpec The min/max number of replicas allowed if enabling autoscaling
static interface	ResourcePool.AutoscalingSpecOrBuilder
static class	ResourcePool.Builder Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTOSCALING_SPEC_FIELD_NUMBER
static int	DISK_SPEC_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	MACHINE_SPEC_FIELD_NUMBER
static int	REPLICA_COUNT_FIELD_NUMBER
static int	USED_REPLICA_COUNT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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 and Description
boolean	equals(Object obj)
ResourcePool.AutoscalingSpec	getAutoscalingSpec() Optional.
ResourcePool.AutoscalingSpecOrBuilder	getAutoscalingSpecOrBuilder() Optional.
static ResourcePool	getDefaultInstance()
ResourcePool	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
DiskSpec	getDiskSpec() Optional.
DiskSpecOrBuilder	getDiskSpecOrBuilder() Optional.
String	getId() Immutable.
com.google.protobuf.ByteString	getIdBytes() Immutable.
MachineSpec	getMachineSpec() Required.
MachineSpecOrBuilder	getMachineSpecOrBuilder() Required.
com.google.protobuf.Parser<ResourcePool>	getParserForType()
long	getReplicaCount() Optional.
int	getSerializedSize()
long	getUsedReplicaCount() Output only.
boolean	hasAutoscalingSpec() Optional.
boolean	hasDiskSpec() Optional.
int	hashCode()
boolean	hasMachineSpec() Required.
boolean	hasReplicaCount() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ResourcePool.Builder	newBuilder()
static ResourcePool.Builder	newBuilder(ResourcePool prototype)
ResourcePool.Builder	newBuilderForType()
protected ResourcePool.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ResourcePool	parseDelimitedFrom(InputStream input)
static ResourcePool	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourcePool	parseFrom(byte[] data)
static ResourcePool	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourcePool	parseFrom(ByteBuffer data)
static ResourcePool	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourcePool	parseFrom(com.google.protobuf.ByteString data)
static ResourcePool	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourcePool	parseFrom(com.google.protobuf.CodedInputStream input)
static ResourcePool	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourcePool	parseFrom(InputStream input)
static ResourcePool	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ResourcePool>	parser()
ResourcePool.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

MACHINE_SPEC_FIELD_NUMBER

public static final int MACHINE_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

REPLICA_COUNT_FIELD_NUMBER

public static final int REPLICA_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

DISK_SPEC_FIELD_NUMBER

public static final int DISK_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

USED_REPLICA_COUNT_FIELD_NUMBER

public static final int USED_REPLICA_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

AUTOSCALING_SPEC_FIELD_NUMBER

public static final int AUTOSCALING_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

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.

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.

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.

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.

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.

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

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.v1.ResourcePool.AutoscalingSpec autoscaling_spec = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAutoscalingSpec in interface ResourcePoolOrBuilder

Returns:

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

Specified by:

getAutoscalingSpecOrBuilder in interface ResourcePoolOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 ResourcePool parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourcePool parseFrom(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourcePool parseFrom(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourcePool parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ResourcePool parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static ResourcePool parseFrom(com.google.protobuf.CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ResourcePool.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ResourcePool.Builder newBuilder()

newBuilder

public static ResourcePool.Builder newBuilder(ResourcePool prototype)

toBuilder

public ResourcePool.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ResourcePool.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ResourcePool getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ResourcePool> 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.GeneratedMessageV3

getDefaultInstanceForType

public ResourcePool getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder