Google Cloud Ai Platform V1 Client - Class Study (1.30.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
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
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
Type
Description
string

setName

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

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

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

Returns
Type
Description
string

setDisplayName

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getStudySpec

Required. Configuration of the Study.

Returns
Type
Description
StudySpec |null

hasStudySpec

clearStudySpec

setStudySpec

Required. Configuration of the Study.

Parameter
Name
Description
var
Returns
Type
Description
$this

getState

Output only. The detailed state of a Study.

Returns
Type
Description
int

setState

Output only. The detailed state of a Study.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getCreateTime

Output only. Time at which the study was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time at which the study was created.

Parameter
Name
Description
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: