Class: Orchestrate::Ref

Inherits:

KeyValue

• Object
• KeyValue
• Orchestrate::Ref

Defined in:

lib/orchestrate/refs.rb

Overview

A Ref is a specific immutable value that has been assigned to a Key.

Ref is subclassed from KeyValue and as such contains its #save and #update methods. Unless used on the most recent Ref, these will fail with a VersionMismatch error, as the #save and #update methods use Put-If-Match semantics.

Instance Attribute Summary

Attributes inherited from KeyValue

#collection, #collection_name, #id, #key, #last_request_time, #path, #ref, #reftime, #value

Instance Method Summary

• #archival? ⇒ true, false

  Is this a historic ref value? True for Ref objects.

Methods inherited from KeyValue

#<=>, #==, #[], #[]=, #add, #copy, #decrement, #destroy, #destroy!, #events, from_bodyless_response, from_listing, #increment, #initialize, load, #loaded?, #merge, #move, #perform, #purge, #purge!, #refs, #relations, #reload, #remove, #replace, #save, #save!, #set, #set!, #test, #to_s, #tombstone?, #update

Constructor Details

This class inherits a constructor from Orchestrate::KeyValue

Instance Method Details

#archival? ⇒ true, false

Is this a historic ref value? True for Ref objects. Use this instead of #is_a? or #kind_of?.

Returns:

• (true, false)

# File 'lib/orchestrate/refs.rb', line 13

def archival?
  true
end