Class: OCI::Vault::Models::PassphraseGenerationContext

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

Overview

Generates Passphrase type secrets. By default, passphrase type secrets have no structure. The generated content is stored in Base64 format. The SecretTemplate must have the %GENERATED_PASSPHRASE% keyword, which is later replaced with the generated content, if provided.

Constant Summary collapse

GENERATION_TEMPLATE_ENUM = 
[
  GENERATION_TEMPLATE_SECRETS_DEFAULT_PASSWORD = 'SECRETS_DEFAULT_PASSWORD'.freeze,
  GENERATION_TEMPLATE_DBAAS_DEFAULT_PASSWORD = 'DBAAS_DEFAULT_PASSWORD'.freeze,
  GENERATION_TEMPLATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from SecretGenerationContext

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 = {}) ⇒ PassphraseGenerationContext

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/vault/models/passphrase_generation_context.rb', line 62

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

  attributes['generationType'] = 'PASSPHRASE'

  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']

  self.passphrase_length = attributes[:'passphraseLength'] if attributes[:'passphraseLength']

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

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

Instance Attribute Details

#generation_template ⇒ String

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/vault/models/passphrase_generation_context.rb', line 23

def generation_template
  @generation_template
end

#passphrase_length ⇒ Integer

Length of the passphrase to be generated

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/oci/vault/models/passphrase_generation_context.rb', line 27

def passphrase_length
  @passphrase_length
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/oci/vault/models/passphrase_generation_context.rb', line 30

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

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/vault/models/passphrase_generation_context.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'generation_type': :'String',
    'secret_template': :'String',
    'generation_template': :'String',
    'passphrase_length': :'Integer'
    # 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



105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/vault/models/passphrase_generation_context.rb', line 105

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 &&
    passphrase_length == other.passphrase_length
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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/vault/models/passphrase_generation_context.rb', line 138

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


118
119
120
 
# File 'lib/oci/vault/models/passphrase_generation_context.rb', line 118

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



127
128
129
 
# File 'lib/oci/vault/models/passphrase_generation_context.rb', line 127

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/vault/models/passphrase_generation_context.rb', line 171

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



165
166
167
 
# File 'lib/oci/vault/models/passphrase_generation_context.rb', line 165

def to_s
  to_hash.to_s
end