Google Cloud Ai Platform V1 Client - Class Study (0.25.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Study.

A message representing a Study.

Generated from protobuf message google.cloud.aiplatform.v1.Study

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The name of a study. The study's globally unique identifier. Format: projects/{project}/locations/{location}/studies/{study}

↳ display_name string

Required. Describes the Study, default value is empty string.

↳ study_spec Google\Cloud\AIPlatform\V1\StudySpec

Required. Configuration of the Study.

↳ state int

Output only. The detailed state of a Study.

↳ create_time Google\Protobuf\Timestamp

Output only. Time at which the study was created.

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

getName

Output only. The name of a study. The study's globally unique identifier.

Format: projects/{project}/locations/{location}/studies/{study}

Returns
TypeDescription
string

setName

Output only. The name of a study. The study's globally unique identifier.

Format: projects/{project}/locations/{location}/studies/{study}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Required. Describes the Study, default value is empty string.

Returns
TypeDescription
string

setDisplayName

Required. Describes the Study, default value is empty string.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStudySpec

Required. Configuration of the Study.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\StudySpec|null

hasStudySpec

clearStudySpec

setStudySpec

Required. Configuration of the Study.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\StudySpec
Returns
TypeDescription
$this

getState

Output only. The detailed state of a Study.

Returns
TypeDescription
int

setState

Output only. The detailed state of a Study.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCreateTime

Output only. Time at which the study was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time at which the study was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getInactiveReason

Output only. A human readable reason why the Study is inactive.

This should be empty if a study is ACTIVE or COMPLETED.

Returns
TypeDescription
string

setInactiveReason

Output only. A human readable reason why the Study is inactive.

This should be empty if a study is ACTIVE or COMPLETED.

Parameter
NameDescription
var string
Returns
TypeDescription
$this