Cloud AI Platform v1 API - Class PersistentResource (3.13.0) 

public sealed class PersistentResource : IMessage<PersistentResource>, IEquatable<PersistentResource>, IDeepCloneable<PersistentResource>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class PersistentResource.

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.

Inheritance

object > PersistentResource

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

PersistentResource()

public PersistentResource()

PersistentResource(PersistentResource)

public PersistentResource(PersistentResource other)
Parameter
Name Description
other PersistentResource

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Time when the PersistentResource was created.

Property Value
Type Description
Timestamp

DisplayName

public string DisplayName { get; set; }

Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Property Value
Type Description
string

EncryptionSpec

public EncryptionSpec EncryptionSpec { get; set; }

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.

Property Value
Type Description
EncryptionSpec

Error

public Status Error { get; set; }

Output only. Only populated when persistent resource's state is STOPPING or ERROR.

Property Value
Type Description
Status

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Immutable. Resource name of a PersistentResource.

Property Value
Type Description
string

Network

public string Network { get; set; }

Optional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources. For example, projects/12345/global/networks/myVPC. Format 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.

If this field is left unspecified, the resources aren't peered with any network.

Property Value
Type Description
string

NetworkAsNetworkName

public NetworkName NetworkAsNetworkName { get; set; }

NetworkName-typed view over the Network resource name property.

Property Value
Type Description
NetworkName

PersistentResourceName

public PersistentResourceName PersistentResourceName { get; set; }

PersistentResourceName-typed view over the Name resource name property.

Property Value
Type Description
PersistentResourceName

ReservedIpRanges

public RepeatedField<string> ReservedIpRanges { get; }

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 is deployed to any IP ranges under the provided VPC network.

Example: ['vertex-ai-ip-range'].

Property Value
Type Description
RepeatedFieldstring

ResourcePools

public RepeatedField<ResourcePool> ResourcePools { get; }

Required. The spec of the pools of different resources.

Property Value
Type Description
RepeatedFieldResourcePool

ResourceRuntime

public ResourceRuntime ResourceRuntime { get; set; }

Output only. Runtime information of the Persistent Resource.

Property Value
Type Description
ResourceRuntime

ResourceRuntimeSpec

public ResourceRuntimeSpec ResourceRuntimeSpec { get; set; }

Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.

Property Value
Type Description
ResourceRuntimeSpec

StartTime

public Timestamp StartTime { get; set; }

Output only. Time when the PersistentResource for the first time entered the RUNNING state.

Property Value
Type Description
Timestamp

State

public PersistentResource.Types.State State { get; set; }

Output only. The detailed state of a Study.

Property Value
Type Description
PersistentResourceTypesState

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Time when the PersistentResource was most recently updated.

Property Value
Type Description
Timestamp