Class: OCI::Vault::Models::UpdateSecretDetails

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

Overview

Details for updating a secret.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateSecretDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 113

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.current_version_number = attributes[:'currentVersionNumber'] if attributes[:'currentVersionNumber']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

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

  self.secret_content = attributes[:'secretContent'] if attributes[:'secretContent']

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

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

  self.rotation_config = attributes[:'rotationConfig'] if attributes[:'rotationConfig']

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

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

  self.secret_rules = attributes[:'secretRules'] if attributes[:'secretRules']

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

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

  self.secret_generation_context = attributes[:'secretGenerationContext'] if attributes[:'secretGenerationContext']

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

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

  self.enable_auto_generation = attributes[:'enableAutoGeneration'] unless attributes[:'enableAutoGeneration'].nil?

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

  self.enable_auto_generation = attributes[:'enable_auto_generation'] unless attributes[:'enable_auto_generation'].nil?
end

Instance Attribute Details

#current_version_number ⇒ Integer

Details to update the secret version of the specified secret. The secret contents, version number, and rules can't be specified at the same time. Updating the secret contents automatically creates a new secret version.

Returns:

  • (Integer) 


16
17
18
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 16

def current_version_number
  @current_version_number
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def defined_tags
  @defined_tags
end

#description ⇒ String

A brief description of the secret. Avoid entering confidential information.

Returns:

  • (String) 


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

def description
  @description
end

#enable_auto_generation ⇒ BOOLEAN

The value of this flag determines whether or not secret content will be generated automatically.

Returns:

  • (BOOLEAN) 


59
60
61
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 59

def enable_auto_generation
  @enable_auto_generation
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


34
35
36
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 34

def freeform_tags
  @freeform_tags
end

#metadata ⇒ Hash<String, Object>

Additional metadata that you can use to provide context about how to use the secret or during rotation or other administrative tasks. For example, for a secret that you use to connect to a database, the additional metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.

Returns:

  • (Hash<String, Object>) 


41
42
43
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 41

def metadata
  @metadata
end

#rotation_config ⇒ OCI::Vault::Models::RotationConfig

Returns:



47
48
49
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 47

def rotation_config
  @rotation_config
end

#secret_content ⇒ OCI::Vault::Models::SecretContentDetails

Returns:



44
45
46
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 44

def secret_content
  @secret_content
end

#secret_generation_context ⇒ OCI::Vault::Models::SecretGenerationContext

Returns:



54
55
56
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 54

def secret_generation_context
  @secret_generation_context
end

#secret_rules ⇒ Array<OCI::Vault::Models::SecretRule>

A list of rules to control how the secret is used and managed.

Returns:



51
52
53
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 51

def secret_rules
  @secret_rules
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'current_version_number': :'currentVersionNumber',
    'defined_tags': :'definedTags',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'metadata': :'metadata',
    'secret_content': :'secretContent',
    'rotation_config': :'rotationConfig',
    'secret_rules': :'secretRules',
    'secret_generation_context': :'secretGenerationContext',
    'enable_auto_generation': :'enableAutoGeneration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 80

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'current_version_number': :'Integer',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'metadata': :'Hash<String, Object>',
    'secret_content': :'OCI::Vault::Models::SecretContentDetails',
    'rotation_config': :'OCI::Vault::Models::RotationConfig',
    'secret_rules': :'Array<OCI::Vault::Models::SecretRule>',
    'secret_generation_context': :'OCI::Vault::Models::SecretGenerationContext',
    'enable_auto_generation': :'BOOLEAN'
    # 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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 179

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

  self.class == other.class &&
    current_version_number == other.current_version_number &&
    defined_tags == other.defined_tags &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    metadata == other.metadata &&
    secret_content == other.secret_content &&
    rotation_config == other.rotation_config &&
    secret_rules == other.secret_rules &&
    secret_generation_context == other.secret_generation_context &&
    enable_auto_generation == other.enable_auto_generation
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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 218

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


198
199
200
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 198

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 207

def hash
  [current_version_number, defined_tags, description, freeform_tags, metadata, secret_content, rotation_config, secret_rules, secret_generation_context, enable_auto_generation].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 251

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



245
246
247
 
# File 'lib/oci/vault/models/update_secret_details.rb', line 245

def to_s
  to_hash.to_s
end