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):



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/oci/vault/models/update_secret_details.rb', line 92

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. = 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.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']
end

Instance Attribute Details

#current_version_numberInteger

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)


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

def current_version_number
  @current_version_number
end

#defined_tagsHash<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>>)


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

def defined_tags
  @defined_tags
end

#descriptionString

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

Returns:

  • (String)


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

def description
  @description
end

#freeform_tagsHash<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>)


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

def freeform_tags
  @freeform_tags
end

#metadataHash<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>)


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

def 
  @metadata
end

#secret_contentOCI::Vault::Models::SecretContentDetails



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

def secret_content
  @secret_content
end

#secret_rulesArray<OCI::Vault::Models::SecretRule>

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

Returns:



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

def secret_rules
  @secret_rules
end

Class Method Details

.attribute_mapObject

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



50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/oci/vault/models/update_secret_details.rb', line 50

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',
    'secret_rules': :'secretRules'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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',
    'secret_rules': :'Array<OCI::Vault::Models::SecretRule>'
    # 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



140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/oci/vault/models/update_secret_details.rb', line 140

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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# File 'lib/oci/vault/models/update_secret_details.rb', line 176

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


156
157
158
# File 'lib/oci/vault/models/update_secret_details.rb', line 156

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



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

def hash
  [current_version_number, defined_tags, description, freeform_tags, , secret_content, secret_rules].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



209
210
211
212
213
214
215
216
217
218
# File 'lib/oci/vault/models/update_secret_details.rb', line 209

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



203
204
205
# File 'lib/oci/vault/models/update_secret_details.rb', line 203

def to_s
  to_hash.to_s
end