Class: Infrawrench::DashboardsPinNamespace

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

Overview

client.dashboards.pin

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ DashboardsPinNamespace

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 DashboardsPinNamespace.

Parameters:



1993
1994
1995
 
# File 'lib/infrawrench/client.rb', line 1993

def initialize(transport)
  @transport = transport
end

Instance Method Details

#create(body:, org_id: nil, request_options: nil) ⇒ Hash

Pin a resource to a dashboard

Requires permission: dashboards:write.

POST /api/org/orgId/dashboards/pin

Raises on 404: Not found

Parameters:

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

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

  • body (Hash) —

    Request body, shaped as PinRequest.

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

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

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

Returns:

  • (Hash) —

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

Raises:



2011
2012
2013
2014
2015
2016
2017
2018
2019
 
# File 'lib/infrawrench/client.rb', line 2011

def create(body:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "POST",
    path: "/api/org/{orgId}/dashboards/pin",
    path_params: { "orgId" => org_id },
    body: body,
    request_options: request_options
  )
end

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

Full enriched pin data + cached probe status

Requires permission: dashboards:read.

GET /api/org/orgId/dashboards/pin/pinId

Raises on 404: Not found

Parameters:

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

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

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

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

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

Returns:

  • (Hash) —

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

Raises:



2035
2036
2037
2038
2039
2040
2041
2042
 
# File 'lib/infrawrench/client.rb', line 2035

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

#range(pin_id:, org_id: nil, from_ms: nil, to_ms: nil, request_options: nil) ⇒ Hash

Historical metric series for a pinned resource

Returns per-series metric points between fromMs and toMs. The backend auto-routes between raw, 1-minute, and 1-hour rollups based on span: ≤2h raw, ≤7d 1m, >7d 1h.

GET /api/org/orgId/dashboards/pin/pinId/range

Raises on 400: Bad request

Raises on 404: Not found

Parameters:

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

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

  • pin_id (String)
  • from_ms (Integer, nil, nil) (defaults to: nil)
  • to_ms (Integer, nil, nil) (defaults to: nil)
  • request_options (Hash, nil) (defaults to: nil) —

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

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

Returns:

  • (Hash) —

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

Raises:



2064
2065
2066
2067
2068
2069
2070
2071
2072
 
# File 'lib/infrawrench/client.rb', line 2064

def range(pin_id:, org_id: nil, from_ms: nil, to_ms: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/dashboards/pin/{pinId}/range",
    path_params: { "orgId" => org_id, "pinId" => pin_id },
    query: { "fromMs" => from_ms, "toMs" => to_ms },
    request_options: request_options
  )
end