// Code generated by tools/schemagen. DO NOT EDIT.
// Source: schemas/. Regenerate with `make generate`.

package contract

type FluidPressureFrequency struct {
	IndependentConsumers *int64 `json:"independent_consumers,omitempty" yaml:"independent_consumers,omitempty"`
	Observations         *int64 `json:"observations,omitempty" yaml:"observations,omitempty"`
}

// ArchitectureBlueprint.md section 9. Pressure may remain unresolved on purpose.
type FluidPressureStatus string

const (
	FluidPressureStatusOPEN       FluidPressureStatus = "OPEN"
	FluidPressureStatusANALYZING  FluidPressureStatus = "ANALYZING"
	FluidPressureStatusEXPLAINED  FluidPressureStatus = "EXPLAINED"
	FluidPressureStatusADDRESSED  FluidPressureStatus = "ADDRESSED"
	FluidPressureStatusDISMISSED  FluidPressureStatus = "DISMISSED"
	FluidPressureStatusOUTOFSCOPE FluidPressureStatus = "OUT_OF_SCOPE"
)

// Valid reports whether v is a defined FluidPressureStatus.
func (v FluidPressureStatus) Valid() bool {
	switch v {
	case FluidPressureStatusOPEN, FluidPressureStatusANALYZING, FluidPressureStatusEXPLAINED, FluidPressureStatusADDRESSED, FluidPressureStatusDISMISSED, FluidPressureStatusOUTOFSCOPE:
		return true
	}
	return false
}

type FluidPressure struct {
	AffectedCohorts []CohortID    `json:"affected_cohorts,omitempty" yaml:"affected_cohorts,omitempty"`
	Class           PressureClass `json:"class" yaml:"class"`
	Confidence      *UnitInterval `json:"confidence,omitempty" yaml:"confidence,omitempty"`

	// A pressure record without evidence references is not auditable and must be
	// rejected.
	EvidenceRefs     []EvidenceRef           `json:"evidence_refs" yaml:"evidence_refs"`
	FirstSeen        Timestamp               `json:"first_seen" yaml:"first_seen"`
	Frequency        *FluidPressureFrequency `json:"frequency,omitempty" yaml:"frequency,omitempty"`
	ID               PressureID              `json:"id" yaml:"id"`
	InterfaceID      InterfaceID             `json:"interface_id" yaml:"interface_id"`
	LastSeen         Timestamp               `json:"last_seen" yaml:"last_seen"`
	LinkedHypotheses []HypothesisID          `json:"linked_hypotheses,omitempty" yaml:"linked_hypotheses,omitempty"`
	SchemaVersion    SchemaVersion           `json:"schema_version" yaml:"schema_version"`
	Severity         *UnitInterval           `json:"severity,omitempty" yaml:"severity,omitempty"`

	// ArchitectureBlueprint.md section 9. Pressure may remain unresolved on purpose.
	Status  FluidPressureStatus `json:"status" yaml:"status"`
	Summary string              `json:"summary" yaml:"summary"`
}

// Evidence that the interface differs materially from consumer needs. Pressure is
// evidence, not truth (FluidAPIStandards.md section 13).
type PressureDocument struct {
	FluidPressure FluidPressure `json:"fluid_pressure" yaml:"fluid_pressure"`
}