Class: SafetyKit::Models::DataUpdateSettingsParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/safety_kit/models/data_update_settings_params.rb

Overview

See Also:

• Resources::Data#update_settings

Defined Under Namespace

Classes: Schema

Instance Attribute Summary

• #namespace ⇒ String

  The namespace to ingest data into.

• #schema ⇒ Hash{Symbol=>SafetyKit::Models::DataUpdateSettingsParams::Schema}

  Schema mapping field names to their definitions.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from SafetyKit::Internal::Type::BaseModel

Instance Attribute Details

#namespace ⇒ String

The namespace to ingest data into

Returns:

• (String)

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

required :namespace, String

#schema ⇒ Hash{Symbol=>SafetyKit::Models::DataUpdateSettingsParams::Schema}

Schema mapping field names to their definitions. Use content_type to specify which fields contain URLs that should be processed (images, videos, or websites), datetime fields, or ‘metadata’ for fields that should be stored but not indexed. Use display_hint to provide UI rendering hints.

Returns:

• (Hash{Symbol=>SafetyKit::Models::DataUpdateSettingsParams::Schema})

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

required :schema, -> { SafetyKit::Internal::Type::HashOf[SafetyKit::DataUpdateSettingsParams::Schema] }