Class: Mongo::Crypt::KMS::KMIP::Credentials Private

Do not use. This class is for internal use only.

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, Forwardable
Instance Chain: self, `::Mongo::Crypt::KMS::Validations`
Inherits:	Object
Defined in:	lib/mongo/crypt/kms/kmip/credentials.rb

Overview

::Mongo::Crypt::KMS::KMIP KMS Credentials object contains credentials for a remote ::Mongo::Crypt::KMS::KMIP KMS provider.

"KMIP KMS provider options must be in the format: " +
"{ endpoint: 'ENDPOINT' }"

.new(opts) ⇒ Credentials constructor Internal use only

Creates a ::Mongo::Crypt::KMS::KMIP KMS credentials object form a parameters hash.

#to_document ⇒ BSON::Document Internal use only

Convert credentials object to a BSON document in libmongocrypt format.

#validate_param	Validate if a `::Mongo::Crypt::KMS` parameter is valid.
#validate_tls_options	Validate KMS TLS options.

Returns:

[ GitHub ]

# File 'lib/mongo/crypt/kms/kmip/credentials.rb', line 31


attr_reader :endpoint

Convert credentials object to a BSON document in libmongocrypt format.

Returns:

(BSON::Document) —

::Mongo::Crypt::KMS::Local KMS credentials in libmongocrypt format.

[ GitHub ]

# File 'lib/mongo/crypt/kms/kmip/credentials.rb', line 57


def to_document
  return BSON::Document.new({}) if empty?
  BSON::Document.new({
    endpoint: endpoint,
  })
end