Class: SafetyKit::Models::DataAddParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• SafetyKit::Models::DataAddParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/safety_kit/models/data_add_params.rb

Overview

See Also:

• Resources::Data#add

Defined Under Namespace

Modules: Data

Instance Attribute Summary

• #data ⇒ SafetyKit::Models::DataObject⁺

  A data object to ingest.

• #namespace ⇒ String

  The namespace to ingest data into.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(namespace:, data:, request_options: {}) ⇒ Object constructor

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

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(namespace:, data:, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see SafetyKit::Models::DataAddParams for more details.

Parameters:

• namespace (String) —

  The namespace to ingest data into

• data (SafetyKit::Models::DataObject, Array<SafetyKit::Models::DataObject>) —

  A data object to ingest. It must include an id field. All other fields are flexi

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

# File 'lib/safety_kit/models/data_add_params.rb', line 23

Instance Attribute Details

#data ⇒ SafetyKit::Models::DataObject⁺

A data object to ingest. It must include an id field. All other fields are flexible and can be any JSON type.

Returns:

• (SafetyKit::Models::DataObject, Array<SafetyKit::Models::DataObject>)

# File 'lib/safety_kit/models/data_add_params.rb', line 21

required :data, union: -> { SafetyKit::DataAddParams::Data }

#namespace ⇒ String

The namespace to ingest data into

Returns:

• (String)

# File 'lib/safety_kit/models/data_add_params.rb', line 14

required :namespace, String