Files
sdk/docs/EventHealthReport.md

7.6 KiB

EventHealthReport

Properties

Name Type Description Notes
Datastore Pointer to bool Datastore reports whether the shared warehouse client has a live connection. It is load-bearing for the READ path: false is one of the two ways this answers 503. [optional]
Lenses Pointer to EventHealthLenses Lenses is per-lens table availability, probed only when connected — so it is absent from a degraded report, which has nothing to say about tables it could not reach. [optional]
Lost Pointer to EventLoss Lost is the count of facts the sink irrecoverably dropped since boot (warehouse.go). It is reported on the DEGRADED report too, and deliberately: a warehouse that is unreachable is exactly when facts start failing their deliveries, so suppressing the number here would hide it precisely when it moves. ANY NON-ZERO VALUE IS AN ALARM — it counts data the endpoint already answered 200 for. [optional]
Plane Pointer to EventHealthPlane Plane reports the event plane — the bus and the stream every accepted event is published to BEFORE any of it reaches the warehouse. It is load-bearing for the WRITE path: warehouse connectivity alone says nothing about whether a publish can land, so the probe reports the write path from the write path itself. [optional]
Reason Pointer to string Reason is the human-readable cause, present only on a degraded report. [optional]
Service Pointer to string Service names the subsystem answering, so a probe aggregating several health endpoints can attribute a degraded one. [optional]
Status Pointer to string Status is ok or degraded. Degraded is the 503 and means EITHER load-bearing dependency is down — the warehouse this subsystem reads, or the event plane it writes. It is not moved by a missing lens table, which is honest-empty. [optional]
Warehouse Pointer to string Warehouse names the datastore database every lens reads. [optional]

Methods

NewEventHealthReport

func NewEventHealthReport() *EventHealthReport

NewEventHealthReport instantiates a new EventHealthReport object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewEventHealthReportWithDefaults

func NewEventHealthReportWithDefaults() *EventHealthReport

NewEventHealthReportWithDefaults instantiates a new EventHealthReport object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetDatastore

func (o *EventHealthReport) GetDatastore() bool

GetDatastore returns the Datastore field if non-nil, zero value otherwise.

GetDatastoreOk

func (o *EventHealthReport) GetDatastoreOk() (*bool, bool)

GetDatastoreOk returns a tuple with the Datastore field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDatastore

func (o *EventHealthReport) SetDatastore(v bool)

SetDatastore sets Datastore field to given value.

HasDatastore

func (o *EventHealthReport) HasDatastore() bool

HasDatastore returns a boolean if a field has been set.

GetLenses

func (o *EventHealthReport) GetLenses() EventHealthLenses

GetLenses returns the Lenses field if non-nil, zero value otherwise.

GetLensesOk

func (o *EventHealthReport) GetLensesOk() (*EventHealthLenses, bool)

GetLensesOk returns a tuple with the Lenses field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLenses

func (o *EventHealthReport) SetLenses(v EventHealthLenses)

SetLenses sets Lenses field to given value.

HasLenses

func (o *EventHealthReport) HasLenses() bool

HasLenses returns a boolean if a field has been set.

GetLost

func (o *EventHealthReport) GetLost() EventLoss

GetLost returns the Lost field if non-nil, zero value otherwise.

GetLostOk

func (o *EventHealthReport) GetLostOk() (*EventLoss, bool)

GetLostOk returns a tuple with the Lost field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLost

func (o *EventHealthReport) SetLost(v EventLoss)

SetLost sets Lost field to given value.

HasLost

func (o *EventHealthReport) HasLost() bool

HasLost returns a boolean if a field has been set.

GetPlane

func (o *EventHealthReport) GetPlane() EventHealthPlane

GetPlane returns the Plane field if non-nil, zero value otherwise.

GetPlaneOk

func (o *EventHealthReport) GetPlaneOk() (*EventHealthPlane, bool)

GetPlaneOk returns a tuple with the Plane field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPlane

func (o *EventHealthReport) SetPlane(v EventHealthPlane)

SetPlane sets Plane field to given value.

HasPlane

func (o *EventHealthReport) HasPlane() bool

HasPlane returns a boolean if a field has been set.

GetReason

func (o *EventHealthReport) GetReason() string

GetReason returns the Reason field if non-nil, zero value otherwise.

GetReasonOk

func (o *EventHealthReport) GetReasonOk() (*string, bool)

GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetReason

func (o *EventHealthReport) SetReason(v string)

SetReason sets Reason field to given value.

HasReason

func (o *EventHealthReport) HasReason() bool

HasReason returns a boolean if a field has been set.

GetService

func (o *EventHealthReport) GetService() string

GetService returns the Service field if non-nil, zero value otherwise.

GetServiceOk

func (o *EventHealthReport) GetServiceOk() (*string, bool)

GetServiceOk returns a tuple with the Service field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetService

func (o *EventHealthReport) SetService(v string)

SetService sets Service field to given value.

HasService

func (o *EventHealthReport) HasService() bool

HasService returns a boolean if a field has been set.

GetStatus

func (o *EventHealthReport) GetStatus() string

GetStatus returns the Status field if non-nil, zero value otherwise.

GetStatusOk

func (o *EventHealthReport) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStatus

func (o *EventHealthReport) SetStatus(v string)

SetStatus sets Status field to given value.

HasStatus

func (o *EventHealthReport) HasStatus() bool

HasStatus returns a boolean if a field has been set.

GetWarehouse

func (o *EventHealthReport) GetWarehouse() string

GetWarehouse returns the Warehouse field if non-nil, zero value otherwise.

GetWarehouseOk

func (o *EventHealthReport) GetWarehouseOk() (*string, bool)

GetWarehouseOk returns a tuple with the Warehouse field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetWarehouse

func (o *EventHealthReport) SetWarehouse(v string)

SetWarehouse sets Warehouse field to given value.

HasWarehouse

func (o *EventHealthReport) HasWarehouse() bool

HasWarehouse returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]