Class: Couchbase::Collection::SubDocumentField Private

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

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.

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:



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

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:

  • (CouchbaseError) —

    error



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

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:

  • (Boolean) —

    true if the path exists in the document



301
302
303
 
# File 'lib/couchbase/collection_options.rb', line 301

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:

  • (Integer) —

    index



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

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:

  • (String) —

    path



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

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:

  • (String) —

    value



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

def value
  @value
end