Class: Couchbase::Collection::SubDocumentField Private

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

Overview

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

API:

  • private

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|self| ... } ⇒ SubDocumentField

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 a new instance of SubDocumentField.

Yield Parameters:

API:

  • private



318
319
320
 
# File 'lib/couchbase/collection_options.rb', line 318

def initialize
  yield self if block_given?
end

Instance Attribute Details

#error ⇒ CouchbaseError

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 error.

Returns:

  • error

API:

  • private



315
316
317
 
# File 'lib/couchbase/collection_options.rb', line 315

def error
  @error
end

#exists ⇒ Boolean

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 true if the path exists in the document.

Returns:

  • true if the path exists in the document

API:

  • private



303
304
305
 
# File 'lib/couchbase/collection_options.rb', line 303

def exists
  @exists
end

#index ⇒ 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 index.

Returns:

  • index

API:

  • private



309
310
311
 
# File 'lib/couchbase/collection_options.rb', line 309

def index
  @index
end

#path ⇒ String

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 path.

Returns:

  • path

API:

  • private



312
313
314
 
# File 'lib/couchbase/collection_options.rb', line 312

def path
  @path
end

#value ⇒ String

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 value.

Returns:

  • value

API:

  • private



306
307
308
 
# File 'lib/couchbase/collection_options.rb', line 306

def value
  @value
end