Class: Couchbase::Collection::ExistsResult

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/collection_options.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|| ... } ⇒ ExistsResult

Returns a new instance of ExistsResult.

Yield Parameters:



108
109
110
 
# File 'lib/couchbase/collection_options.rb', line 108

def initialize
  yield self if block_given?
end

Instance Attribute Details

#cas ⇒ Integer

Returns holds the CAS value of the fetched document.

Returns:

  • (Integer) —

    holds the CAS value of the fetched document



98
99
100
 
# File 'lib/couchbase/collection_options.rb', line 98

def cas
  @cas
end

#datatype ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns datatype.

Returns:

  • (Integer) —

    datatype



130
131
132
 
# File 'lib/couchbase/collection_options.rb', line 130

def datatype
  @datatype
end

#deleted ⇒ Boolean

Returns true if the document was deleted.

Returns:

  • (Boolean) —

    true if the document was deleted



101
102
103
 
# File 'lib/couchbase/collection_options.rb', line 101

def deleted
  @deleted
end

#exists ⇒ Boolean Also known as: exists?

Returns true if the document exists.

Returns:

  • (Boolean) —

    true if the document exists



104
105
106
 
# File 'lib/couchbase/collection_options.rb', line 104

def exists
  @exists
end

#expiry=(value) ⇒ Integer (writeonly)

Returns the expiration if fetched and present.

Returns:

  • (Integer) —

    the expiration if fetched and present



113
114
115
 
# File 'lib/couchbase/collection_options.rb', line 113

def expiry=(value)
  @expiry = value
end

#flags ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns flags.

Returns:

  • (Integer) —

    flags



122
123
124
 
# File 'lib/couchbase/collection_options.rb', line 122

def flags
  @flags
end

#sequence_number ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns sequence_number.

Returns:

  • (Integer) —

    sequence_number



126
127
128
 
# File 'lib/couchbase/collection_options.rb', line 126

def sequence_number
  @sequence_number
end

Instance Method Details

#expiry_time ⇒ Time

Returns time when the document will expire.

Returns:

  • (Time) —

    time when the document will expire



116
117
118
 
# File 'lib/couchbase/collection_options.rb', line 116

def expiry_time
  Time.at(@expiry) if @expiry
end