Class: Handinger::Models::Worker

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/handinger/models/worker.rb,
sig/handinger/models/worker.rbs

Overview

See Also:

  • Handinger::Resources::Workers#retrieve

Defined Under Namespace

Modules: Status Classes: File, Output, Source, Usage

Instance Attribute Summary collapse

Class Method 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(id:, title:, url:, type: :url) ⇒ Object

Parameters:

  • id (String)
  • title (String, nil)
  • url (String)
  • type (Symbol, :url) (defaults to: :url) 



# File 'lib/handinger/models/worker.rb', line 144

Instance Attribute Details

#created_at ⇒ Integer?

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


15
 
# File 'lib/handinger/models/worker.rb', line 15

required :created_at, Integer, nil?: true

#error ⇒ nil

Parameters:

  • value (nil)

Returns:

  • (nil) 


20
 
# File 'lib/handinger/models/worker.rb', line 20

required :error, NilClass

#files ⇒ Array<Handinger::Models::Worker::File>

Parameters:

  • value (::Array[Handinger::Worker::File])

Returns:



25
 
# File 'lib/handinger/models/worker.rb', line 25

required :files, -> { Handinger::Internal::Type::ArrayOf[Handinger::Worker::File] }

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/handinger/models/worker.rb', line 10

required :id, String

#incomplete_details ⇒ nil

Parameters:

  • value (nil)

Returns:

  • (nil) 


30
 
# File 'lib/handinger/models/worker.rb', line 30

required :incomplete_details, NilClass

#messages ⇒ Array<Object>

Parameters:

  • value (::Array[top])

Returns:

  • (Array<Object>) 


35
 
# File 'lib/handinger/models/worker.rb', line 35

required :messages, Handinger::Internal::Type::ArrayOf[Handinger::Internal::Type::Unknown]

#metadata ⇒ Hash{Symbol=>Object}

Parameters:

  • value (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}) 


40
 
# File 'lib/handinger/models/worker.rb', line 40

required :metadata, Handinger::Internal::Type::HashOf[Handinger::Internal::Type::Unknown]

#object ⇒ Symbol, :worker

Parameters:

  • value (:worker)

Returns:

  • (Symbol, :worker) 


45
 
# File 'lib/handinger/models/worker.rb', line 45

required :object, const: :worker

#output ⇒ Array<Handinger::Models::Worker::Output>

Parameters:

  • value (::Array[Handinger::Worker::Output])

Returns:



50
 
# File 'lib/handinger/models/worker.rb', line 50

required :output, -> { Handinger::Internal::Type::ArrayOf[Handinger::Worker::Output] }

#output_text ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


55
 
# File 'lib/handinger/models/worker.rb', line 55

required :output_text, String

#running ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


60
 
# File 'lib/handinger/models/worker.rb', line 60

required :running, Handinger::Internal::Type::Boolean

#sources ⇒ Array<Handinger::Models::Worker::Source>

Parameters:

  • value (::Array[Handinger::Worker::Source])

Returns:



65
 
# File 'lib/handinger/models/worker.rb', line 65

required :sources, -> { Handinger::Internal::Type::ArrayOf[Handinger::Worker::Source] }

#status ⇒ Symbol, Handinger::Models::Worker::Status

Parameters:

  • value (Handinger::Models::Worker::status)

Returns:



70
 
# File 'lib/handinger/models/worker.rb', line 70

required :status, enum: -> { Handinger::Worker::Status }

#structured_output ⇒ Hash{Symbol=>Object}?

Parameters:

  • value (::Hash[Symbol, top], nil)

Returns:

  • (Hash{Symbol=>Object}, nil) 


75
76
77
 
# File 'lib/handinger/models/worker.rb', line 75

required :structured_output,
Handinger::Internal::Type::HashOf[Handinger::Internal::Type::Unknown],
nil?: true

#url ⇒ String

Web URL of the worker in the Handinger dashboard.

Parameters:

  • value (String)

Returns:

  • (String) 


83
 
# File 'lib/handinger/models/worker.rb', line 83

required :url, String

#usage ⇒ Handinger::Models::Worker::Usage?

Parameters:

  • (Handinger::Worker::Usage)

Returns:



88
 
# File 'lib/handinger/models/worker.rb', line 88

optional :usage, -> { Handinger::Worker::Usage }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/handinger/models/worker.rb', line 237

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


77
 
# File 'sig/handinger/models/worker.rbs', line 77

def to_hash: -> {