Class: Infrawrench::QuotasNamespace

Inherits:

Object

• Object
• Infrawrench::QuotasNamespace

Defined in:

lib/infrawrench/client.rb,
sig/infrawrench/sdk.rbs

Overview

client.quotas

Instance Attribute Summary

• #settings ⇒ QuotasSettingsNamespace readonly

  client.quotas.settings.

Instance Method Summary

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

  List provider quota utilisation across the organization.

• #initialize(transport) ⇒ QuotasNamespace constructor private

  A new instance of QuotasNamespace.

Constructor Details

#initialize(transport) ⇒ QuotasNamespace

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

Parameters:

• transport (Transport)
• (Transport)

# File 'lib/infrawrench/client.rb', line 11864

def initialize(transport)
  @transport = transport
  @settings = QuotasSettingsNamespace.new(@transport)
end

Instance Attribute Details

#settings ⇒ QuotasSettingsNamespace (readonly)

Returns client.quotas.settings.

Returns:

• (QuotasSettingsNamespace) —

  client.quotas.settings

# File 'lib/infrawrench/client.rb', line 11860

def settings
  @settings
end

Instance Method Details

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

List provider quota utilisation across the organization

How close each account is to the limits its provider enforces, with the trend fitted over the last 14 days of collected readings. Both halves of every row — the used figure and the limit — come from the provider; nothing is filled in from published defaults, so an account with an approved increase reads as having the headroom it has. This is a read over already-collected snapshots: no provider API calls are made here, and the readings are as fresh as the last collection pass (roughly six hours). A plugin that declares no quota capability contributes nothing rather than zero — see unsupportedPluginIds.

Requires permission: resources:read.

GET /api/org/orgId/quotas

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

Raises:

• (Infrawrench::ApiError) —

  On any non-2xx response.

# File 'lib/infrawrench/client.rb', line 11890

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