Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PersistentResource

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/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) ⇒ GoogleCloudAiplatformV1beta1PersistentResource

Returns a new instance of GoogleCloudAiplatformV1beta1PersistentResource.



12982
12983
12984
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12982

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) 


12889
12890
12891
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12889

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) 


12895
12896
12897
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12895

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

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

Returns:



12901
12902
12903
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12901

def encryption_spec
  @encryption_spec
end

#error ⇒ Google::Apis::AiplatformV1beta1::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:



12911
12912
12913
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12911

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


12920
12921
12922
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12920

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


12925
12926
12927
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12925

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 is not peered with any network. Corresponds to the JSON propertynetwork`

Returns:

  • (String) 


12938
12939
12940
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12938

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 will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. Corresponds to the JSON property reservedIpRanges

Returns:

  • (Array<String>) 


12947
12948
12949
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12947

def reserved_ip_ranges
  @reserved_ip_ranges
end

#resource_pools ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ResourcePool>

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

Returns:



12952
12953
12954
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12952

def resource_pools
  @resource_pools
end

#resource_runtime ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ResourceRuntime

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

Returns:



12957
12958
12959
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12957

def resource_runtime
  @resource_runtime
end

#resource_runtime_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ResourceRuntimeSpec

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

Returns:



12964
12965
12966
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12964

def resource_runtime_spec
  @resource_runtime_spec
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) 


12970
12971
12972
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12970

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


12975
12976
12977
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12975

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) 


12980
12981
12982
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12980

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12987

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)
  @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