Class: Couchbase::Management::CouchbaseRemoteAnalyticsLink

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, dataverse, hostname, username: nil, password: nil, encryption: EncryptionSettings.new) {|self| ... } ⇒ CouchbaseRemoteAnalyticsLink

Returns a new instance of CouchbaseRemoteAnalyticsLink.

Parameters:

  • the name of this link

  • the dataverse this link belongs to

  • the hostname of the target Couchbase cluster

  • (defaults to: nil)

    the username to use for authentication with the remote cluster. Optional if client-certificate authentication is being used.

  • (defaults to: nil)

    the password to use for authentication with the remote cluster. Optional if client-certificate authentication is being used.

  • (defaults to: EncryptionSettings.new)

    settings for connection encryption

Yield Parameters:

  • self (CouchbaseRemoteLink) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 997

def initialize(name, dataverse, hostname,
               username: nil,
               password: nil,
               encryption: EncryptionSettings.new)
  @name = name
  @dataverse = dataverse
  @hostname = hostname
  @username = username
  @password = password
  @encryption = encryption
  yield self if block_given?
end

Instance Attribute Details

#dataverse ⇒ String

Returns:



981
982
983
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 981

def dataverse
  @dataverse
end

#encryption ⇒ EncryptionSettings

Returns:



985
986
987
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 985

def encryption
  @encryption
end

#hostname ⇒ String

Returns:



982
983
984
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 982

def hostname
  @hostname
end

#name ⇒ String

Returns:



980
981
982
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 980

def name
  @name
end

#password ⇒ String?

Returns:



984
985
986
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 984

def password
  @password
end

#username ⇒ String?

Returns:



983
984
985
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 983

def username
  @username
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.

API:

  • private



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 1011

def to_backend
  {
    type: :couchbase,
    link_name: @name,
    dataverse: @dataverse,
    hostname: @hostname,
    username: @username,
    password: @password,
    encryption_level: @encryption.level,
    certificate: @encryption.certificate,
    client_certificate: @encryption.client_certificate,
    client_key: @encryption.client_key,
  }
end