Class: Infrawrench::BackupsNamespace

Inherits:

Object

• Object
• Infrawrench::BackupsNamespace

Defined in:

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

Overview

client.backups

Instance Attribute Summary

• #policies ⇒ BackupsPoliciesNamespace readonly

  client.backups.policies.

Instance Method Summary

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

  List backup coverage across synced resources.

• #initialize(transport) ⇒ BackupsNamespace constructor private

  A new instance of BackupsNamespace.

Constructor Details

#initialize(transport) ⇒ BackupsNamespace

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

Parameters:

• transport (Transport)
• (Transport)

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

def initialize(transport)
  @transport = transport
  @policies = BackupsPoliciesNamespace.new(@transport)
end

Instance Attribute Details

#policies ⇒ BackupsPoliciesNamespace (readonly)

Returns client.backups.policies.

Returns:

• (BackupsPoliciesNamespace) —

  client.backups.policies

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

def policies
  @policies
end

Instance Method Details

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

List backup coverage across synced resources

What protects the organization's stateful resources, what does not, and which backups protect nothing. Derived from already-synced inventory using the backupRole and backupPolicy declarations plugins carry on their resource types — no provider API calls are made and results reflect the last sync. Findings are recomputed on every read rather than stored. Orphaned backups carry a trailing-30-day spend quote when billing data is available.

GET /api/org/orgId/backups

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

Raises:

• (Infrawrench::ApiError) —

  On any non-2xx response.

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

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