Class: Infrawrench::DashboardsDefaultNamespace

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

Overview

client.dashboards.default

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ DashboardsDefaultNamespace

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

Parameters:



1286
1287
1288
 
# File 'lib/infrawrench/client.rb', line 1286

def initialize(transport)
  @transport = transport
end

Instance Method Details

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

Get-or-create the default dashboard with its pins

Requires permission: dashboards:read.

GET /api/org/orgId/dashboards/default/full

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 DashboardWithPins — see sig/infrawrench/sdk.rbs.

Raises:



1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'lib/infrawrench/client.rb', line 1301

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