Class PersistentResource (1.48.0)

Version latest

• 1.48.0 (latest)
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

PersistentResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Attributes
Name	Description
name	str Immutable. Resource name of a PersistentResource.
display_name	str Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
resource_pools	MutableSequence[google.cloud.aiplatform_v1beta1.types.ResourcePool] Required. The spec of the pools of different resources.
state	google.cloud.aiplatform_v1beta1.types.PersistentResource.State Output only. The detailed state of a Study.
error	google.rpc.status_pb2.Status Output only. Only populated when persistent resource's state is STOPPING or ERROR.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time when the PersistentResource was created.
start_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time when the PersistentResource for the first time entered the RUNNING state.
update_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time when the PersistentResource was most recently updated.
labels	MutableMapping[str, str] 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.
network	str 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
encryption_spec	google.cloud.aiplatform_v1beta1.types.EncryptionSpec 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.
resource_runtime_spec	google.cloud.aiplatform_v1beta1.types.ResourceRuntimeSpec Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
resource_runtime	google.cloud.aiplatform_v1beta1.types.ResourceRuntime Output only. Runtime information of the Persistent Resource.
reserved_ip_ranges	MutableSequence[str] 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'].

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

Describes the PersistentResource state.

Values: STATE_UNSPECIFIED (0): Not set. PROVISIONING (1): The PROVISIONING state indicates the persistent resources is being created. RUNNING (3): The RUNNING state indicates the persistent resource is healthy and fully usable. STOPPING (4): The STOPPING state indicates the persistent resource is being deleted. ERROR (5): The ERROR state indicates the persistent resource may be unusable. Details can be found in the error field. REBOOTING (6): The REBOOTING state indicates the persistent resource is being rebooted (PR is not available right now but is expected to be ready again later). UPDATING (7): The UPDATING state indicates the persistent resource is being updated.

Methods

PersistentResource

PersistentResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.