insights_configs

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

Overview

Name	insights_configs
Type	Resource
Id	google.developerconnect.insights_configs

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the InsightsConfig. Format: projects/{project}/locations/{location}/insightsConfigs/{insightsConfig}
annotations	object	Optional. User specified annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations.
appHubApplication	string	Optional. The name of the App Hub Application. Format: projects/{project}/locations/{location}/applications/{application}
artifactConfigs	array	Optional. The artifact configurations of the artifacts that are deployed.
createTime	string (google-datetime)	Output only. [Output only] Create timestamp
errors	array	Output only. Any errors that occurred while setting up the InsightsConfig. Each error will be in the format: field_name: error_message, e.g. GetAppHubApplication: Permission denied while getting App Hub application. Please grant permissions to the P4SA.
labels	object	Optional. Set of labels associated with an InsightsConfig.
reconciling	boolean	Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of InsightsConfig does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
runtimeConfigs	array	Output only. The runtime configurations where the application is deployed.
state	string	Optional. Output only. The state of the InsightsConfig.
updateTime	string (google-datetime)	Output only. [Output only] Update timestamp

list

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the InsightsConfig. Format: projects/{project}/locations/{location}/insightsConfigs/{insightsConfig}
annotations	object	Optional. User specified annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations.
appHubApplication	string	Optional. The name of the App Hub Application. Format: projects/{project}/locations/{location}/applications/{application}
artifactConfigs	array	Optional. The artifact configurations of the artifacts that are deployed.
createTime	string (google-datetime)	Output only. [Output only] Create timestamp
errors	array	Output only. Any errors that occurred while setting up the InsightsConfig. Each error will be in the format: field_name: error_message, e.g. GetAppHubApplication: Permission denied while getting App Hub application. Please grant permissions to the P4SA.
labels	object	Optional. Set of labels associated with an InsightsConfig.
reconciling	boolean	Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of InsightsConfig does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
runtimeConfigs	array	Output only. The runtime configurations where the application is deployed.
state	string	Optional. Output only. The state of the InsightsConfig.
updateTime	string (google-datetime)	Output only. [Output only] Update timestamp

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, insightsConfigsId		Gets details of a single Insight.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists InsightsConfigs in a given project and location.
create	insert	projectsId, locationsId	insightsConfigId, validateOnly	Creates a new InsightsConfig in a given project and location.
patch	update	projectsId, locationsId, insightsConfigsId	requestId, allowMissing, validateOnly	Updates the parameters of a single InsightsConfig.
delete	delete	projectsId, locationsId, insightsConfigsId	requestId, validateOnly, etag	Delete a single Insight.

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
insightsConfigsId	string
locationsId	string
projectsId	string
allowMissing	boolean
etag	string
filter	string
insightsConfigId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
validateOnly	boolean

SELECT examples

get

Gets details of a single Insight.

SELECT
name,
annotations,
appHubApplication,
artifactConfigs,
createTime,
errors,
labels,
reconciling,
runtimeConfigs,
state,
updateTime
FROM google.developerconnect.insights_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND insightsConfigsId = '{{ insightsConfigsId }}' -- required;

list

Lists InsightsConfigs in a given project and location.

SELECT
name,
annotations,
appHubApplication,
artifactConfigs,
createTime,
errors,
labels,
reconciling,
runtimeConfigs,
state,
updateTime
FROM google.developerconnect.insights_configs
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 InsightsConfig in a given project and location.

INSERT INTO google.developerconnect.insights_configs (
data__appHubApplication,
data__name,
data__artifactConfigs,
data__state,
data__annotations,
data__labels,
projectsId,
locationsId,
insightsConfigId,
validateOnly
)
SELECT 
'{{ appHubApplication }}',
'{{ name }}',
'{{ artifactConfigs }}',
'{{ state }}',
'{{ annotations }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ insightsConfigId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: insights_configs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the insights_configs resource.
    - name: locationsId
      value: string
      description: Required parameter for the insights_configs resource.
    - name: appHubApplication
      value: string
      description: >
        Optional. The name of the App Hub Application. Format: projects/{project}/locations/{location}/applications/{application}
        
    - name: name
      value: string
      description: >
        Identifier. The name of the InsightsConfig. Format: projects/{project}/locations/{location}/insightsConfigs/{insightsConfig}
        
    - name: artifactConfigs
      value: array
      description: >
        Optional. The artifact configurations of the artifacts that are deployed.
        
    - name: state
      value: string
      description: >
        Optional. Output only. The state of the InsightsConfig.
        
      valid_values: ['STATE_UNSPECIFIED', 'PENDING', 'COMPLETE', 'ERROR']
    - name: annotations
      value: object
      description: >
        Optional. User specified annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations.
        
    - name: labels
      value: object
      description: >
        Optional. Set of labels associated with an InsightsConfig.
        
    - name: insightsConfigId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Updates the parameters of a single InsightsConfig.

UPDATE google.developerconnect.insights_configs
SET 
data__appHubApplication = '{{ appHubApplication }}',
data__name = '{{ name }}',
data__artifactConfigs = '{{ artifactConfigs }}',
data__state = '{{ state }}',
data__annotations = '{{ annotations }}',
data__labels = '{{ labels }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND insightsConfigsId = '{{ insightsConfigsId }}' --required
AND requestId = '{{ requestId}}'
AND allowMissing = {{ allowMissing}}
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Delete a single Insight.

DELETE FROM google.developerconnect.insights_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND insightsConfigsId = '{{ insightsConfigsId }}' --required
AND requestId = '{{ requestId }}'
AND validateOnly = '{{ validateOnly }}'
AND etag = '{{ etag }}';