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,
sig/safety_kit/models/data_update_settings_params.rbs

Overview

See Also:

• SafetyKit::Resources::Data#update_settings

Defined Under Namespace

Classes: Schema

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::SafetyKit

Instance Attribute Summary

• #namespace ⇒ String

  The namespace to ingest data into.

• #previous_version ⇒ Integer^?

  The version returned by GET (or a prior update).

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

  New schema to store for this namespace.

• #settings ⇒ Hash{Symbol=>Object, nil}^?

  Namespace settings to store, replacing existing settings.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/safety_kit/models/data_update_settings_params.rbs', line 32

def initialize: (

Instance Attribute Details

#namespace ⇒ String

The namespace to ingest data into

Parameters:

• value (String)

Returns:

• (String)

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

required :namespace, String

#previous_version ⇒ Integer^?

The version returned by GET (or a prior update). When provided, the update is rejected with 409 if the stored configuration has changed since that read, so a stale sync cannot overwrite a newer update. Strongly recommended for automated schema syncs.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :previous_version, Integer

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

New schema to store for this namespace. Omit to leave the existing schema unchanged.

Returns:

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

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

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

#settings ⇒ Hash{Symbol=>Object, nil}^?

Namespace settings to store, replacing existing settings. Omit to leave existing settings unchanged. Configure these values with guidance from SafetyKit.

Parameters:

• (::Hash[Symbol, top?])

Returns:

• (Hash{Symbol=>Object, nil}, nil)

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

optional :settings, SafetyKit::Internal::Type::HashOf[SafetyKit::Internal::Type::Unknown, nil?: true]

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/safety_kit/models/data_update_settings_params.rbs', line 40

def to_hash: -> {