Class: ContextDev::Models::BatchSubmitParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::BatchSubmitParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/context_dev/models/batch_submit_params.rb,
sig/context_dev/models/batch_submit_params.rbs

Overview

See Also:

• ContextDev::Resources::Batch#submit

Defined Under Namespace

Modules: Input

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::ContextDev

Instance Attribute Summary

• #idempotency_key ⇒ String^?

  Any string unique to this submission.

• #input ⇒ ContextDev::Models::BatchSubmitParams::Input::Scrape, ContextDev::Models::BatchSubmitParams::Input::Crawl

  Choose a URL list or a site crawl.

• #tags ⇒ Array<String>^?

  Tags stored on the batch.

• #webhook_url ⇒ String^?

  URL notified when the batch finishes.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(input:, tags: nil, webhook_url: nil, idempotency_key: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see BatchSubmitParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(input:, tags: nil, webhook_url: nil, idempotency_key: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::BatchSubmitParams for more details.

Parameters:

• input (ContextDev::Models::BatchSubmitParams::Input::Scrape, ContextDev::Models::BatchSubmitParams::Input::Crawl) —

  Choose a URL list or a site crawl.

• tags (Array<String>) (defaults to: nil) —

  Tags stored on the batch. Filter the batch list by them later.

• webhook_url (String) (defaults to: nil) —

  URL notified when the batch finishes.

• idempotency_key (String) (defaults to: nil) —

  Any string unique to this submission. Retries with the same key return the origi

• request_options (ContextDev::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/context_dev/models/batch_submit_params.rb', line 35

Instance Attribute Details

#idempotency_key ⇒ String^?

Any string unique to this submission. Retries with the same key return the original batch.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/context_dev/models/batch_submit_params.rb', line 33

optional :idempotency_key, String

#input ⇒ ContextDev::Models::BatchSubmitParams::Input::Scrape, ContextDev::Models::BatchSubmitParams::Input::Crawl

Choose a URL list or a site crawl.

Parameters:

• value (ContextDev::Models::BatchSubmitParams::input)

Returns:

• (ContextDev::Models::BatchSubmitParams::Input::Scrape, ContextDev::Models::BatchSubmitParams::Input::Crawl)

# File 'lib/context_dev/models/batch_submit_params.rb', line 14

required :input, union: -> { ContextDev::BatchSubmitParams::Input }

#tags ⇒ Array<String>^?

Tags stored on the batch. Filter the batch list by them later.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/context_dev/models/batch_submit_params.rb', line 20

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

#webhook_url ⇒ String^?

URL notified when the batch finishes.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/context_dev/models/batch_submit_params.rb', line 26

optional :webhook_url, String, api_name: :webhookUrl

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/context_dev/models/batch_submit_params.rbs', line 38

def to_hash: -> {