Class: Orb::Models::Events::BackfillCreateResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/events/backfill_create_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Method Summary collapse

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(id: , close_time: , created_at: , customer_id: , events_ingested: , replace_existing_events: , reverted_at: , status: , timeframe_end: , timeframe_start: , deprecation_filter: nil) ⇒ Object

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

A backfill represents an update to historical usage data, adding or replacing events in a timeframe.

Parameters:

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

    If in the future, the time at which the backfill will automatically close. If in

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

    The Orb-generated ID of the customer to which this backfill is scoped. If ‘null`

  • events_ingested (Integer) (defaults to: ) —

    The number of events ingested in this backfill.

  • replace_existing_events (Boolean) (defaults to: ) —

    If ‘true`, existing events in the backfill’s timeframe will be replaced with the

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

    The time at which this backfill was reverted.

  • status (Symbol, Orb::Models::Events::BackfillCreateResponse::Status) (defaults to: ) —

    The status of the backfill.

  • timeframe_end (Time) (defaults to: )
  • timeframe_start (Time) (defaults to: )
  • deprecation_filter (String, nil) (defaults to: nil) —

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




# File 'lib/orb/models/events/backfill_create_response.rb', line 76

Instance Attribute Details

#close_time ⇒ Time?

If in the future, the time at which the backfill will automatically close. If in the past, the time at which the backfill was closed.

Returns:

  • (Time, nil) 


18
 
# File 'lib/orb/models/events/backfill_create_response.rb', line 18

required :close_time, Time, nil?: true

#created_at ⇒ Time

Returns:

  • (Time) 


23
 
# File 'lib/orb/models/events/backfill_create_response.rb', line 23

required :created_at, Time

#customer_id ⇒ String?

The Orb-generated ID of the customer to which this backfill is scoped. If ‘null`, this backfill is scoped to all customers.

Returns:

  • (String, nil) 


30
 
# File 'lib/orb/models/events/backfill_create_response.rb', line 30

required :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) 


74
 
# File 'lib/orb/models/events/backfill_create_response.rb', line 74

optional :deprecation_filter, String, nil?: true

#events_ingested ⇒ Integer

The number of events ingested in this backfill.

Returns:

  • (Integer) 


36
 
# File 'lib/orb/models/events/backfill_create_response.rb', line 36

required :events_ingested, Integer

#id ⇒ String

Returns:

  • (String) 


11
 
# File 'lib/orb/models/events/backfill_create_response.rb', line 11

required :id, String

#replace_existing_events ⇒ Boolean

If ‘true`, existing events in the backfill’s timeframe will be replaced with the newly ingested events associated with the backfill. If ‘false`, newly ingested events will be added to the existing events.

Returns:

  • (Boolean) 


44
 
# File 'lib/orb/models/events/backfill_create_response.rb', line 44

required :replace_existing_events, Orb::Internal::Type::Boolean

#reverted_at ⇒ Time?

The time at which this backfill was reverted.

Returns:

  • (Time, nil) 


50
 
# File 'lib/orb/models/events/backfill_create_response.rb', line 50

required :reverted_at, Time, nil?: true

#status ⇒ Symbol, Orb::Models::Events::BackfillCreateResponse::Status

The status of the backfill.

Returns:



56
 
# File 'lib/orb/models/events/backfill_create_response.rb', line 56

required :status, enum: -> { Orb::Models::Events::BackfillCreateResponse::Status }

#timeframe_end ⇒ Time

Returns:

  • (Time) 


61
 
# File 'lib/orb/models/events/backfill_create_response.rb', line 61

required :timeframe_end, Time

#timeframe_start ⇒ Time

Returns:

  • (Time) 


66
 
# File 'lib/orb/models/events/backfill_create_response.rb', line 66

required :timeframe_start, Time