studies

Creates, updates, deletes, gets or lists a studies resource.

Overview

Name	studies
Type	Resource
Id	google.ml.studies

Fields

The following fields are returned by SELECT queries:

projects_locations_studies_get

Successful response

Name	Datatype	Description
name	string	Output only. The name of a study.
createTime	string (google-datetime)	Output only. Time at which the study was created.
inactiveReason	string	Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
state	string	Output only. The detailed state of a study.
studyConfig	object	Required. Configuration of the study. (id: GoogleCloudMlV1__StudyConfig)

projects_locations_studies_list

Successful response

Name	Datatype	Description
studies	array	The studies associated with the project.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_studies_get	select	projectsId, locationsId, studiesId		Gets a study.
projects_locations_studies_list	select	projectsId, locationsId		Lists all the studies in a region for an associated project.
projects_locations_studies_create	insert	projectsId, locationsId	studyId	Creates a study.
projects_locations_studies_delete	delete	projectsId, locationsId, studiesId		Deletes a study.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
studiesId	string
studyId	string

SELECT examples

projects_locations_studies_get

Gets a study.

SELECT
name,
createTime,
inactiveReason,
state,
studyConfig
FROM google.ml.studies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND studiesId = '{{ studiesId }}' -- required;

projects_locations_studies_list

Lists all the studies in a region for an associated project.

SELECT
studies
FROM google.ml.studies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;

INSERT examples

projects_locations_studies_create

Creates a study.

INSERT INTO google.ml.studies (
data__studyConfig,
projectsId,
locationsId,
studyId
)
SELECT 
'{{ studyConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ studyId }}'
RETURNING
name,
createTime,
inactiveReason,
state,
studyConfig
;

Manifest

# Description fields are for documentation purposes
- name: studies
  props:
    - name: projectsId
      value: string
      description: Required parameter for the studies resource.
    - name: locationsId
      value: string
      description: Required parameter for the studies resource.
    - name: studyConfig
      value: object
      description: >
        Required. Configuration of the study.
        
    - name: studyId
      value: string

DELETE examples

projects_locations_studies_delete

Deletes a study.

DELETE FROM google.ml.studies
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND studiesId = '{{ studiesId }}' --required;