Class: ESP::ExternalAccount

Inherits:

Resource

• Object
• ActiveResource::Base
• Resource
• ESP::ExternalAccount

Defined in:

lib/esp/resources/external_account.rb

Class Method Summary

• .all ⇒ ActiveResource::PaginatedCollection<ESP::ExternalAccount>

  Return a paginated list.

• .create(attributes = {}) ⇒ ESP::ExternalAccount

  Create an ExternalAccount.

• .find(id) ⇒ ESP::ExternalAccount

  Find an ExternalAccount by id.

• .where(clauses = {}) ⇒ ActiveResource::PaginatedCollection<ESP::ExternalAccount>

  Return a paginated ExternalAccount list filtered by search parameters.

Instance Method Summary

• #destroy ⇒ self

  Delete an ExternalAccount.

• #generate_external_id ⇒ String

  Helper to generate an external id.

• #organization ⇒ ESP::Organization

  The organization the external account belongs to.

• #reports ⇒ ActiveResource::PaginatedCollection<ESP::Report>

  The collection of reports that belong to the team.

• #save ⇒ Boolean

  Create or update an ExternalAccount.

• #scan_intervals ⇒ ActiveResource::PaginatedCollection<ESP::ScanInterval>

  Returns a collection of scan_intervals for the external account.

• #sub_organization ⇒ ESP::SubOrganization

  The sub_organization the external account belongs to.

• #team ⇒ ESP::Team

  The team the external account belongs to.

Methods included from Dirty

#changed_attributes, #original_attributes, #original_attributes=

Methods included from LoadWithOriginalAttributes

#load

Class Method Details

.all ⇒ ActiveResource::PaginatedCollection<ESP::ExternalAccount>

Return a paginated list

Returns:

• (ActiveResource::PaginatedCollection<ESP::ExternalAccount>)

# File 'lib/esp/resources/external_account.rb', line 78

.create(attributes = {}) ⇒ ESP::ExternalAccount

Create an ExternalAccount. call-seq -> super.create(attributes={})

Examples:

external_account = ESP::ExternalAccount.create(arn: 'arn:from:aws', external_id: 'c40e6af4-a5a0-422a-9a42-3d7d236c3428', sub_organization_id: 4, team_id: 8)

Parameters:

• attributes (Hash) (defaults to: {}) —

  Required hash of external account attributes.

  Valid Attributes

  See API documentation for valid arguments

Returns:

• (ESP::ExternalAccount)

# File 'lib/esp/resources/external_account.rb', line 83

.find(id) ⇒ ESP::ExternalAccount .find(id, options = {}) ⇒ ESP::ExternalAccount

Find an ExternalAccount by id

call-seq -> super.find(id, options = {})

Overloads:

• .find(id, options = {}) ⇒ ESP::ExternalAccount

  Parameters:

  • options (Hash) (defaults to: {}) —

    An optional hash of options.

    Valid Options

    include | The list of associated objects to return on the initial request.

    Valid Includable Associations

    See API documentation for valid arguments

Parameters:

• id (Integer, Numberic, #to_i) —

  Required ID of the external account to retrieve.

Returns:

• (ESP::ExternalAccount)

# File 'lib/esp/resources/external_account.rb', line 60

.where(clauses = {}) ⇒ ActiveResource::PaginatedCollection<ESP::ExternalAccount>

Return a paginated ExternalAccount list filtered by search parameters

call-seq -> super.where(clauses = {})

Parameters:

• clauses (Hash) (defaults to: {}) —

  A hash of attributes with appended predicates to search, sort and include.

  Valid Clauses

  See API documentation for valid arguments

Returns:

• (ActiveResource::PaginatedCollection<ESP::ExternalAccount>)

# File 'lib/esp/resources/external_account.rb', line 49

Instance Method Details

#destroy ⇒ self

Delete an ExternalAccount

Returns:

• (self)

# File 'lib/esp/resources/external_account.rb', line 107

#generate_external_id ⇒ String

Helper to generate an external id. Called automatically when creating an ExternalAccount if external_id is not already set.

Returns:

• (String)

# File 'lib/esp/resources/external_account.rb', line 27

def generate_external_id
  SecureRandom.uuid
end

#organization ⇒ ESP::Organization

The organization the external account belongs to.

Returns:

• (ESP::Organization)

# File 'lib/esp/resources/external_account.rb', line 6

belongs_to :organization, class_name: 'ESP::Organization'

#reports ⇒ ActiveResource::PaginatedCollection<ESP::Report>

The collection of reports that belong to the team.

Returns:

• (ActiveResource::PaginatedCollection<ESP::Report>)

# File 'lib/esp/resources/external_account.rb', line 21

has_many :reports, class_name: 'ESP::Report'

#save ⇒ Boolean

Create or update an ExternalAccount.

Valid Attributes

See API documentation for valid arguments

Examples:

external_account = ESP::ExternalAccount.new(arn: 'arn:from:aws', external_id: 'c40e6af4-a5a0-422a-9a42-3d7d236c3428', sub_organization_id: 4, team_id: 8)
external_account.save

Returns:

• (Boolean)

# File 'lib/esp/resources/external_account.rb', line 95

#scan_intervals ⇒ ActiveResource::PaginatedCollection<ESP::ScanInterval>

Returns a collection of scan_intervals for the external account

Examples:

external_account = ESP::ExternalAccount.find(345)
scan_intervals = external_account.scan_intervals

Returns:

• (ActiveResource::PaginatedCollection<ESP::ScanInterval>)

# File 'lib/esp/resources/external_account.rb', line 45

def scan_intervals
  ESP::ScanInterval.for_external_account(id)
end

#sub_organization ⇒ ESP::SubOrganization

The sub_organization the external account belongs to.

Returns:

• (ESP::SubOrganization)

# File 'lib/esp/resources/external_account.rb', line 11

belongs_to :sub_organization, class_name: 'ESP::SubOrganization'

#team ⇒ ESP::Team

The team the external account belongs to.

Returns:

• (ESP::Team)

# File 'lib/esp/resources/external_account.rb', line 16

belongs_to :team, class_name: 'ESP::Team'