- 0.61.0 (latest)
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. Time when the PersistentResource was created.
#display_name
def display_name() -> ::String- (::String) — Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
#display_name=
def display_name=(value) -> ::String- value (::String) — 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) — Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
#encryption_spec
def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec- (::Google::Cloud::AIPlatform::V1::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.
#encryption_spec=
def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec- value (::Google::Cloud::AIPlatform::V1::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.
- (::Google::Cloud::AIPlatform::V1::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.
#error
def error() -> ::Google::Rpc::Status-
(::Google::Rpc::Status) — Output only. Only populated when persistent resource's state is
STOPPINGorERROR.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}-
value (::Google::Protobuf::Map{::String => ::String}) — 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.
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#name
def name() -> ::String- (::String) — Immutable. Resource name of a PersistentResource.
#name=
def name=(value) -> ::String- value (::String) — Immutable. Resource name of a PersistentResource.
- (::String) — Immutable. Resource name of a PersistentResource.
#network
def network() -> ::String-
(::String) — 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 formprojects/{project}/global/networks/{network}. Where {project} is a project number, as in12345, 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.
#network=
def network=(value) -> ::String-
value (::String) — 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 formprojects/{project}/global/networks/{network}. Where {project} is a project number, as in12345, 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.
-
(::String) — 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 formprojects/{project}/global/networks/{network}. Where {project} is a project number, as in12345, 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.
#reserved_ip_ranges
def reserved_ip_ranges() -> ::Array<::String>-
(::Array<::String>) — 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'].
#reserved_ip_ranges=
def reserved_ip_ranges=(value) -> ::Array<::String>-
value (::Array<::String>) — 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'].
-
(::Array<::String>) — 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'].
#resource_pools
def resource_pools() -> ::Array<::Google::Cloud::AIPlatform::V1::ResourcePool>- (::Array<::Google::Cloud::AIPlatform::V1::ResourcePool>) — Required. The spec of the pools of different resources.
#resource_pools=
def resource_pools=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::ResourcePool>- value (::Array<::Google::Cloud::AIPlatform::V1::ResourcePool>) — Required. The spec of the pools of different resources.
- (::Array<::Google::Cloud::AIPlatform::V1::ResourcePool>) — Required. The spec of the pools of different resources.
#resource_runtime
def resource_runtime() -> ::Google::Cloud::AIPlatform::V1::ResourceRuntime- (::Google::Cloud::AIPlatform::V1::ResourceRuntime) — Output only. Runtime information of the Persistent Resource.
#resource_runtime_spec
def resource_runtime_spec() -> ::Google::Cloud::AIPlatform::V1::ResourceRuntimeSpec- (::Google::Cloud::AIPlatform::V1::ResourceRuntimeSpec) — Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
#resource_runtime_spec=
def resource_runtime_spec=(value) -> ::Google::Cloud::AIPlatform::V1::ResourceRuntimeSpec- value (::Google::Cloud::AIPlatform::V1::ResourceRuntimeSpec) — Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
- (::Google::Cloud::AIPlatform::V1::ResourceRuntimeSpec) — Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
#start_time
def start_time() -> ::Google::Protobuf::Timestamp-
(::Google::Protobuf::Timestamp) — Output only. Time when the PersistentResource for the first time entered
the
RUNNINGstate.
#state
def state() -> ::Google::Cloud::AIPlatform::V1::PersistentResource::State- (::Google::Cloud::AIPlatform::V1::PersistentResource::State) — Output only. The detailed state of a Study.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. Time when the PersistentResource was most recently updated.