Class: FinchAPI::Resources::Sandbox::Jobs::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/finch-api/resources/sandbox/jobs/configuration.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Configuration

Returns a new instance of Configuration.

Parameters:



47
48
49
 
# File 'lib/finch-api/resources/sandbox/jobs/configuration.rb', line 47

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(params = {}) ⇒ Array<FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration>

Get configurations for sandbox jobs

Parameters:

Returns:



15
16
17
18
19
20
21
22
 
# File 'lib/finch-api/resources/sandbox/jobs/configuration.rb', line 15

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "sandbox/jobs/configuration",
    model: FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration],
    options: params[:request_options]
  )
end

#update(params) ⇒ FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration

Update configurations for sandbox jobs

Parameters:

  • params (FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams, Hash{Symbol=>Object}) —

    .

    @option params [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus] :completion_status

    @option params [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type] :type

    @option params [FinchAPI::RequestOptions, HashSymbol=>Object, nil] :request_options

Returns:



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/finch-api/resources/sandbox/jobs/configuration.rb', line 35

def update(params)
  parsed, options = FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams.dump_request(params)
  @client.request(
    method: :put,
    path: "sandbox/jobs/configuration",
    body: parsed,
    model: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration,
    options: options
  )
end