Expectation Incidents

An ExpectationIncident groups ongoing failure behavior for an Expectation over time.

List Expectation Incidents

SDK Method

\Files\Model\ExpectationIncident::list;

Return Object

ExpectationIncident[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

try {
  $expectation_incidents = \Files\Model\ExpectationIncident::list();
  foreach ($expectation_incidents as $expectation_incident) {
    // Operate on $expectation_incident
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show Expectation Incident

SDK Method

\Files\Model\ExpectationIncident::find;

Return Object

ExpectationIncident

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Expectation Incident ID.

Example Request

try {
  $expectation_incident = \Files\Model\ExpectationIncident::find($id);
  // Operate on $expectation_incident
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Resolve an expectation incident

SDK Method

$expectation_incident->resolve;

Return Object

ExpectationIncident

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

try {
  // Find the expectation_incident object by its id.
  $expectation_incident = \Files\Model\ExpectationIncident::find(id);
  $expectation_incident->resolve();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Snooze an expectation incident until a specified time

SDK Method

$expectation_incident->snooze;

Return Object

ExpectationIncident

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
snoozed_until
string
Required		Time until which the incident should remain snoozed.

Example Request

try {
  // Find the expectation_incident object by its id.
  $expectation_incident = \Files\Model\ExpectationIncident::find(id);
  $expectation_incident->snooze([
    'snoozed_until' => "snoozed_until"
  ]);
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Acknowledge an expectation incident

SDK Method

$expectation_incident->acknowledge;

Return Object

ExpectationIncident

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

try {
  // Find the expectation_incident object by its id.
  $expectation_incident = \Files\Model\ExpectationIncident::find(id);
  $expectation_incident->acknowledge();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The ExpectationIncident Object

Some of the methods above return a ExpectationIncident object. The attributes of this object are listed below.

AttributeDescription
id
int64		Expectation Incident ID
workspace_id
int64		Workspace ID. 0 means the default workspace.
expectation_id
int64		Expectation ID.
status
string		Incident status.
Possible values: open, acknowledged, snoozed, resolved
opened_at
date-time		When the incident was opened.
last_failed_at
date-time		When the most recent failing evaluation contributing to the incident occurred.
acknowledged_at
date-time		When the incident was acknowledged.
snoozed_until
date-time		When the current snooze expires.
resolved_at
date-time		When the incident was resolved.
opened_by_evaluation_id
int64		Evaluation that first opened the incident.
last_evaluation_id
int64		Most recent evaluation linked to the incident.
resolved_by_evaluation_id
int64		Evaluation that resolved the incident.
summary
object		Compact incident summary payload.
created_at
date-time		Creation time.
updated_at
date-time		Last update time.