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	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. (id: Status)
executionState	string	Output only. The execution state of the investigation.
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	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. (id: Status)
executionState	string	Output only. The execution state of the investigation.
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, pageToken, pageSize, orderBy	Lists Investigations in a given project and location.
create	insert	projectsId, locationsId	requestId, investigationId	Creates a new Investigation in a given project.
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,
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 pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new Investigation in a given project.

INSERT INTO google.geminicloudassist.investigations (
data__name,
data__observerStatuses,
data__revisionPredecessor,
data__annotations,
data__title,
data__observations,
data__labels,
projectsId,
locationsId,
requestId,
investigationId
)
SELECT 
'{{ name }}',
'{{ observerStatuses }}',
'{{ revisionPredecessor }}',
'{{ annotations }}',
'{{ title }}',
'{{ observations }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ requestId }}',
'{{ investigationId }}'
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: 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 the investigation, of the form: projects/{project_number}/locations/{location_id}/investigations/{investigation_id}
        
    - name: observerStatuses
      value: object
      description: >
        Optional. Statuses of observers which have been invoked in order to run the investigation.
        
    - name: revisionPredecessor
      value: string
      description: >
        Optional. The name of the revision that was this revision's predecessor.
        
    - name: annotations
      value: object
      description: >
        Optional. Additional annotations on the investigation.
        
    - name: title
      value: string
      description: >
        Optional. Human-readable display title for the investigation.
        
    - name: observations
      value: object
      description: >
        Optional. Observations about the project state that comprise the contents of the investigation.
        
    - name: labels
      value: object
      description: >
        Optional. User-defined labels for the investigation.
        
    - name: requestId
      value: string
    - name: investigationId
      value: string

UPDATE examples

patch

Updates the parameters of a single Investigation.

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