Class: FinchAPI::Models::Jobs::AutomatedCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• FinchAPI::Models::Jobs::AutomatedCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/finch_api/models/jobs/automated_create_params.rb

Overview

See Also:

• Resources::Jobs::Automated#create

Defined Under Namespace

Modules: Type Classes: Params

Instance Attribute Summary

• #params ⇒ FinchAPI::Jobs::AutomatedCreateParams::Params
• #type ⇒ Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type

  The type of job to start.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(type: , params: , request_options: {}) ⇒ Object constructor

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, dump, fields, hash, #hash, inspect, #inspect, known_fields, optional, required, #to_h, #to_json, #to_s, #to_yaml, walk

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Constructor Details

#initialize(type: , params: , request_options: {}) ⇒ Object

Parameters:

• type (Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type) (defaults to: ) —

  The type of job to start.

• params (FinchAPI::Jobs::AutomatedCreateParams::Params) (defaults to: )
• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/finch_api/models/jobs/automated_create_params.rb', line 22

Instance Attribute Details

#params ⇒ FinchAPI::Jobs::AutomatedCreateParams::Params

Returns:

• (FinchAPI::Jobs::AutomatedCreateParams::Params)

# File 'lib/finch_api/models/jobs/automated_create_params.rb', line 20

required :params, -> { FinchAPI::Jobs::AutomatedCreateParams::Params }

#type ⇒ Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type

The type of job to start.

Returns:

• (Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type)

# File 'lib/finch_api/models/jobs/automated_create_params.rb', line 15

required :type, enum: -> { FinchAPI::Jobs::AutomatedCreateParams::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/finch_api/models/jobs/automated_create_params.rb', line 35