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:

  • name (String) —

    the name of this link

  • dataverse (String) —

    the dataverse this link belongs to

  • hostname (String) —

    the hostname of the target Couchbase cluster

  • username (String, nil) (defaults to: nil) —

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

  • password (String, nil) (defaults to: nil) —

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

  • encryption (EncryptionSettings) (defaults to: EncryptionSettings.new) —

    settings for connection encryption

Yield Parameters:

  • self (CouchbaseRemoteLink) 


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

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:

  • (String) 


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

def dataverse
  @dataverse
end

#encryption ⇒ EncryptionSettings

Returns:



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

def encryption
  @encryption
end

#hostname ⇒ String

Returns:

  • (String) 


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

def hostname
  @hostname
end

#name ⇒ String

Returns:

  • (String) 


978
979
980
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 978

def name
  @name
end

#password ⇒ String?

Returns:

  • (String, nil) 


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

def password
  @password
end

#username ⇒ String?

Returns:

  • (String, nil) 


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

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. 



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

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