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

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

Parameters:



51
52
53
 
# File 'lib/finch_api/resources/sandbox/jobs/configuration.rb', line 51

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(request_options: {}) ⇒ Array<FinchAPI::Sandbox::Jobs::SandboxJobConfiguration>

Get configurations for sandbox jobs

Parameters:

Returns:

  • (Array<FinchAPI::Sandbox::Jobs::SandboxJobConfiguration>)

See Also:



17
18
19
20
21
22
23
24
 
# File 'lib/finch_api/resources/sandbox/jobs/configuration.rb', line 17

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

#update(completion_status: , type: , request_options: {}) ⇒ FinchAPI::Sandbox::Jobs::SandboxJobConfiguration

Update configurations for sandbox jobs

Parameters:

  • completion_status (Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus)
  • type (Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type)
  • request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (FinchAPI::Sandbox::Jobs::SandboxJobConfiguration)

See Also:



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/finch_api/resources/sandbox/jobs/configuration.rb', line 37

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