Class: OCI::Vault::Models::SecretGenerationContext

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vault/models/secret_generation_context.rb

Overview

Captures a configurable set of secret generation rules such as length, base characters, additional characters, and so on. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

GENERATION_TYPE_ENUM = 
[
  GENERATION_TYPE_PASSPHRASE = 'PASSPHRASE'.freeze,
  GENERATION_TYPE_SSH_KEY = 'SSH_KEY'.freeze,
  GENERATION_TYPE_BYTES = 'BYTES'.freeze,
  GENERATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecretGenerationContext

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :generation_type (String) —

    The value to assign to the #generation_type property

  • :secret_template (String) —

    The value to assign to the #secret_template property



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/vault/models/secret_generation_context.rb', line 76

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

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

  self.generation_type = attributes[:'generationType'] if attributes[:'generationType']

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

  self.generation_type = attributes[:'generation_type'] if attributes[:'generation_type']

  self.secret_template = attributes[:'secretTemplate'] if attributes[:'secretTemplate']

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

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

Instance Attribute Details

#generation_type ⇒ String

[Required] Name of the predefined secret generation type.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/vault/models/secret_generation_context.rb', line 22

def generation_type
  @generation_type
end

#secret_template ⇒ String

SecretTemplate captures structure in which customer wants to store secrets. This is optional and a default structure is available for each secret type. The template can have any structure with static values that are not generated. Within the template, you can insert predefined placeholders to store secrets. These placeholders are later replaced with the generated content and saved as a Base64 encoded content.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/vault/models/secret_generation_context.rb', line 29

def secret_template
  @secret_template
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/vault/models/secret_generation_context.rb', line 56

def self.get_subtype(object_hash)
  type = object_hash[:'generationType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Vault::Models::PassphraseGenerationContext' if type == 'PASSPHRASE'
  return 'OCI::Vault::Models::SshKeyGenerationContext' if type == 'SSH_KEY'
  return 'OCI::Vault::Models::BytesGenerationContext' if type == 'BYTES'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Vault::Models::SecretGenerationContext'
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



115
116
117
118
119
120
121
 
# File 'lib/oci/vault/models/secret_generation_context.rb', line 115

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

  self.class == other.class &&
    generation_type == other.generation_type &&
    secret_template == other.secret_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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/vault/models/secret_generation_context.rb', line 146

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


126
127
128
 
# File 'lib/oci/vault/models/secret_generation_context.rb', line 126

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



135
136
137
 
# File 'lib/oci/vault/models/secret_generation_context.rb', line 135

def hash
  [generation_type, secret_template].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/vault/models/secret_generation_context.rb', line 179

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



173
174
175
 
# File 'lib/oci/vault/models/secret_generation_context.rb', line 173

def to_s
  to_hash.to_s
end