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

Inherits:

BaseModel

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

Includes:

RequestParameters

Defined in:

lib/finch-api/models/jobs/automated_create_params.rb

Defined Under Namespace

Modules: Type Classes: Params

Instance Attribute Summary

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

  The type of job to start.

Attributes included from RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

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

  A new instance of AutomatedCreateParams.

Methods included from RequestParameters

included

Methods inherited from BaseModel

==, #==, #[], coerce, #deconstruct_keys, dump, fields, #inspect, known_fields, optional, required, #to_h

Methods included from Converter

#coerce, coerce, #dump, dump, type_info

Constructor Details

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

Returns a new instance of AutomatedCreateParams.

Parameters:

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

# File 'lib/finch-api/models/jobs/automated_create_params.rb', line 5

def initialize(type:, params:, request_options: {}, **) = super

Instance Attribute Details

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

Returns:

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

# File 'lib/finch-api/models/jobs/automated_create_params.rb', line 20

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

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

The type of job to start.

Returns:

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

# File 'lib/finch-api/models/jobs/automated_create_params.rb', line 15

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/finch-api/models/jobs/automated_create_params.rb', line 2

def self.values; end