Class: Orb::Models::Events::BackfillCreateParams

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

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(timeframe_end: , timeframe_start: , close_time: nil, customer_id: nil, deprecation_filter: nil, external_customer_id: nil, replace_existing_events: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Events::BackfillCreateParams for more details.

Parameters:

  • timeframe_end (Time) (defaults to: ) —

    The (exclusive) end of the usage timeframe affected by this backfill. By default

  • timeframe_start (Time) (defaults to: ) —

    The (inclusive) start of the usage timeframe affected by this backfill. By defau

  • close_time (Time, nil) (defaults to: nil) —

    The time at which no more events will be accepted for this backfill. The backfil

  • customer_id (String, nil) (defaults to: nil) —

    The Orb-generated ID of the customer to which this backfill is scoped. Omitting

  • deprecation_filter (String, nil) (defaults to: nil) —

    A boolean [computed property](/extensibility/advanced-metrics#computed-propertie

  • external_customer_id (String, nil) (defaults to: nil) —

    The external customer ID of the customer to which this backfill is scoped. Omitt

  • replace_existing_events (Boolean) (defaults to: nil) —

    If true, replaces all existing events in the timeframe with the newly ingested e

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



# File 'lib/orb/models/events/backfill_create_params.rb', line 64

Instance Attribute Details

#close_time ⇒ Time?

The time at which no more events will be accepted for this backfill. The backfill will automatically begin reflecting throughout Orb at the close time. If not specified, it will default to 1 day after the creation of the backfill.

Returns:

  • (Time, nil) 


33
 
# File 'lib/orb/models/events/backfill_create_params.rb', line 33

optional :close_time, Time, nil?: true

#customer_id ⇒ String?

The Orb-generated ID of the customer to which this backfill is scoped. Omitting this field will scope the backfill to all customers.

Returns:

  • (String, nil) 


40
 
# File 'lib/orb/models/events/backfill_create_params.rb', line 40

optional :customer_id, String, nil?: true

#deprecation_filter ⇒ String?

A boolean [computed property](/extensibility/advanced-metrics#computed-properties) used to filter the set of events to deprecate

Returns:

  • (String, nil) 


48
 
# File 'lib/orb/models/events/backfill_create_params.rb', line 48

optional :deprecation_filter, String, nil?: true

#external_customer_id ⇒ String?

The external customer ID of the customer to which this backfill is scoped. Omitting this field will scope the backfill to all customers.

Returns:

  • (String, nil) 


55
 
# File 'lib/orb/models/events/backfill_create_params.rb', line 55

optional :external_customer_id, String, nil?: true

#replace_existing_events ⇒ Boolean?

If true, replaces all existing events in the timeframe with the newly ingested events. If false, adds the newly ingested events to the existing events.

Returns:

  • (Boolean, nil) 


62
 
# File 'lib/orb/models/events/backfill_create_params.rb', line 62

optional :replace_existing_events, Orb::Internal::Type::Boolean

#timeframe_end ⇒ Time

The (exclusive) end of the usage timeframe affected by this backfill. By default, Orb allows backfills up to 31 days in duration at a time. Reach out to discuss extending this limit and your use case.

Returns:

  • (Time) 


17
 
# File 'lib/orb/models/events/backfill_create_params.rb', line 17

required :timeframe_end, Time

#timeframe_start ⇒ Time

The (inclusive) start of the usage timeframe affected by this backfill. By default, Orb allows backfills up to 31 days in duration at a time. Reach out to discuss extending this limit and your use case.

Returns:

  • (Time) 


25
 
# File 'lib/orb/models/events/backfill_create_params.rb', line 25

required :timeframe_start, Time