Class: OCI::Vault::Models::SshKeyGenerationContext

Inherits:
SecretGenerationContext show all
Defined in:
lib/oci/vault/models/ssh_key_generation_context.rb

Overview

Generates ssh keys. By default, the keys are stored as - "%GENERATED_PUBLIC_KEY%", "privateKey": "%GENERATED_PRIVATE_KEY%" in PEM format. The SecretTemplate must have both %GENERATED_PUBLIC_KEY% and %GENERATED_PRIVATE_KEY% keywords which is later replaced with the respective keys, if provided.

Constant Summary collapse

GENERATION_TEMPLATE_ENUM = 
[
  GENERATION_TEMPLATE_RSA_2048 = 'RSA_2048'.freeze,
  GENERATION_TEMPLATE_RSA_3072 = 'RSA_3072'.freeze,
  GENERATION_TEMPLATE_RSA_4096 = 'RSA_4096'.freeze,
  GENERATION_TEMPLATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from SecretGenerationContext

OCI::Vault::Models::SecretGenerationContext::GENERATION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from SecretGenerationContext

#generation_type, #secret_template

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SecretGenerationContext

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ SshKeyGenerationContext

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/vault/models/ssh_key_generation_context.rb', line 56

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['generationType'] = 'SSH_KEY'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.generation_template = attributes[:'generationTemplate'] if attributes[:'generationTemplate']

  raise 'You cannot provide both :generationTemplate and :generation_template' if attributes.key?(:'generationTemplate') && attributes.key?(:'generation_template')

  self.generation_template = attributes[:'generation_template'] if attributes[:'generation_template']
end

Instance Attribute Details

#generation_template ⇒ String

[Required] Name of SSH key generation template to generate SSH key type secret.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/vault/models/ssh_key_generation_context.rb', line 24

def generation_template
  @generation_template
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



27
28
29
30
31
32
33
34
35
 
# File 'lib/oci/vault/models/ssh_key_generation_context.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'generation_type': :'generationType',
    'secret_template': :'secretTemplate',
    'generation_template': :'generationTemplate'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/vault/models/ssh_key_generation_context.rb', line 38

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'generation_type': :'String',
    'secret_template': :'String',
    'generation_template': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



93
94
95
96
97
98
99
100
 
# File 'lib/oci/vault/models/ssh_key_generation_context.rb', line 93

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    generation_type == other.generation_type &&
    secret_template == other.secret_template &&
    generation_template == other.generation_template
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/vault/models/ssh_key_generation_context.rb', line 125

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


105
106
107
 
# File 'lib/oci/vault/models/ssh_key_generation_context.rb', line 105

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



114
115
116
 
# File 'lib/oci/vault/models/ssh_key_generation_context.rb', line 114

def hash
  [generation_type, secret_template, generation_template].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/vault/models/ssh_key_generation_context.rb', line 158

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



152
153
154
 
# File 'lib/oci/vault/models/ssh_key_generation_context.rb', line 152

def to_s
  to_hash.to_s
end