REST Resource: organizations.locations.insightTypes.insights

Resource: Insight

An insight along with the information used to derive the insight. The insight may have associated recomendations as well.

JSON representation
{
  "name": string,
  "description": string,
  "targetResources": [
    string
  ],
  "insightSubtype": string,
  "content": {
    object
  },
  "lastRefreshTime": string,
  "observationPeriod": string,
  "stateInfo": {
    object (InsightStateInfo)
  },
  "category": enum (Category),
  "etag": string,
  "associatedRecommendations": [
    {
      object (RecommendationReference)
    }
  ]
}
Fields
name

string

Name of the insight.

description

string

Free-form human readable summary in English. The maximum length is 500 characters.

targetResources[]

string

Fully qualified resource names that this insight is targeting.

insightSubtype

string

Insight subtype. Insight content schema will be stable for a given subtype.

content

object (Struct format)

A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000"

lastRefreshTime

string (Timestamp format)

Timestamp of the latest data used to generate the insight.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

observationPeriod

string (Duration format)

Observation period that led to the insight. The source data used to generate the insight ends at lastRefreshTime and begins at (lastRefreshTime - observationPeriod).

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

stateInfo

object (InsightStateInfo)

Information state and metadata.

category

enum (Category)

Category being targeted by the insight.

etag

string

Fingerprint of the Insight. Provides optimistic locking when updating states.

associatedRecommendations[]

object (RecommendationReference)

Recommendations derived from this insight.

Methods

get

Gets the requested insight.

list

Lists insights for a Cloud project.

markAccepted

Marks the Insight State as Accepted.