caffeine_lang/linker/ir

Types

Artifact-specific data stored as a dict from artifact type to fields.

pub type ArtifactData {
  ArtifactData(
    fields: dict.Dict(artifacts.ArtifactType, ArtifactFields),
  )
}

Constructors

Wrapper for artifact-specific field data.

pub type ArtifactFields {
  SloArtifactFields(SloFields)
  DependencyArtifactFields(DependencyFields)
}

Constructors

Structured dependency artifact fields extracted from raw values.

pub type DependencyFields {
  DependencyFields(
    relations: dict.Dict(
      artifacts.DependencyRelationType,
      List(String),
    ),
    tags: List(#(String, String)),
  )
}

Constructors

Internal representation of a parsed expectation with metadata and values.

pub type IntermediateRepresentation {
  IntermediateRepresentation(
    metadata: IntermediateRepresentationMetaData,
    unique_identifier: String,
    artifact_refs: List(artifacts.ArtifactType),
    values: List(helpers.ValueTuple),
    artifact_data: ArtifactData,
    vendor: option.Option(vendor.Vendor),
  )
}

Constructors

Metadata associated with an intermediate representation including organization and service identifiers.

pub type IntermediateRepresentationMetaData {
  IntermediateRepresentationMetaData(
    friendly_label: String,
    org_name: String,
    service_name: String,
    blueprint_name: String,
    team_name: String,
    misc: dict.Dict(String, List(String)),
  )
}

Constructors

  • IntermediateRepresentationMetaData(
      friendly_label: String,
      org_name: String,
      service_name: String,
      blueprint_name: String,
      team_name: String,
      misc: dict.Dict(String, List(String)),
    )

    Arguments

    misc

    Metadata specific to any given expectation.

Structured SLO artifact fields extracted from raw values.

pub type SloFields {
  SloFields(
    threshold: Float,
    indicators: dict.Dict(String, String),
    window_in_days: Int,
    evaluation: option.Option(String),
    tags: List(#(String, String)),
    runbook: option.Option(String),
  )
}

Constructors

  • SloFields(
      threshold: Float,
      indicators: dict.Dict(String, String),
      window_in_days: Int,
      evaluation: option.Option(String),
      tags: List(#(String, String)),
      runbook: option.Option(String),
    )
Search Document