Class: PEClient::Resource::OrchestratorV1::Scopes

Inherits:
Base
  • Object
show all
Defined in:
lib/pe_client/resources/orchestrator.v1/scopes.rb

Overview

Use the scopes endpoints to retrieve information about task-targets.

See Also:

Constant Summary collapse

BASE_PATH =

The base path for OrchestratorV1 API v1 Scopes endpoints.

"#{OrchestratorV1::BASE_PATH}/scopes/task_targets".freeze

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from PEClient::Resource::Base

Instance Method Details

#get(task_target_id: nil) ⇒ Hash

Retrieve information about all orchestrator task-targets. Or Get information about a specific task-target.

Parameters:

  • task_target_id (String) (defaults to: nil)

Returns:

  • (Hash) 


35
36
37
38
39
40
41
 
# File 'lib/pe_client/resources/orchestrator.v1/scopes.rb', line 35

def get(task_target_id: nil)
  if task_target_id
    @client.get "#{BASE_PATH}/#{task_target_id}"
  else
    @client.get BASE_PATH
  end
end