Class: Mongo::Crypt::KMS::Local::MasterKeyDocument Private

Inherits:

Object

• Object
• Mongo::Crypt::KMS::Local::MasterKeyDocument

Defined in:

lib/mongo/crypt/kms/local/master_document.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Local KMS master key document object contains KMS master key parameters.

Instance Method Summary

• #initialize(_opts) ⇒ MasterKeyDocument constructor private

  Creates a master key document object form a parameters hash.

• #to_document ⇒ BSON::Document private

  Convert master key document object to a BSON document in libmongocrypt format.

Constructor Details

#initialize(_opts) ⇒ MasterKeyDocument

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.

Creates a master key document object form a parameters hash. This empty method is to keep a uniform interface for all KMS providers.

# File 'lib/mongo/crypt/kms/local/master_document.rb', line 29

def initialize(_opts)
end

Instance Method Details

#to_document ⇒ BSON::Document

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.

Convert master key document object to a BSON document in libmongocrypt format.

Returns:

• (BSON::Document) —

  Local KMS credentials in libmongocrypt format.

# File 'lib/mongo/crypt/kms/local/master_document.rb', line 35

def to_document
  BSON::Document.new({ provider: "local" })
end