Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::PersistentResource (v0.51.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
Returns

#display_name

def display_name() -> ::String
Returns
  • (::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
Parameter
  • 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.
Returns
  • (::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
Returns
  • (::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
Parameter
  • 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.
Returns
  • (::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
Returns
  • (::Google::Rpc::Status) — Output only. Only populated when persistent resource's state is STOPPING or ERROR.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::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}
Parameter
  • 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.

Returns
  • (::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
Returns
  • (::String) — Immutable. Resource name of a PersistentResource.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Immutable. Resource name of a PersistentResource.
Returns
  • (::String) — Immutable. Resource name of a PersistentResource.

#network

def network() -> ::String
Returns
  • (::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 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.

#network=

def network=(value) -> ::String
Parameter
  • 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 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.

Returns
  • (::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 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.

#reserved_ip_ranges

def reserved_ip_ranges() -> ::Array<::String>
Returns
  • (::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>
Parameter
  • 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'].

Returns
  • (::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>
Returns

#resource_pools=

def resource_pools=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::ResourcePool>
Parameter
Returns

#resource_runtime

def resource_runtime() -> ::Google::Cloud::AIPlatform::V1::ResourceRuntime
Returns

#resource_runtime_spec

def resource_runtime_spec() -> ::Google::Cloud::AIPlatform::V1::ResourceRuntimeSpec
Returns

#resource_runtime_spec=

def resource_runtime_spec=(value) -> ::Google::Cloud::AIPlatform::V1::ResourceRuntimeSpec
Parameter
Returns

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns

#state

def state() -> ::Google::Cloud::AIPlatform::V1::PersistentResource::State
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns