クラス: Mongo::Crypt::KMS::KMIP::Credentials Private

継承:
オブジェクト
  • オブジェクト
すべて表示
次による拡張機能。
転送可能
次のことが含まれます。
検証
定義:
build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /kip/credentials.rb

Overview

このクラスは、プライベート API の一部です。 このクラスは将来削除または変更される可能性があるため、可能な限り使用しないでください。

KMIP KMS 認証情報オブジェクトには、リモート KMIP KMS プロバイダーの認証情報が含まれています。

定数の概要の削減

FORMAT_HINT =

この定数は、プライベート API の一部です。 この定数は将来削除または変更される可能性があるため、可能な限り使用しないでください。

" KMIP KMS プロバイダー オプションは次の形式である必要があります: " +
{ endpoint: 'ENDPOINT' }

インスタンス属性の概要を折りたたむ

インスタンス メソッドの概要を折りたたむ

検証に含まれるメソッド

#validate_param, validate_tls_options

コンストラクターの詳細

#初期化(opts) =認証情報

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

パラメーター ハッシュの形式で KMIP KMS 認証情報オブジェクトを作成します。

パラメーター:

  • ops ハッシュ

    KMIP KMS プロバイダーの認証情報を含むハッシュです。

オプション ハッシュ( opts ):

  • : エンドポイント string

    KMIP エンドポイント。

次の値が発生します。

  • (ArgumentError)

    必須 オプションが欠落しているか、形式が正しくない場合。



47
48
49
50
51
52
# ファイル 'Build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /kip/credentials.rb', 行47

デフォルト 初期化(ops)
  @opts = ops
  ただし、 空の場合
    @endpoint = validate_param(: エンドポイント, ops, FORMAT_HINT)
  end
end

インスタンス属性の詳細

#エンドポイント= string (読み取り専用)

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

任意のポートを持つ KMIP KMS エンドポイントを返します。

次の値を返します。

  • ( string )

    任意のポートを持つ KMIP KMS エンドポイント。



31
32
33
# ファイル 'Build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /kip/credentials.rb', 行31

デフォルト エンドポイント
  @endpoint
end

インスタンス メソッドの詳細

#to_documentBSON::Document

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

認証情報オブジェクトを libmongocrypt 形式の BSON ドキュメントに変換します。

次の値を返します。

  • BSON::Document

    libmongocrypt 形式のローカル KMS 認証情報。



57
58
59
60
61
62
# ファイル 'Build/ruby-Driver-v2.19/lib/ mongo /crypt/ KMS /kip/credentials.rb', 行57

デフォルト to_document
  return BSON::ドキュメント.新着情報({}) 場合 空の場合
  BSON::ドキュメント.新着情報({
    エンドポイント: エンドポイント,
  })
end