Package com.google.cloud.aiplatform.v1beta1

Class PersistentResource

  • All Implemented Interfaces:
    PersistentResourceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class PersistentResource
extends com.google.protobuf.GeneratedMessageV3
implements PersistentResourceOrBuilder
     Represents long-lasting resources that are dedicated to users to runs custom
 workloads.
 A PersistentResource can have multiple node pools and each node
 pool can have its own machine spec.
    Protobuf type google.cloud.aiplatform.v1beta1.PersistentResource
    See Also:
    Serialized Form

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Immutable. Resource name of a PersistentResource.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getName in interface PersistentResourceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Immutable. Resource name of a PersistentResource.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getNameBytes in interface PersistentResourceOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Optional. The display name of the PersistentResource.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayName in interface PersistentResourceOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Optional. The display name of the PersistentResource.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayNameBytes in interface PersistentResourceOrBuilder
        Returns:
        The bytes for displayName.

      • getResourcePoolsList

        public List<ResourcePool> getResourcePoolsList()
         Required. The spec of the pools of different resources.
        repeated .google.cloud.aiplatform.v1beta1.ResourcePool resource_pools = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getResourcePoolsList in interface PersistentResourceOrBuilder

      • getResourcePoolsCount

        public int getResourcePoolsCount()
         Required. The spec of the pools of different resources.
        repeated .google.cloud.aiplatform.v1beta1.ResourcePool resource_pools = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getResourcePoolsCount in interface PersistentResourceOrBuilder

      • getResourcePools

        public ResourcePool getResourcePools​(int index)
         Required. The spec of the pools of different resources.
        repeated .google.cloud.aiplatform.v1beta1.ResourcePool resource_pools = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getResourcePools in interface PersistentResourceOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. The detailed state of a Study.
        .google.cloud.aiplatform.v1beta1.PersistentResource.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface PersistentResourceOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public PersistentResource.State getState()
         Output only. The detailed state of a Study.
        .google.cloud.aiplatform.v1beta1.PersistentResource.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface PersistentResourceOrBuilder
        Returns:
        The state.

      • hasError

        public boolean hasError()
         Output only. Only populated when persistent resource's state is `STOPPING`
 or `ERROR`.
        .google.rpc.Status error = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasError in interface PersistentResourceOrBuilder
        Returns:
        Whether the error field is set.

      • getError

        public com.google.rpc.Status getError()
         Output only. Only populated when persistent resource's state is `STOPPING`
 or `ERROR`.
        .google.rpc.Status error = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getError in interface PersistentResourceOrBuilder
        Returns:
        The error.

      • getErrorOrBuilder

        public com.google.rpc.StatusOrBuilder getErrorOrBuilder()
         Output only. Only populated when persistent resource's state is `STOPPING`
 or `ERROR`.
        .google.rpc.Status error = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getErrorOrBuilder in interface PersistentResourceOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Time when the PersistentResource was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface PersistentResourceOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Time when the PersistentResource was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface PersistentResourceOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Time when the PersistentResource was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface PersistentResourceOrBuilder

      • hasStartTime

        public boolean hasStartTime()
         Output only. Time when the PersistentResource for the first time entered
 the `RUNNING` state.
        .google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStartTime in interface PersistentResourceOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Output only. Time when the PersistentResource for the first time entered
 the `RUNNING` state.
        .google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTime in interface PersistentResourceOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. Time when the PersistentResource for the first time entered
 the `RUNNING` state.
        .google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTimeOrBuilder in interface PersistentResourceOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Time when the PersistentResource was most recently updated.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface PersistentResourceOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Time when the PersistentResource was most recently updated.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface PersistentResourceOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Time when the PersistentResource was most recently updated.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface PersistentResourceOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: PersistentResourceOrBuilder
         Optional. The labels with user-defined metadata to organize
 PersistentResource.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface PersistentResourceOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional. The labels with user-defined metadata to organize
 PersistentResource.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface PersistentResourceOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. The labels with user-defined metadata to organize
 PersistentResource.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface PersistentResourceOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional. The labels with user-defined metadata to organize
 PersistentResource.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface PersistentResourceOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. The labels with user-defined metadata to organize
 PersistentResource.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface PersistentResourceOrBuilder

      • getNetwork

        public String getNetwork()
         Optional. The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to peered with
 Vertex AI to host the persistent resources.
 For example, `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 is of the form `projects/{project}/global/networks/{network}`.
 Where {project} is a project number, as in `12345`, and {network} is a
 network name.

 To specify this field, you must have already [configured VPC Network
 Peering for Vertex
 AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).

 If this field is left unspecified, the resources is not peered with any
 network.
        string network = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
        Specified by:
        getNetwork in interface PersistentResourceOrBuilder
        Returns:
        The network.

      • getNetworkBytes

        public com.google.protobuf.ByteString getNetworkBytes()
         Optional. The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to peered with
 Vertex AI to host the persistent resources.
 For example, `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 is of the form `projects/{project}/global/networks/{network}`.
 Where {project} is a project number, as in `12345`, and {network} is a
 network name.

 To specify this field, you must have already [configured VPC Network
 Peering for Vertex
 AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).

 If this field is left unspecified, the resources is not peered with any
 network.
        string network = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
        Specified by:
        getNetworkBytes in interface PersistentResourceOrBuilder
        Returns:
        The bytes for network.

      • hasEncryptionSpec

        public boolean hasEncryptionSpec()
         Optional. Customer-managed encryption key spec for a PersistentResource.
 If set, this PersistentResource and all sub-resources of this
 PersistentResource will be secured by this key.
        .google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasEncryptionSpec in interface PersistentResourceOrBuilder
        Returns:
        Whether the encryptionSpec field is set.

      • getEncryptionSpec

        public EncryptionSpec getEncryptionSpec()
         Optional. Customer-managed encryption key spec for a PersistentResource.
 If set, this PersistentResource and all sub-resources of this
 PersistentResource will be secured by this key.
        .google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionSpec in interface PersistentResourceOrBuilder
        Returns:
        The encryptionSpec.

      • getEncryptionSpecOrBuilder

        public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
         Optional. Customer-managed encryption key spec for a PersistentResource.
 If set, this PersistentResource and all sub-resources of this
 PersistentResource will be secured by this key.
        .google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionSpecOrBuilder in interface PersistentResourceOrBuilder

      • hasResourceRuntimeSpec

        public boolean hasResourceRuntimeSpec()
         Optional. Persistent Resource runtime spec.
 Used for e.g. Ray cluster configuration.
        .google.cloud.aiplatform.v1beta1.ResourceRuntimeSpec resource_runtime_spec = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasResourceRuntimeSpec in interface PersistentResourceOrBuilder
        Returns:
        Whether the resourceRuntimeSpec field is set.

      • getResourceRuntimeSpec

        public ResourceRuntimeSpec getResourceRuntimeSpec()
         Optional. Persistent Resource runtime spec.
 Used for e.g. Ray cluster configuration.
        .google.cloud.aiplatform.v1beta1.ResourceRuntimeSpec resource_runtime_spec = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getResourceRuntimeSpec in interface PersistentResourceOrBuilder
        Returns:
        The resourceRuntimeSpec.

      • hasResourceRuntime

        public boolean hasResourceRuntime()
         Output only. Runtime information of the Persistent Resource.
        .google.cloud.aiplatform.v1beta1.ResourceRuntime resource_runtime = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasResourceRuntime in interface PersistentResourceOrBuilder
        Returns:
        Whether the resourceRuntime field is set.

      • getResourceRuntime

        public ResourceRuntime getResourceRuntime()
         Output only. Runtime information of the Persistent Resource.
        .google.cloud.aiplatform.v1beta1.ResourceRuntime resource_runtime = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getResourceRuntime in interface PersistentResourceOrBuilder
        Returns:
        The resourceRuntime.

      • getReservedIpRangesList

        public com.google.protobuf.ProtocolStringList getReservedIpRangesList()
         Optional. A list of names for the reserved ip ranges under the VPC network
 that can be used for this persistent resource.

 If set, we will deploy the persistent resource within the provided ip
 ranges. Otherwise, the persistent resource will be deployed to any ip
 ranges under the provided VPC network.

 Example: ['vertex-ai-ip-range'].
        repeated string reserved_ip_ranges = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReservedIpRangesList in interface PersistentResourceOrBuilder
        Returns:
        A list containing the reservedIpRanges.

      • getReservedIpRangesCount

        public int getReservedIpRangesCount()
         Optional. A list of names for the reserved ip ranges under the VPC network
 that can be used for this persistent resource.

 If set, we will deploy the persistent resource within the provided ip
 ranges. Otherwise, the persistent resource will be deployed to any ip
 ranges under the provided VPC network.

 Example: ['vertex-ai-ip-range'].
        repeated string reserved_ip_ranges = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReservedIpRangesCount in interface PersistentResourceOrBuilder
        Returns:
        The count of reservedIpRanges.

      • getReservedIpRanges

        public String getReservedIpRanges​(int index)
         Optional. A list of names for the reserved ip ranges under the VPC network
 that can be used for this persistent resource.

 If set, we will deploy the persistent resource within the provided ip
 ranges. Otherwise, the persistent resource will be deployed to any ip
 ranges under the provided VPC network.

 Example: ['vertex-ai-ip-range'].
        repeated string reserved_ip_ranges = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReservedIpRanges in interface PersistentResourceOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The reservedIpRanges at the given index.

      • getReservedIpRangesBytes

        public com.google.protobuf.ByteString getReservedIpRangesBytes​(int index)
         Optional. A list of names for the reserved ip ranges under the VPC network
 that can be used for this persistent resource.

 If set, we will deploy the persistent resource within the provided ip
 ranges. Otherwise, the persistent resource will be deployed to any ip
 ranges under the provided VPC network.

 Example: ['vertex-ai-ip-range'].
        repeated string reserved_ip_ranges = 15 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReservedIpRangesBytes in interface PersistentResourceOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the reservedIpRanges at the given index.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected PersistentResource.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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