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

Class: Mongo::Crypt::KMS::KMIP::CredentialsPrivate

Inherits:

Object

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

Extended by:

Forwardable

Includes:

Validations

Defined in:

lib/mongo/crypt/kms/kmip/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.

KMIP KMS Credentials object contains credentials for a remote KMIP 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.

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

Instance Attribute Summary collapse

• #endpoint ⇒ String readonly private
  KMIP KMS endpoint with optional port.

Instance Method Summarycollapse

• #initialize(opts) ⇒ Credentials constructor private
  Creates a KMIP KMS credentials object form a parameters hash.
• #to_document ⇒ BSON::Document private
  Convert credentials object to a BSON document 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 KMIP KMS credentials object form a parameters hash.

Instance Attribute Details

#endpoint ⇒ 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 KMIP KMS endpoint with optional port.

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 credentials object to a BSON document in libmongocrypt format.