Credentials — Documentation by YARD 0.9.37 (original) (raw)

Class: Mongo::Crypt::KMS::Local::CredentialsPrivate

Inherits:

Object

• Object
• Mongo::Crypt::KMS::Local::Credentials show all

Extended by:

Forwardable

Includes:

Validations

Defined in:

lib/mongo/crypt/kms/local/credentials.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 Credentials object contains credentials for using local KMS provider.

Constant Summarycollapse

FORMAT_HINT =

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

"Local KMS provider options must be in the format: " + "{ key: 'MASTER-KEY' }"

Instance Attribute Summary collapse

• #key ⇒ String readonly private
  Master key.

Instance Method Summarycollapse

• #initialize(opts) ⇒ Credentials constructor private
  Creates a local KMS credentials object form a parameters hash.
• #to_document ⇒ BSON::Document private
  Local KMS credentials in libmongocrypt format.

Methods included from Validations

#validate_param, validate_tls_options

Constructor Details

#initialize(opts) ⇒ Credentials

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 local KMS credentials object form a parameters hash.

Instance Attribute Details

#key ⇒ String

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.

Returns Master key.

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.

Returns Local KMS credentials in libmongocrypt format.