Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Study.
A message representing a Study.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Time at which the study was created.
#display_name
def display_name() -> ::String
Returns
- (::String) — Required. Describes the Study, default value is empty string.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Required. Describes the Study, default value is empty string.
Returns
- (::String) — Required. Describes the Study, default value is empty string.
#inactive_reason
def inactive_reason() -> ::String
Returns
- (::String) — Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The name of a study. The study's globally unique identifier.
Format:
projects/{project}/locations/{location}/studies/{study}
#state
def state() -> ::Google::Cloud::AIPlatform::V1::Study::State
Returns
- (::Google::Cloud::AIPlatform::V1::Study::State) — Output only. The detailed state of a Study.
#study_spec
def study_spec() -> ::Google::Cloud::AIPlatform::V1::StudySpec
Returns
- (::Google::Cloud::AIPlatform::V1::StudySpec) — Required. Configuration of the Study.
#study_spec=
def study_spec=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec
Parameter
- value (::Google::Cloud::AIPlatform::V1::StudySpec) — Required. Configuration of the Study.
Returns
- (::Google::Cloud::AIPlatform::V1::StudySpec) — Required. Configuration of the Study.