Class: Infrawrench::WallboardNamespace

Inherits:
Object
  • Object
show all
Defined in:
lib/infrawrench/client.rb,
sig/infrawrench/sdk.rbs

Overview

client.wallboard

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ WallboardNamespace

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of WallboardNamespace.

Parameters:



15215
15216
15217
 
# File 'lib/infrawrench/client.rb', line 15215

def initialize(transport)
  @transport = transport
end

Instance Method Details

#get(org_id: nil, request_options: nil) ⇒ Hash

Everything that is wrong right now, for a screen on a wall

A different reading of data the product already holds, built on one rule: a wallboard may only show things that are true right now and that somebody would cross a room to look at. There is deliberately no history, no trend and no breakdown — those belong on the page you open when you do walk over.

Three sources — declared incidents, synthetic probes and account sync health — each guarded independently, because a television that goes blank because one query threw is showing nothing to a room that was relying on it.

Session-authenticated on purpose: unlike the calendar feed or a public status page, this carries incident titles, probe names and account names, and a screen in an office is exactly what a visitor photographs. The machine driving the wall signs in once.

GET /api/org/orgId/wallboard

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as WallboardResponse — see sig/infrawrench/sdk.rbs.

Raises:



15244
15245
15246
15247
15248
15249
15250
15251
 
# File 'lib/infrawrench/client.rb', line 15244

def get(org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/wallboard",
    path_params: { "orgId" => org_id },
    request_options: request_options
  )
end