Class: FinchAPI::Models::Sandbox::JobCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• FinchAPI::Models::Sandbox::JobCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/finch_api/models/sandbox/job_create_params.rb

Overview

See Also:

• Resources::Sandbox::Jobs#create

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #type ⇒ Symbol, FinchAPI::Sandbox::JobCreateParams::Type

  The type of job to start.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(type: , 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, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!

Constructor Details

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

Parameters:

• type (Symbol, FinchAPI::Sandbox::JobCreateParams::Type) (defaults to: ) —

  The type of job to start. Currently the only supported type is ‘data_sync_all`

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

# File 'lib/finch_api/models/sandbox/job_create_params.rb', line 17

Instance Attribute Details

#type ⇒ Symbol, FinchAPI::Sandbox::JobCreateParams::Type

The type of job to start. Currently the only supported type is ‘data_sync_all`

Returns:

• (Symbol, FinchAPI::Sandbox::JobCreateParams::Type)

# File 'lib/finch_api/models/sandbox/job_create_params.rb', line 15

required :type, enum: -> { FinchAPI::Sandbox::JobCreateParams::Type }