Class: Continuum::LevelAccessPlatform

Inherits:
Object
  • Object
show all
Defined in:
src/lib/continuum/level_access_platform.rb

Overview

A class which encapsulates the properties associated with integration to Level Access Platform.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(platform_config) ⇒ LevelAccessPlatform

Creates a new LevelAccessPlatform instance.

Parameters:

  • platform_config (Hash) —

    The platform config as defined in thee continuum.json file



45
46
47
48
49
50
51
 
# File 'src/lib/continuum/level_access_platform.rb', line 45

def initialize(platform_config)
    @api_key = platform_config['apiKey']
    @org_instance_url = platform_config['orgInstanceUrl']
    @workspace_id = platform_config['workspaceId']
    @digital_property_id = platform_config['digitalPropertyId']
    @scan_tag_id = platform_config['scanTagId']
end

Instance Attribute Details

#api_key ⇒ String

Gets the value for the ‘apiKey’ attribute of the the ‘levelAccessPlatform’ object defined in continuum.json. The API key is required to be sent with every request when connecting to Level Access Platform.

Returns:

  • (String) —

    The value for the ‘apiKey’ attribute of the the ‘levelAccessPlatform’ object defined in continuum.json



12
13
14
 
# File 'src/lib/continuum/level_access_platform.rb', line 12

def api_key
  @api_key
end

#digital_property_id ⇒ String

Gets the value for the ‘digitalPropetyId’ attribute of the the ‘levelAccessPlatform’ object defined in continuum.json. The default digital property id used when opening a new scan session. This value may be omitted as long as you provide a valid value when opening a new scan session.

Returns:

  • (String) —

    The value for the ‘digitalPropertyId’ attribute of the the ‘levelAccessPlatform’ object defined in continuum.json



32
33
34
 
# File 'src/lib/continuum/level_access_platform.rb', line 32

def digital_property_id
  @digital_property_id
end

#org_instance_url ⇒ String

Gets the value for the ‘orgInstanceUrl’ attribute of the the ‘levelAccessPlatform’ object defined in continuum.json. The URL of the organization instance to which you will be connecting, opening a session, and sending results.

Returns:

  • (String) —

    The value for the ‘orgInstanceUrl’ attribute of the the ‘levelAccessPlatform’ object defined in continuum.json



18
19
20
 
# File 'src/lib/continuum/level_access_platform.rb', line 18

def org_instance_url
  @org_instance_url
end

#scan_tag_id ⇒ String

Gets the value for the ‘scanTagId’ attribute of the the ‘levelAccessPlatform’ object defined in continuum.json. The default scan tag id used when opening a new scan session. This value may be omitted as long as you provide a valid value when opening a new scan session.

Returns:

  • (String) —

    The value for the ‘scanTagId’ attribute of the the ‘levelAccessPlatform’ object defined in continuum.json



39
40
41
 
# File 'src/lib/continuum/level_access_platform.rb', line 39

def scan_tag_id
  @scan_tag_id
end

#workspace_id ⇒ String

Gets the value for the ‘workspaceId’ attribute of the the ‘levelAccessPlatform’ object defined in continuum.json. The default workspace id used when opening a new scan session. This value may be omitted as long as you provide a valid value when opening a new scan session.

Returns:

  • (String) —

    The value for the ‘workspaceId’ attribute of the the ‘levelAccessPlatform’ object defined in continuum.json



25
26
27
 
# File 'src/lib/continuum/level_access_platform.rb', line 25

def workspace_id
  @workspace_id
end