Class: Infrawrench::ChangesNamespace

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

Overview

client.changes

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ ChangesNamespace

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

Parameters:



1341
1342
1343
1344
 
# File 'lib/infrawrench/client.rb', line 1341

def initialize(transport)
  @transport = transport
  @alert_settings = ChangesAlertSettingsNamespace.new(@transport)
end

Instance Attribute Details

#alert_settings ⇒ ChangesAlertSettingsNamespace (readonly)

Returns client.changes.alert_settings.

Returns:



1337
1338
1339
 
# File 'lib/infrawrench/client.rb', line 1337

def alert_settings
  @alert_settings
end

Instance Method Details

#get(org_id: nil, page: nil, page_size: nil, account_id: nil, resource_id: nil, kind: nil, from: nil, to: nil, request_options: nil) ⇒ Hash

Org-wide change timeline (paginated, filterable)

Change events recorded by the resource poller: each poll cycle diffs the freshly fetched state against the stored snapshot and records resources that appeared, changed a stored field, or disappeared upstream. Cross-provider by construction — the diff runs on the generic stored record, so every plugin's resources show up here.

Requires permission: resources:read.

GET /api/org/orgId/changes

Raises on 400: Bad request

Parameters:

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

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

  • page (Integer, nil) (defaults to: nil)
  • page_size (Integer, nil) (defaults to: nil)
  • account_id (String, nil) (defaults to: nil)
  • resource_id (String, nil) (defaults to: nil)
  • kind (String, nil) (defaults to: nil)
  • from (String, nil) (defaults to: nil)
  • to (String, nil) (defaults to: nil)
  • request_options (Hash, nil) (defaults to: nil) —

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

  • org_id: (String, nil) (defaults to: nil)
  • page: (Integer, nil) (defaults to: nil)
  • page_size: (Integer, nil) (defaults to: nil)
  • account_id: (String, nil) (defaults to: nil)
  • resource_id: (String, nil) (defaults to: nil)
  • kind: (resource_change_kind, nil) (defaults to: nil)
  • from: (String, nil) (defaults to: nil)
  • to: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

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

Raises:



1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'lib/infrawrench/client.rb', line 1373

def get(
  org_id: nil,
  page: nil,
  page_size: nil,
  account_id: nil,
  resource_id: nil,
  kind: nil,
  from: nil,
  to: nil,
  request_options: nil
)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/changes",
    path_params: { "orgId" => org_id },
    query: {
      "page" => page,
      "pageSize" => page_size,
      "accountId" => ,
      "resourceId" => resource_id,
      "kind" => kind,
      "from" => from,
      "to" => to
    },
    request_options: request_options
  )
end

#resource(resource_id:, org_id: nil, limit: nil, request_options: nil) ⇒ Hash

Change timeline for one resource

Recent change events for a single resource, newest first. The resource id travels as a query parameter because composite ids contain slashes and colons.

Requires permission: resources:read.

GET /api/org/orgId/changes/resource

Raises on 400: Bad request

Parameters:

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

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

  • resource_id (String)
  • limit (Integer, nil) (defaults to: nil)
  • request_options (Hash, nil) (defaults to: nil) —

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

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

Returns:

  • (Hash) —

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

Raises:



1421
1422
1423
1424
1425
1426
1427
1428
1429
 
# File 'lib/infrawrench/client.rb', line 1421

def resource(resource_id:, org_id: nil, limit: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/changes/resource",
    path_params: { "orgId" => org_id },
    query: { "resourceId" => resource_id, "limit" => limit },
    request_options: request_options
  )
end