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

Name	Datatype	Description
name	string	Identifier. Name of the investigation, of the form: projects/{project_number}/locations/{location_id}/investigations/{investigation_id}
annotations	object	Optional. Additional annotations on the investigation. (id: InvestigationAnnotations)
createTime	string (google-datetime)	Output only. The time when the investigation was created.
error	object	Output only. The error if the investigation run failed. This field will only be set if execution_state is INVESTIGATION_EXECUTION_STATE_FAILED. (id: Status)
executionState	string	Output only. The execution state of the investigation. (INVESTIGATION_EXECUTION_STATE_UNSPECIFIED, INVESTIGATION_EXECUTION_STATE_RUNNING, INVESTIGATION_EXECUTION_STATE_MODIFIED, INVESTIGATION_EXECUTION_STATE_FAILED, INVESTIGATION_EXECUTION_STATE_CANCELLED, INVESTIGATION_EXECUTION_STATE_COMPLETED)
labels	object	Optional. User-defined labels for the investigation.
observations	object	Optional. Observations about the project state that comprise the contents of the investigation.
observerStatuses	object	Optional. Statuses of observers which have been invoked in order to run the investigation.
operation	string	Output only. The resource name of the Run operation most recently performed on the investigation, of the form: projects/{project_number}/locations/{location_id}/operations/{operation_id}
revision	string	Output only. Resource name of the investigation's current revision, of the form: projects/{project_number}/locations/{location_id}/investigations/{investigation_id}/revisions/{revision_id}
revisionIndex	integer (int32)	Output only. Index of the current revision of the investigation.
revisionPredecessor	string	Optional. The name of the revision that was this revision's predecessor.
title	string	Optional. Human-readable display title for the investigation.
updateTime	string (google-datetime)	Output only. The time when the investigation was last updated.

list

Name	Datatype	Description
name	string	Identifier. Name of the investigation, of the form: projects/{project_number}/locations/{location_id}/investigations/{investigation_id}
annotations	object	Optional. Additional annotations on the investigation. (id: InvestigationAnnotations)
createTime	string (google-datetime)	Output only. The time when the investigation was created.
error	object	Output only. The error if the investigation run failed. This field will only be set if execution_state is INVESTIGATION_EXECUTION_STATE_FAILED. (id: Status)
executionState	string	Output only. The execution state of the investigation. (INVESTIGATION_EXECUTION_STATE_UNSPECIFIED, INVESTIGATION_EXECUTION_STATE_RUNNING, INVESTIGATION_EXECUTION_STATE_MODIFIED, INVESTIGATION_EXECUTION_STATE_FAILED, INVESTIGATION_EXECUTION_STATE_CANCELLED, INVESTIGATION_EXECUTION_STATE_COMPLETED)
labels	object	Optional. User-defined labels for the investigation.
observations	object	Optional. Observations about the project state that comprise the contents of the investigation.
observerStatuses	object	Optional. Statuses of observers which have been invoked in order to run the investigation.
operation	string	Output only. The resource name of the Run operation most recently performed on the investigation, of the form: projects/{project_number}/locations/{location_id}/operations/{operation_id}
revision	string	Output only. Resource name of the investigation's current revision, of the form: projects/{project_number}/locations/{location_id}/investigations/{investigation_id}/revisions/{revision_id}
revisionIndex	integer (int32)	Output only. Index of the current revision of the investigation.
revisionPredecessor	string	Optional. The name of the revision that was this revision's predecessor.
title	string	Optional. Human-readable display title for the investigation.
updateTime	string (google-datetime)	Output only. The time when the investigation was last updated.

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	filter, orderBy, pageSize, pageToken	Lists Investigations in a given project and location.
create	insert	projectsId, locationsId	investigationId, requestId, validateOnly	Deprecated: Investigations should only be created by the agent. Creates a new Investigation in a given project.
patch	update	projectsId, locationsId, investigationsId	requestId, updateMask	Deprecated: Investigations should only be modified by the agent. 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)
validateOnly	boolean

SELECT examples

get

Gets details of a single Investigation.

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

INSERT examples

create

Deprecated: Investigations should only be created by the agent. Creates a new Investigation in a given project.

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

Manifest

# Description fields are for documentation purposes
- name: investigations
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the investigations resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the investigations resource.
  - name: annotations
    description: |
      Optional. Additional annotations on the investigation.
    value:
      extrasMap: "{{ extrasMap }}"
      pagePath: "{{ pagePath }}"
      revisionLastRunInterval:
        endTime: "{{ endTime }}"
        startTime: "{{ startTime }}"
      supportCase: "{{ supportCase }}"
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. User-defined labels for the investigation.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Name of the investigation, of the form: projects/{project_number}/locations/{location_id}/investigations/{investigation_id}
  - name: observations
    value: "{{ observations }}"
    description: |
      Optional. Observations about the project state that comprise the contents of the investigation.
  - name: observerStatuses
    value: "{{ observerStatuses }}"
    description: |
      Optional. Statuses of observers which have been invoked in order to run the investigation.
  - name: revisionPredecessor
    value: "{{ revisionPredecessor }}"
    description: |
      Optional. The name of the revision that was this revision's predecessor.
  - name: title
    value: "{{ title }}"
    description: |
      Optional. Human-readable display title for the investigation.
  - name: investigationId
    value: "{{ investigationId }}"
  - name: requestId
    value: "{{ requestId }}"
  - name: validateOnly
    value: {{ validateOnly }}

UPDATE examples

patch

Deprecated: Investigations should only be modified by the agent. Updates the parameters of a single Investigation.

UPDATE google.geminicloudassist.investigations
SET 
data__annotations = '{{ annotations }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}',
data__observations = '{{ observations }}',
data__observerStatuses = '{{ observerStatuses }}',
data__revisionPredecessor = '{{ revisionPredecessor }}',
data__title = '{{ title }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND investigationsId = '{{ investigationsId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
annotations,
createTime,
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 }}'
;