Class: Couchbase::Management::UpdateCollectionSettings

Inherits:

Object

• Object
• Couchbase::Management::UpdateCollectionSettings

Defined in:

lib/couchbase/management/collection_manager.rb

Constant Summary

DEFAULT =

UpdateCollectionSettings.new.freeze

Instance Attribute Summary

• #history ⇒ Boolean^?

  not update it).

• #max_expiry ⇒ Integer^?

  (set to nil to not update it, and to -1 set it to no-expiry).

Instance Method Summary

• #initialize(max_expiry: nil, history: nil) {|_self| ... } ⇒ UpdateCollectionSettings constructor

  A new instance of UpdateCollectionSettings.

• #to_backend ⇒ Object private

Constructor Details

#initialize(max_expiry: nil, history: nil) {|_self| ... } ⇒ UpdateCollectionSettings

Returns a new instance of UpdateCollectionSettings.

Yields:

• (_self)

Yield Parameters:

• _self (Couchbase::Management::UpdateCollectionSettings) —

  the object that the method was called on

# File 'lib/couchbase/management/collection_manager.rb', line 422

def initialize(max_expiry: nil, history: nil)
  @max_expiry = max_expiry
  @history = history

  yield self if block_given?
end

Instance Attribute Details

#history ⇒ Boolean^?

not update it)

Returns:

• (Boolean, nil) —

  whether history retention override should be enabled in the collection (set to nil to

# File 'lib/couchbase/management/collection_manager.rb', line 420

def history
  @history
end

#max_expiry ⇒ Integer^?

(set to nil to not update it, and to -1 set it to no-expiry)

Returns:

• (Integer, nil) —

  time in seconds of the maximum expiration time for new documents in the collection

# File 'lib/couchbase/management/collection_manager.rb', line 416

def max_expiry
  @max_expiry
end

Instance Method Details

#to_backend ⇒ Object

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.

# File 'lib/couchbase/management/collection_manager.rb', line 430

def to_backend
  {
    max_expiry: @max_expiry,
    history: @history,
  }
end