Skip to main content

studies

Overview

Namestudies
TypeResource
Idgoogle.aiplatform.studies

Fields

NameDatatypeDescription
namestringOutput only. The name of a study. The study's globally unique identifier. Format: projects/{project}/locations/{location}/studies/{study}
createTimestringOutput only. Time at which the study was created.
displayNamestringRequired. Describes the Study, default value is empty string.
inactiveReasonstringOutput only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
statestringOutput only. The detailed state of a Study.
studySpecobjectRepresents specification of a Study.

Methods

NameAccessible byRequired ParamsDescription
getSELECTlocationsId, projectsId, studiesIdGets a Study by name.
listSELECTlocationsId, projectsIdLists all the studies in a region for an associated project.
createINSERTlocationsId, projectsIdCreates a Study. A resource name will be generated after creation of the Study.
deleteDELETElocationsId, projectsId, studiesIdDeletes a Study.
_listEXEClocationsId, projectsIdLists all the studies in a region for an associated project.
lookupEXEClocationsId, projectsIdLooks a study up using the user-defined display_name field instead of the fully qualified resource name.