Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PersistentResource

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1PersistentResource

Returns a new instance of GoogleCloudAiplatformV1PersistentResource.



20868
20869
20870
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20868

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Time when the PersistentResource was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


20763
20764
20765
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20763

def create_time
  @create_time
end

#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. Corresponds to the JSON property displayName

Returns:

  • (String) 


20769
20770
20771
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20769

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a top- level resource. Corresponds to the JSON property encryptionSpec

Returns:



20775
20776
20777
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20775

def encryption_spec
  @encryption_spec
end

#error ⇒ Google::Apis::AiplatformV1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



20785
20786
20787
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20785

def error
  @error
end

#labels ⇒ Hash<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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


20794
20795
20796
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20794

def labels
  @labels
end

#name ⇒ String

Immutable. Resource name of a PersistentResource. Corresponds to the JSON property name

Returns:

  • (String) 


20799
20800
20801
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20799

def name
  @name
end

#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`. Whereprojectis a project number, as in12345, andnetworkis a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud. google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. Corresponds to the JSON propertynetwork`

Returns:

  • (String) 


20812
20813
20814
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20812

def network
  @network
end

#reserved_ip_ranges ⇒ 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']. Corresponds to the JSON property reservedIpRanges

Returns:

  • (Array<String>) 


20821
20822
20823
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20821

def reserved_ip_ranges
  @reserved_ip_ranges
end

#resource_pools ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ResourcePool>

Required. The spec of the pools of different resources. Corresponds to the JSON property resourcePools

Returns:



20826
20827
20828
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20826

def resource_pools
  @resource_pools
end

#resource_runtime ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ResourceRuntime

Persistent Cluster runtime information as output Corresponds to the JSON property resourceRuntime

Returns:



20831
20832
20833
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20831

def resource_runtime
  @resource_runtime
end

#resource_runtime_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ResourceRuntimeSpec

Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. Corresponds to the JSON property resourceRuntimeSpec

Returns:



20838
20839
20840
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20838

def resource_runtime_spec
  @resource_runtime_spec
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


20843
20844
20845
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20843

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


20849
20850
20851
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20849

def satisfies_pzs
  @satisfies_pzs
end

#start_time ⇒ String

Output only. Time when the PersistentResource for the first time entered the RUNNING state. Corresponds to the JSON property startTime

Returns:

  • (String) 


20856
20857
20858
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20856

def start_time
  @start_time
end

#state ⇒ String

Output only. The detailed state of a Study. Corresponds to the JSON property state

Returns:

  • (String) 


20861
20862
20863
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20861

def state
  @state
end

#update_time ⇒ String

Output only. Time when the PersistentResource was most recently updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


20866
20867
20868
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20866

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20873
20874
20875
20876
20877
20878
20879
20880
20881
20882
20883
20884
20885
20886
20887
20888
20889
20890
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20873

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @error = args[:error] if args.key?(:error)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @reserved_ip_ranges = args[:reserved_ip_ranges] if args.key?(:reserved_ip_ranges)
  @resource_pools = args[:resource_pools] if args.key?(:resource_pools)
  @resource_runtime = args[:resource_runtime] if args.key?(:resource_runtime)
  @resource_runtime_spec = args[:resource_runtime_spec] if args.key?(:resource_runtime_spec)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end