123456789_123456789_123456789_123456789_123456789_

Class: Mongo::Crypt::KMS::GCP::MasterKeyDocument Private

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, ::Mongo::Crypt::KMS::Validations
Inherits: Object
Defined in: lib/mongo/crypt/kms/gcp/master_document.rb

Overview

::Mongo::Crypt::KMS::GCP KMS master key document object contains ::Mongo::Crypt::KMS master key parameters.

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

::Mongo::Crypt::KMS::Validations - Included

#validate_param

Validate if a ::Mongo::Crypt::KMS parameter is valid.
#validate_tls_options

Validate KMS TLS options.

Instance Attribute Details

#endpoint ⇒ String | nil (readonly)

Returns:

[ GitHub ] 

  


# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 43



attr_reader :endpoint


  








  

    #key_name  ⇒ String  (readonly)
  



  

    
  





  
Returns:





  [ GitHub ]


  

  


# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 37



attr_reader :key_name


  








  

    #key_ring  ⇒ String  (readonly)
  



  

    
  





  
Returns:





  [ GitHub ]


  

  


# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 34



attr_reader :key_ring


  








  

    #key_version  ⇒ String | nil  (readonly)
  



  

    
  





  
Returns:





  [ GitHub ]


  

  


# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 40



attr_reader :key_version


  








  

    #location  ⇒ String  (readonly)
  



  

    
  





  
Returns:





  [ GitHub ]


  

  


# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 31



attr_reader :location


  








  

    #project_id  ⇒ String  (readonly)
  



  

    
  





  
Returns:





  [ GitHub ]


  

  


# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 28



attr_reader :project_id


  







Instance Method Details



  

    #to_document  ⇒ BSON::Document 
  



  

    
Convert master key document object to a BSON document in libmongocrypt format.

  





  
Returns:





  [ GitHub ]


  

  


# File 'lib/mongo/crypt/kms/gcp/master_document.rb', line 77



def to_document
  return BSON::Document.new({}) if @empty

  BSON::Document.new({
                       provider: 'gcp',
                       projectId: project_id,
                       location: location,
                       keyRing: key_ring,
                       keyName: key_name
                     }).tap do |bson|
    bson.update({ keyVersion: key_version }) unless key_version.nil?
    bson.update({ endpoint: endpoint }) unless endpoint.nil?
  end
end