REST Resource: projects.locations.instances.enrichmentControls

Resource: EnrichmentControl

An EnrichmentControl resource represents a control to an enrichment. Enrichment is the process of populating UDM events with more useful information. An enrichment control can have multiple records. Each record has a time range and a description. When an enrichment control is created for the first time, a new EnrichmentControl resource is generated, along with an initial record whose time range begins at the creation time. For subsequent creation requests for the same control, the existing EnrichmentControl resource is returned, and a new record with a start time of the current creation time is added. Disabling an enrichment control involves updating the end time of the most recent record associated with that EnrichmentControl resource to the disabling time.

JSON representation 
{
  "name": string,
  "enrichmentControlOption": {
    object (EnrichmentControlOption)
  },
  "displayName": string,
  "description": string,
  "records": [
    {
      object (EnrichmentControlRecord)
    }
  ]
}
Fields
name

string

Identifier. The resource name of the EnrichmentControl. Format: projects/{project}/locations/{location}/instances/{instance}/enrichmentControls/{enrichmentControl}
enrichmentControlOption

object (EnrichmentControlOption)

Required. The options to control the enrichment.
displayName

string

Optional. A human-readable name for this enrichment control.
description

string

Optional. A human-readable description for this enrichment control.
records[]

object (EnrichmentControlRecord)

Output only. The records of the enrichment control.

EnrichmentControlOption

The options to control the enrichment.

JSON representation 
{
  "enrichmentType": enum (EnrichmentType),
  "targetLogType": string,
  "enrichmentSource": {
    object (EnrichmentSource)
  }
}
Fields
enrichmentType

enum (EnrichmentType)

Required. The type of enrichment to be controlled.
targetLogType

string

Required. LogType of the events to be enriched. Apply to all log types if ALL_TYPE. LogType resource format: projects/{project}/locations/{location}/instances/{instance}/logTypes/{logType}
enrichmentSource

object (EnrichmentSource)

Required. The enrichment source that an enrichment is from. An enrichment source can be either a log type or an external enrichment source that does not have a log type.

EnrichmentControlRecord

The activity record of an enrichment control.

JSON representation 
{
  "timeRange": {
    object (Interval)
  },
  "description": string
}
Fields
timeRange

object (Interval)

Output only. The time range of the events to apply the enrichment control. If the end time is not set, it means the control will apply to all events after the start time.
description

string

Output only. A human-readable description for this enrichment control record.

Methods

create

 Create an EnrichmentControl resource.

disable

 Disable an EnrichmentControl.

get

 Get an EnrichmentControl.

list

 List all EnrichmentControls.