类：Mongo::Crypt:: KMS::KMIP::Credentials Private

继承：
对象
  • 对象
显示全部
扩展方式：
可转发
包括：
验证
定义于：
构建/ruby-driver-v2.19/lib/ mongo /crypt/ KMS /kmip/ 凭证.rb

Overview

此类是私有 API 的一部分。 应尽可能避免使用此类，因为它将来可能会被删除或更改。

KMIP KMS凭证对象包含远程 KMIP KMS提供商的凭证。

常量摘要折叠

FORMAT_HINT =

此常量是私有 API 的一部分。 应尽可能避免使用此常量，因为它将来可能会被删除或更改。 

" KMIP KMS提供商选项必须采用以下格式： " +
"{ endpoint: 'ENDPOINT' }"

实例属性摘要折叠

实例方法摘要折叠

验证中包含的方法

#validate_param , validate_tls_options

构造函数详情

#initialize (opts) ⇒档案

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

从参数哈希中创建 KMIP KMS凭证对象。

参数：

  • opts (哈希) —

    包含 KMIP KMS提供商凭证的哈希值。

选项哈希 ( opts )：

  • :endpoint （ string ） —

    KMIP 端点。

引发：

  • ( ArgumentError ) —

    如果必需的选项丢失或格式不正确。



47
48
49
50
51
52
 
# File 'build/Ruby-driver-v2.19/lib/ mongo /crypt/ KMS /kmip/credentials.rb', 第47行

def 初始化(opts)
  @opts = opts
  除非 空？
    @endpoint = validate_param(:endpoint, opts, FORMAT_HINT)
  end
end

实例属性详细信息

#端点⇒ string （只读）

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

返回带有可选端口的 KMIP KMS端点。

返回：

  • ( string ) —

    带有可选端口的 KMIP KMS端点。



31
32
33
 
# File 'build/Ruby-driver-v2.19/lib/ mongo /crypt/ KMS /kmip/credentials.rb', 第31行

def 端点
  @endpoint
end

实例方法详细信息

# to_document ⇒ BSON::Document

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

将凭证对象转换为 libmongocrypt 格式的BSON文档。

返回：

  • ( BSON::Document ) —

    凭证格式的本地KMS档案。



57
58
59
60
61
62
 
# File 'build/Ruby-driver-v2.19/lib/ mongo /crypt/ KMS /kmip/credentials.rb', 第57行

def to_document
  return BSON::文档.new({}) if 空？
  BSON::文档.new({
    端点： 端点,
  })
end