Struct PersistentResource

#[non_exhaustive]
pub struct PersistentResource {

    pub name: String,
    pub display_name: String,
    pub resource_pools: Vec<ResourcePool>,
    pub state: State,
    pub error: Option<Status>,
    pub create_time: Option<Timestamp>,
    pub start_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub network: String,
    pub encryption_spec: Option<EncryptionSpec>,
    pub resource_runtime_spec: Option<ResourceRuntimeSpec>,
    pub resource_runtime: Option<ResourceRuntime>,
    pub reserved_ip_ranges: Vec<String>,
    /* private fields */
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Immutable. Resource name of a PersistentResource.

display_name: 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.

resource_pools: Vec<ResourcePool>

Required. The spec of the pools of different resources.

state: State

Output only. The detailed state of a Study.

error: Option<Status>

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

create_time: Option<Timestamp>

Output only. Time when the PersistentResource was created.

start_time: Option<Timestamp>

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

update_time: Option<Timestamp>

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

labels: HashMap<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.

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 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.

encryption_spec: Option<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: Option<ResourceRuntimeSpec>

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

resource_runtime: Option<ResourceRuntime>

Output only. Runtime information of the Persistent Resource.

reserved_ip_ranges: Vec<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’].

Implementations

impl PersistentResource

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

pub fn set_resource_pools<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<ResourcePool>,

Sets the value of resource_pools.

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

pub fn set_error<T: Into<Option<Status>>>(self, v: T) -> Self

Sets the value of error.

pub fn set_create_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of create_time.

pub fn set_start_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of start_time.

pub fn set_update_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of update_time.

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

pub fn set_network<T: Into<String>>(self, v: T) -> Self

Sets the value of network.

pub fn set_encryption_spec<T: Into<Option<EncryptionSpec>>>(self, v: T) -> Self

Sets the value of encryption_spec.

pub fn set_resource_runtime_spec<T: Into<Option<ResourceRuntimeSpec>>>( self, v: T, ) -> Self

Sets the value of resource_runtime_spec.

pub fn set_resource_runtime<T: Into<Option<ResourceRuntime>>>( self, v: T, ) -> Self

Sets the value of resource_runtime.

pub fn set_reserved_ip_ranges<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of reserved_ip_ranges.

Trait Implementations

impl Clone for PersistentResource

fn clone(&self) -> PersistentResource

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PersistentResource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PersistentResource

fn default() -> PersistentResource

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PersistentResource

where PersistentResource: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for PersistentResource

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PersistentResource

fn eq(&self, other: &PersistentResource) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PersistentResource

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PersistentResource