investigations

Creates, updates, deletes, gets or lists an investigations resource.

Overview

Name	investigations
Type	Resource
Id	google.geminicloudassist.investigations

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. name of resource
annotations	object	Optional. Annotations on the investigation. Unlike labels, these may carry semantic meaning in running the investigation, and will not be read by other systems such as billing. (id: InvestigationAnnotations)
clarificationsNeeded	object	Optional. Questions that the system needs to ask the user. The results will be passed back by the UI as new Observations. The ID for those observations will be the key of the entry in the clarifications_needed map.
createTime	string (google-datetime)	Output only. [Output only] Create time stamp
dataVersion	integer (int32)	Optional. The data model version of this Investigation. Should be either 1 or 2. Treat 0 as 1. If 1, use V1 Investigation data model. If 2, use the Investigation Observation data model.
error	object	Output only. [Output only] If the investigation execution state is FAILED, this field will contain the error message. (id: Status)
executionState	string	Output only. [Output only] The execution state of this investigation.
labels	object	Optional. Labels as key value pairs
observations	object	Optional. A map from observation ID to the observation. This is a map so that we can cleanly overwrite old observations with the version from the latest revision. See Observation for guidance on choosing IDs.
observerStatuses	object	Optional. Plural version of above. Code will transition to this over time.
operation	string	Output only. The Run operation most recently performed on the investigation.
revision	string	Output only. [Output only] Current revision of the investigation
revisionIndex	integer (int32)	Output only. [Output only] Index of the current revision of the investigation. 1-based.
revisionPredecessor	string	Optional. The name of the revision that was this revision's predecessor. The UI, for example, will set this to the existing revision when when a new revision is created due to an edit.
title	string	Required. Human-readable display title for the investigation.
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp

list

Successful response

Name	Datatype	Description
name	string	Identifier. name of resource
annotations	object	Optional. Annotations on the investigation. Unlike labels, these may carry semantic meaning in running the investigation, and will not be read by other systems such as billing. (id: InvestigationAnnotations)
clarificationsNeeded	object	Optional. Questions that the system needs to ask the user. The results will be passed back by the UI as new Observations. The ID for those observations will be the key of the entry in the clarifications_needed map.
createTime	string (google-datetime)	Output only. [Output only] Create time stamp
dataVersion	integer (int32)	Optional. The data model version of this Investigation. Should be either 1 or 2. Treat 0 as 1. If 1, use V1 Investigation data model. If 2, use the Investigation Observation data model.
error	object	Output only. [Output only] If the investigation execution state is FAILED, this field will contain the error message. (id: Status)
executionState	string	Output only. [Output only] The execution state of this investigation.
labels	object	Optional. Labels as key value pairs
observations	object	Optional. A map from observation ID to the observation. This is a map so that we can cleanly overwrite old observations with the version from the latest revision. See Observation for guidance on choosing IDs.
observerStatuses	object	Optional. Plural version of above. Code will transition to this over time.
operation	string	Output only. The Run operation most recently performed on the investigation.
revision	string	Output only. [Output only] Current revision of the investigation
revisionIndex	integer (int32)	Output only. [Output only] Index of the current revision of the investigation. 1-based.
revisionPredecessor	string	Optional. The name of the revision that was this revision's predecessor. The UI, for example, will set this to the existing revision when when a new revision is created due to an edit.
title	string	Required. Human-readable display title for the investigation.
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, investigationsId		Gets details of a single Investigation.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists Investigations in a given project and location.
create	insert	projectsId, locationsId	investigationId, requestId	Creates a new Investigation in a given project and location.
patch	update	projectsId, locationsId, investigationsId	updateMask, requestId	Updates the parameters of a single Investigation.
delete	delete	projectsId, locationsId, investigationsId	requestId	Deletes a single Investigation.

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
investigationsId	string
locationsId	string
projectsId	string
filter	string
investigationId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Investigation.

SELECT
name,
annotations,
clarificationsNeeded,
createTime,
dataVersion,
error,
executionState,
labels,
observations,
observerStatuses,
operation,
revision,
revisionIndex,
revisionPredecessor,
title,
updateTime
FROM google.geminicloudassist.investigations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND investigationsId = '{{ investigationsId }}' -- required;

list

Lists Investigations in a given project and location.

SELECT
name,
annotations,
clarificationsNeeded,
createTime,
dataVersion,
error,
executionState,
labels,
observations,
observerStatuses,
operation,
revision,
revisionIndex,
revisionPredecessor,
title,
updateTime
FROM google.geminicloudassist.investigations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new Investigation in a given project and location.

INSERT INTO google.geminicloudassist.investigations (
data__name,
data__labels,
data__revisionPredecessor,
data__annotations,
data__title,
data__observations,
data__observerStatuses,
data__dataVersion,
data__clarificationsNeeded,
projectsId,
locationsId,
investigationId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ revisionPredecessor }}',
'{{ annotations }}',
'{{ title }}',
'{{ observations }}',
'{{ observerStatuses }}',
{{ dataVersion }},
'{{ clarificationsNeeded }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ investigationId }}',
'{{ requestId }}'
RETURNING
name,
annotations,
clarificationsNeeded,
createTime,
dataVersion,
error,
executionState,
labels,
observations,
observerStatuses,
operation,
revision,
revisionIndex,
revisionPredecessor,
title,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: investigations
  props:
    - name: projectsId
      value: string
      description: Required parameter for the investigations resource.
    - name: locationsId
      value: string
      description: Required parameter for the investigations resource.
    - name: name
      value: string
      description: >
        Identifier. name of resource
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs
        
    - name: revisionPredecessor
      value: string
      description: >
        Optional. The name of the revision that was this revision's predecessor. The UI, for example, will set this to the existing revision when when a new revision is created due to an edit.
        
    - name: annotations
      value: object
      description: >
        Optional. Annotations on the investigation. Unlike labels, these may carry semantic meaning in running the investigation, and will not be read by other systems such as billing.
        
    - name: title
      value: string
      description: >
        Required. Human-readable display title for the investigation.
        
    - name: observations
      value: object
      description: >
        Optional. A map from observation ID to the observation. This is a map so that we can cleanly overwrite old observations with the version from the latest revision. See Observation for guidance on choosing IDs.
        
    - name: observerStatuses
      value: object
      description: >
        Optional. Plural version of above. Code will transition to this over time.
        
    - name: dataVersion
      value: integer
      description: >
        Optional. The data model version of this Investigation. Should be either 1 or 2. Treat 0 as 1. If 1, use V1 Investigation data model. If 2, use the Investigation Observation data model.
        
    - name: clarificationsNeeded
      value: object
      description: >
        Optional. Questions that the system needs to ask the user. The results will be passed back by the UI as new Observations. The ID for those observations will be the key of the entry in the clarifications_needed map.
        
    - name: investigationId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the parameters of a single Investigation.

UPDATE google.geminicloudassist.investigations
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__revisionPredecessor = '{{ revisionPredecessor }}',
data__annotations = '{{ annotations }}',
data__title = '{{ title }}',
data__observations = '{{ observations }}',
data__observerStatuses = '{{ observerStatuses }}',
data__dataVersion = {{ dataVersion }},
data__clarificationsNeeded = '{{ clarificationsNeeded }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND investigationsId = '{{ investigationsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
annotations,
clarificationsNeeded,
createTime,
dataVersion,
error,
executionState,
labels,
observations,
observerStatuses,
operation,
revision,
revisionIndex,
revisionPredecessor,
title,
updateTime;

DELETE examples

delete

Deletes a single Investigation.

DELETE FROM google.geminicloudassist.investigations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND investigationsId = '{{ investigationsId }}' --required
AND requestId = '{{ requestId }}';