Class: Couchbase::Management::Options::User::GetUser

Inherits:
Options::Base
  • Object
show all
Defined in:
lib/couchbase/management/user_manager.rb,
/home/runner/work/couchbase-ruby-client/couchbase-ruby-client/lib/couchbase/management/user_manager.rb

Overview

Options for UserManager#get_user

Instance Attribute Summary collapse

Attributes inherited from Options::Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(domain: :local, timeout: nil, retry_strategy: nil, parent_span: nil) {|self| ... } ⇒ GetUser

Creates an instance of options for UserManager#get_user

Parameters:

  • domain (:local, :external) (defaults to: :local) —

    the name of the user’s domain. Defaults to :local

  • timeout (Integer, #in_milliseconds, nil) (defaults to: nil) —

    the time in milliseconds allowed for the operation to complete

  • retry_strategy (Proc, nil) (defaults to: nil) —

    the custom retry strategy, if set

  • parent_span (Span, nil) (defaults to: nil) —

    if set holds the parent span, that should be used for this request

Yield Parameters:



38
39
40
41
42
43
44
45
 
# File 'lib/couchbase/management/user_manager.rb', line 38

def initialize(domain: :local,
               timeout: nil,
               retry_strategy: nil,
               parent_span: nil)
  super(timeout: timeout, retry_strategy: retry_strategy, parent_span: parent_span)
  @domain = domain
  yield self if block_given?
end

Instance Attribute Details

#domain ⇒ :local, :external

Returns Name of the user’s domain. Defaults to :local.

Returns:

  • (:local, :external) —

    Name of the user’s domain. Defaults to :local



29
30
31
 
# File 'lib/couchbase/management/user_manager.rb', line 29

def domain
  @domain
end