Class: Orb::Models::EventIngestParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/event_ingest_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Event

Instance Attribute Summary collapse

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 Orb::Internal::Type::BaseModel

Instance Attribute Details

#backfill_id ⇒ String?

If this ingestion request is part of a backfill, this parameter ties the ingested events to the backfill

Returns:

  • (String, nil) 


20
 
# File 'lib/orb/models/event_ingest_params.rb', line 20

optional :backfill_id, String, nil?: true

#debug ⇒ Boolean?

Flag to enable additional debug information in the endpoint response

Returns:

  • (Boolean, nil) 


26
 
# File 'lib/orb/models/event_ingest_params.rb', line 26

optional :debug, Orb::Internal::Type::Boolean

#events ⇒ Array<Orb::Models::EventIngestParams::Event>

Returns:



13
 
# File 'lib/orb/models/event_ingest_params.rb', line 13

required :events, -> { Orb::Internal::Type::ArrayOf[Orb::EventIngestParams::Event] }