REST Resource: projects.locations.insightsConfigs

Resource: InsightsConfig

The InsightsConfig resource is the core configuration object to capture events from your Software Development Lifecycle. It acts as the central hub for managing how Developer connect understands your application, its runtime environments, and the artifacts deployed within them.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "runtimeConfigs": [
    {
      object (RuntimeConfig)
    }
  ],
  "artifactConfigs": [
    {
      object (ArtifactConfig)
    }
  ],
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "reconciling": boolean,
  "errors": [
    {
      object (Status)
    }
  ],

  // Union field insights_config_context can be only one of the following:
  "appHubApplication": string
  // End of list of possible types for union field insights_config_context.
}
Fields
name

string

Identifier. The name of the InsightsConfig. Format: projects/{project}/locations/{location}/insightsConfigs/{insightsConfig}
createTime

string (Timestamp format)

Output only. Create timestamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Update timestamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
runtimeConfigs[]

object (RuntimeConfig)

Output only. The runtime configurations where the application is deployed.
artifactConfigs[]

object (ArtifactConfig)

Optional. The artifact configurations of the artifacts that are deployed.
state

enum (State)

Optional. Output only. The state of the InsightsConfig.
annotations

map (key: string, value: string)

Optional. User specified annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labels

map (key: string, value: string)

Optional. Set of labels associated with an InsightsConfig.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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.
errors[]

object (Status)

Output only. Any errors that occurred while setting up the InsightsConfig. Each error will be in the format: field_name: errorMessage, e.g. GetAppHubApplication: Permission denied while getting App Hub application. Please grant permissions to the P4SA.
Union field insights_config_context. The context of the InsightsConfig. insights_config_context can be only one of the following:
appHubApplication

string

Optional. The name of the App Hub Application. Format: projects/{project}/locations/{location}/applications/{application}

RuntimeConfig

RuntimeConfig represents the runtimes where the application is deployed.

JSON representation 
{
  "uri": string,
  "state": enum (State),

  // Union field runtime can be only one of the following:
  "gkeWorkload": {
    object (GKEWorkload)
  },
  "googleCloudRun": {
    object (GoogleCloudRun)
  }
  // End of list of possible types for union field runtime.

  // Union field derived_from can be only one of the following:
  "appHubWorkload": {
    object (AppHubWorkload)
  },
  "appHubService": {
    object (AppHubService)
  }
  // End of list of possible types for union field derived_from.
}
Fields
uri

string

Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name.
state

enum (State)

Output only. The state of the Runtime.
Union field runtime. The type of the runtime. runtime can be only one of the following:
gkeWorkload

object (GKEWorkload)

Output only. Google Kubernetes Engine runtime.
googleCloudRun

object (GoogleCloudRun)

Output only. Cloud Run runtime.
Union field derived_from. Where the runtime is derived from. derived_from can be only one of the following:
appHubWorkload

object (AppHubWorkload)

Output only. App Hub Workload.
appHubService

object (AppHubService)

Output only. App Hub Service.

GKEWorkload

GKEWorkload represents the Google Kubernetes Engine runtime.

JSON representation 
{
  "cluster": string,
  "deployment": string
}
Fields
cluster

string

Required. Immutable. The name of the GKE cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}.
deployment

string

Output only. The name of the GKE deployment. Format: projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}.

GoogleCloudRun

GoogleCloudRun represents the Cloud Run runtime.

JSON representation 
{
  "serviceUri": string
}
Fields
serviceUri

string

Required. Immutable. The name of the Cloud Run service. Format: projects/{project}/locations/{location}/services/{service}.

AppHubWorkload

AppHubWorkload represents the App Hub Workload.

JSON representation 
{
  "workload": string,
  "criticality": string,
  "environment": string
}
Fields
workload

string

Required. Output only. Immutable. The name of the App Hub Workload. Format: projects/{project}/locations/{location}/applications/{application}/workloads/{workload}.
criticality

string

Output only. The criticality of the App Hub Workload.
environment

string

Output only. The environment of the App Hub Workload.

AppHubService

AppHubService represents the App Hub Service.

JSON representation 
{
  "apphubService": string,
  "criticality": string,
  "environment": string
}
Fields
apphubService

string

Required. Output only. Immutable. The name of the App Hub Service. Format: projects/{project}/locations/{location}/applications/{application}/services/{service}.
criticality

string

Output only. The criticality of the App Hub Service.
environment

string

Output only. The environment of the App Hub Service.

State

The state of the runtime in the InsightsConfig. Whether the runtime is linked to the InsightsConfig.

Enums
STATE_UNSPECIFIED No state specified.
LINKED The runtime configuration has been linked to the InsightsConfig.
UNLINKED The runtime configuration has been unlinked to the InsightsConfig.

ArtifactConfig

The artifact config of the artifact that is deployed.

JSON representation 
{
  "uri": string,

  // Union field artifact_storage can be only one of the following:
  "googleArtifactRegistry": {
    object (GoogleArtifactRegistry)
  }
  // End of list of possible types for union field artifact_storage.

  // Union field artifact_metadata_storage can be only one of the following:
  "googleArtifactAnalysis": {
    object (GoogleArtifactAnalysis)
  }
  // End of list of possible types for union field artifact_metadata_storage.
}
Fields
uri

string

Required. Immutable. The URI of the artifact that is deployed. e.g. us-docker.pkg.dev/my-project/my-repo/image. The URI does not include the tag / digest because it captures a lineage of artifacts.
Union field artifact_storage. The storage location of the artifact. artifact_storage can be only one of the following:
googleArtifactRegistry

object (GoogleArtifactRegistry)

Optional. Set if the artifact is stored in Artifact registry.
Union field artifact_metadata_storage. The storage location of the artifact metadata. artifact_metadata_storage can be only one of the following:
googleArtifactAnalysis

object (GoogleArtifactAnalysis)

Optional. Set if the artifact metadata is stored in Artifact analysis.

GoogleArtifactRegistry

Google Artifact Registry configurations.

JSON representation 
{
  "projectId": string,
  "artifactRegistryPackage": string
}
Fields
projectId

string

Required. The host project of Artifact Registry.
artifactRegistryPackage

string

Required. Immutable. The name of the artifact registry package.

GoogleArtifactAnalysis

Google Artifact Analysis configurations.

JSON representation 
{
  "projectId": string
}
Fields
projectId

string

Required. The project id of the project where the provenance is stored.

State

The state of the InsightsConfig.

Enums
STATE_UNSPECIFIED No state specified.
PENDING The InsightsConfig is pending application discovery/runtime discovery.
COMPLETE The initial discovery process is complete.
ERROR The InsightsConfig is in an error state.

Methods

create

 Creates a new InsightsConfig in a given project and location.

delete

 Deletes a single Insight.

get

 Gets details of a single Insight.

list

 Lists InsightsConfigs in a given project and location.

patch

 Updates the parameters of a single InsightsConfig.