Class: Infrawrench::ExpiringNamespace

Inherits:

Object

• Object
• Infrawrench::ExpiringNamespace

Defined in:

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

Overview

client.expiring

Instance Attribute Summary

• #settings ⇒ ExpiringSettingsNamespace readonly

  client.expiring.settings.

Instance Method Summary

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

  List approaching deadlines on synced resources.

• #initialize(transport) ⇒ ExpiringNamespace constructor private

  A new instance of ExpiringNamespace.

Constructor Details

#initialize(transport) ⇒ ExpiringNamespace

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

Parameters:

• transport (Transport)
• (Transport)

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

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

Instance Attribute Details

#settings ⇒ ExpiringSettingsNamespace (readonly)

Returns client.expiring.settings.

Returns:

• (ExpiringSettingsNamespace) —

  client.expiring.settings

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

def settings
  @settings
end

Instance Method Details

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

List approaching deadlines on synced resources

One cross-provider countdown of everything with a clock on it: TLS certificate expiries, domain registrations, API token expirations, access keys past their rotation budget, Kubernetes/SSH credential ages. Plugins declare which synced fields carry deadlines; the feed is computed over already-stored state, so no provider API calls are made and results reflect the last sync. Items are sorted soonest first and bucketed by severity against the organization's lead time.

Requires permission: resources:read.

GET /api/org/orgId/expiring

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

Raises:

• (Infrawrench::ApiError) —

  On any non-2xx response.

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

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