Method: Orchestrate::Client#get_event

Defined in:
lib/orchestrate/client.rb

#get_event(collection, key, event_type, timestamp, ordinal) ⇒ Object

Retrieves an individual event.

Parameters:

  • collection (#to_s) —

    The name of the collection.

  • key (#to_s) —

    The name of the key.

  • event_type (#to_s) —

    The category for the event.

  • timestamp (Time, Date, Integer, String) —

    The timestamp for the event. If a String, must match the Timestamp specification and include the milliseconds portion.

  • ordinal (Integer, #to_s) —

    The ordinal for the event in the given timestamp.

Returns:

  • Orchestrate::API::ItemResponse

Raises:

  • Orchestrate::API::NotFound If the requested event doesn't exist.

[View source]

267
268
269
270
271
 
# File 'lib/orchestrate/client.rb', line 267

def get_event(collection, key, event_type, timestamp, ordinal)
  timestamp = API::Helpers.timestamp(timestamp)
  path = [collection, key, 'events', event_type, timestamp, ordinal]
  send_request :get, path, { response: API::ItemResponse }
end