Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study

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

A message representing a Study.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1Study

Returns a new instance of GoogleCloudAiplatformV1Study.



22262
22263
22264
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 22262

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

Instance Attribute Details

#create_time ⇒ String

Output only. Time at which the study was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


22233
22234
22235
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 22233

def create_time
  @create_time
end

#display_name ⇒ String

Required. Describes the Study, default value is empty string. Corresponds to the JSON property displayName

Returns:

  • (String) 


22238
22239
22240
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 22238

def display_name
  @display_name
end

#inactive_reason ⇒ String

Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. Corresponds to the JSON property inactiveReason

Returns:

  • (String) 


22244
22245
22246
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 22244

def inactive_reason
  @inactive_reason
end

#name ⇒ String

Output only. The name of a study. The study's globally unique identifier. Format: projects/project/locations/location/studies/study` Corresponds to the JSON propertyname`

Returns:

  • (String) 


22250
22251
22252
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 22250

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


22255
22256
22257
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 22255

def state
  @state
end

#study_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpec

Represents specification of a Study. Corresponds to the JSON property studySpec

Returns:



22260
22261
22262
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 22260

def study_spec
  @study_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



22267
22268
22269
22270
22271
22272
22273
22274
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 22267

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @inactive_reason = args[:inactive_reason] if args.key?(:inactive_reason)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @study_spec = args[:study_spec] if args.key?(:study_spec)
end