Resource: Study
A message representing a Study.
JSON representation |
---|
{ "name": string, "displayName": string, "studySpec": { object ( |
Fields | |
---|---|
name |
Output only. The name of a study. The study's globally unique identifier. Format: |
displayName |
Required. Describes the Study, default value is empty string. |
studySpec |
Required. Configuration of the Study. |
state |
Output only. The detailed state of a Study. |
createTime |
Output only. time at which the study was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
inactiveReason |
Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. |
State
Describes the Study state.
Enums | |
---|---|
STATE_UNSPECIFIED |
The study state is unspecified. |
ACTIVE |
The study is active. |
INACTIVE |
The study is stopped due to an internal error. |
COMPLETED |
The study is done when the service exhausts the parameter search space or maxTrialCount is reached. |
Methods |
|
---|---|
|
Creates a Study. |
|
Deletes a Study. |
|
Gets a Study by name. |
|
Lists all the studies in a region for an associated project. |
|
Looks a study up using the user-defined display_name field instead of the fully qualified resource name. |