Class: ContextDev::Models::BatchCancelResponse

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

Overview

See Also:

  • ContextDev::Resources::Batch#cancel

Defined Under Namespace

Modules: Format, Mode, Status Classes: Credits, KeyMetadata, Progress, Timing

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(created_at:, started_at:) ⇒ Object

There is no finish time yet — the batch is still winding down.

Parameters:

  • created_at (String) —

    When the batch was created.

  • started_at (String, nil) —

    When processing started. Null if it was cancelled while still queued.




# File 'lib/context_dev/models/batch_cancel_response.rb', line 81

Instance Attribute Details

#crawl ⇒ ContextDev::Models::CrawlControls?

The crawl controls as submitted, so the limits requested can be compared against what the crawl reached.

Parameters:

Returns:



18
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 18

required :crawl, -> { ContextDev::CrawlControls }, nil?: true

#credits ⇒ ContextDev::Models::BatchCancelResponse::Credits

What this batch cost so far.

Parameters:

Returns:



24
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 24

required :credits, -> { ContextDev::Models::BatchCancelResponse::Credits }

#format_ ⇒ Symbol, ContextDev::Models::BatchCancelResponse::Format

What each page is returned as.

Parameters:

  • value (ContextDev::Models::BatchCancelResponse::format_)

Returns:



30
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 30

required :format_, enum: -> { ContextDev::Models::BatchCancelResponse::Format }, api_name: :format

#id ⇒ String

Batch ID.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 11

required :id, String

#input ⇒ ContextDev::Models::Intake

What submission took in, and what it charged for.

Parameters:

Returns:



36
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 36

required :input, -> { ContextDev::Intake }

#key_metadata ⇒ ContextDev::Models::BatchCancelResponse::KeyMetadata?

API key usage for this request.

Returns:



79
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 79

optional :key_metadata, -> { ContextDev::Models::BatchCancelResponse::KeyMetadata }

#mode ⇒ Symbol, ContextDev::Models::BatchCancelResponse::Mode

How pages were selected.

Parameters:

  • value (ContextDev::Models::BatchCancelResponse::mode)

Returns:



42
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 42

required :mode, enum: -> { ContextDev::Models::BatchCancelResponse::Mode }

#page_errors ⇒ Array<ContextDev::Models::PageErrorCount>

Page failures so far, grouped by error code and sorted by count.

Parameters:

Returns:



48
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 48

required :page_errors, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::PageErrorCount] }

#progress ⇒ ContextDev::Models::BatchCancelResponse::Progress

How far the batch got before cancellation.

Parameters:

Returns:



54
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 54

required :progress, -> { ContextDev::Models::BatchCancelResponse::Progress }

#status ⇒ Symbol, ContextDev::Models::BatchCancelResponse::Status

Always cancelling. Work already in flight finishes; the batch reaches cancelled shortly after.

Parameters:

  • value (ContextDev::Models::BatchCancelResponse::status)

Returns:



61
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 61

required :status, enum: -> { ContextDev::Models::BatchCancelResponse::Status }

#tags ⇒ Array<String>

Tags stored on the batch at submission.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


67
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 67

required :tags, ContextDev::Internal::Type::ArrayOf[String]

#timing ⇒ ContextDev::Models::BatchCancelResponse::Timing

There is no finish time yet — the batch is still winding down.

Parameters:

Returns:



73
 
# File 'lib/context_dev/models/batch_cancel_response.rb', line 73

required :timing, -> { ContextDev::Models::BatchCancelResponse::Timing }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/context_dev/models/batch_cancel_response.rb', line 136

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


63
 
# File 'sig/context_dev/models/batch_cancel_response.rbs', line 63

def to_hash: -> {