Google Cloud Ai Platform V1 Client - Class Study (0.10.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

Methods

__construct

Constructor.

Parameters
Name	Description
`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}

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`string`

setName

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

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

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

Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`string`

setDisplayName

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

Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStudySpec

Required. Configuration of the Study.

Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\StudySpec\|null`

hasStudySpec

clearStudySpec

setStudySpec

Required. Configuration of the Study.

Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec study_spec = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\StudySpec`

Returns
Type	Description
`$this`

getState

Output only. The detailed state of a Study.

Generated from protobuf field .google.cloud.aiplatform.v1.Study.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

setState

Output only. The detailed state of a Study.

Generated from protobuf field .google.cloud.aiplatform.v1.Study.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getCreateTime

Output only. Time at which the study was created.

Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime