Classe: Mongo::Crypt::KMS::KMIP::Credentials Private

Herda:
Objeto
  • Objeto
mostrar tudo
Estendido por:
Encaminhável
Inclui:
Validações
Definido em:
build/ruby-driver-v2.19/lib/mongo/crypt/KMS/kmip/credentials.rb

Visão geral

Esta classe faz parte de uma API privada. Evite usar essa classe, se possível, pois ela pode ser removida ou alterada no futuro.

O objeto Credenciais KMIP KMS contém credenciais de um provedor KMIP KMS remoto.

Colapsode resumo constante

FORMAT_HINT =

Essa constante faz parte de uma API privada. Você deve evitar usar essa constante, se possível, pois ela pode ser removida ou alterada no futuro.

"As opções do provedor KMIP KMS devem estar no formato: " +
"{ endpoint: 'ENDPOINT' }"

Recolhimento do Resumo do atributo de instância

Recolhimento do Resumo do método de instância

Métodos incluídos nas Validações

#validate_param, validate_tls_options

Detalhes do construtor

#initialize(opts) ➤ Credenciais

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Cria um objeto de credenciais KMIP KMS de um hash de parâmetros.

Parâmetros:

  • opciona (Hash)

    Um hash que contém credenciais do provedor KMIP KMS.

Hash de opções (opts):

  • :endpoint (string)

    Ponto de conexão KMIP.

Aumenta:

  • (ArgumentError)

    Se as opções necessárias estiverem ausentes ou formatadas incorretamente.



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

def inicializar(opciona)
  @opts = opciona
  a menos que vazio?
    @endpoint = validate_param(:endpoint, opciona, FORMAT_HINT)
  end
end

Detalhes do atributo da instância

#endpointstring (somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Retorna o endpoint KMIP KMS com porta opcional.

Retorna:

  • (string)

    Endpoint KMIP KMS com porta opcional.



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

def endpoint
  @endpoint
end

Detalhes do método de instância

#to_document ➤ BSON::Document

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Converta o objeto de credenciais em um documento BSON no formato libmongocrypt.

Retorna:

  • (BSON::Document)

    Credenciais KMS locais no formato libmongocrypt.



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

def to_document
  Método BSON::Documento.Novo({}) se vazio?
  BSON::Documento.Novo({
    ponto de conexão: endpoint,
  })
end