Class: FinchAPI::Models::Jobs::ManualAsyncJob

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/jobs/manual_async_job.rb,
sig/finch_api/models/jobs/manual_async_job.rbs

Overview

See Also:

  • FinchAPI::Resources::Jobs::Manual#retrieve

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(body:, job_id:, status:) ⇒ Object

Parameters:




# File 'lib/finch_api/models/jobs/manual_async_job.rb', line 26

Instance Attribute Details

#body ⇒ Array<Object, nil>?

Specific information about the job, such as individual statuses for batch jobs.

Parameters:

  • value (::Array[top?], nil)

Returns:

  • (Array<Object, nil>, nil) 


12
13
14
 
# File 'lib/finch_api/models/jobs/manual_async_job.rb', line 12

required :body,
FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown, nil?: true],
nil?: true

#job_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/finch_api/models/jobs/manual_async_job.rb', line 19

required :job_id, String

#status ⇒ Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status

Parameters:

  • value (FinchAPI::Models::Jobs::ManualAsyncJob::status)

Returns:



24
 
# File 'lib/finch_api/models/jobs/manual_async_job.rb', line 24

required :status, enum: -> { FinchAPI::Jobs::ManualAsyncJob::Status }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


24
 
# File 'sig/finch_api/models/jobs/manual_async_job.rbs', line 24

def to_hash: -> {