GoogleMonitoringAlertPolicy class final

Factory wrapper for google_monitoring_alert_policy.

A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state.

Required identity beyond localName:

displayName: human-readable label shown in dashboards / notifications (<= 512 Unicode characters).
combiner: how multiple conditions combine into an incident. Use AlertCombiner.and / AlertCombiner.or / AlertCombiner.andWithMatchingResource.
conditions: non-empty list. Each MonitoringAlertPolicyAlertCondition carries a displayName plus EXACTLY one of the 6 condition-type sub-blocks (MonitoringAlertPolicyAlertCondition.conditionThreshold, conditionAbsent, conditionMatchedLog, conditionMonitoringQueryLanguage, conditionPrometheusQueryLanguage, conditionSql).

Modeling choice for conditions: each entry is a single MonitoringAlertPolicyAlertCondition helper with one required displayName plus 6 mutually-exclusive nullable sub-fields. Terraform enforces the exactly_one_of contract at apply time, so we keep the Dart shape flat (and the count of generated classes manageable) instead of introducing a 6-variant sealed type.

Example (threshold on Compute Engine instance uptime):

final policy = GoogleMonitoringAlertPolicy(
  localName: 'compute_uptime',
  displayName: TfArg.literal('Compute instance uptime SLO'),
  combiner: TfArg.literal(AlertCombiner.or),
  conditions: const [
    MonitoringAlertPolicyAlertCondition(
      displayName: TfArgLiteral('uptime < 95% over 5 min'),
      conditionThreshold: MonitoringAlertPolicyConditionThreshold(
        filter: TfArgLiteral(
          'metric.type="compute.googleapis.com/instance/uptime" '
          'resource.type="gce_instance"',
        ),
        comparison: TfArgLiteral(Comparison.lessThan),
        thresholdValue: TfArgLiteral(0.95),
        duration: TfArgLiteral('300s'),
      ),
    ),
  ],
  notificationChannels: TfArg.literal(const <String>[]),
  alertStrategy: const MonitoringAlertPolicyAlertStrategy(autoClose: TfArgLiteral('1800s')),
  severity: TfArg.literal(AlertSeverity.warning),
);

Constructors

GoogleMonitoringAlertPolicy({required String localName, required TfArg<String> displayName, required TfArg<AlertCombiner> combiner, required List<MonitoringAlertPolicyAlertCondition> conditions, TfArg<List<String>>? notificationChannels, MonitoringAlertPolicyAlertStrategy? alertStrategy, MonitoringAlertPolicyDocumentation? documentation, TfArg<bool>? enabled, TfArg<AlertSeverity>? severity, TfArg<Map<String, String>>? userLabels, TfArg<String>? project, LifecycleOptions? lifecycle, List<DependencyTarget>? dependsOn})

Properties

argMap → Map<String, TfArg?>: Argument-name → TfArg map. Keys are snake_case (Terraform JSON name). Synth emits these keys directly; the factory is responsible for the camelCase → snake_case translation at construction time.
finalinherited
creationRecord → TfRef<List<Map<String, Object?>>>: Reference to creation_record attribute.
no setter
dependsOn → List<DependencyTarget>?: Optional depends_on = [...]. Each entry is a DependencyTarget — either a wholesale resource (rendered as bare address) or an explicit TfRef (rendered via bareAddress).
finalinherited
hashCode → int: The hash code for this object.
no setterinherited
id → TfRef<String>: Reference to id attribute.
no setter
kind → ResourceKind: Always ResourceKind.resource. Overridden by Data.
no setterinherited
lifecycle → LifecycleOptions?: Optional lifecycle { ... } block.
finalinherited
localName → String: User-supplied local name within a Stack.
finalinherited
nameRef → TfRef<String>: Reference to name attribute.
no setter
provider → String?: Optional Terraform provider meta-argument (e.g. 'google-beta').
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sensitiveFields → Set<String>: Field names that are @Sensitive per the IR-derived per-resource constant. Curated factories override with a baked-in static const Set<String> (file-private in v0.5+).
no setter
supportsDeletionProtection → bool: Capability flag: true when this resource's underlying Terraform schema has a deletion_protection boolean attribute that the synth-time devMode flow can flip to false. Defaults to false; the codegen emitter overrides this to true for wrappers whose schema includes the attribute.
no setterinherited
terraformType → String: Terraform resource type, e.g. google_pubsub_topic.
finalinherited
tfAddress → String: no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

tfType → const String