Class: Akeyless::EsmUpdate

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/esm_update.rb

Overview

esmUpdate is a command that updates a secret in an External Secrets Manager

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EsmUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/akeyless/models/esm_update.rb', line 89

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::EsmUpdate` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::EsmUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'binary_value')
    self.binary_value = attributes[:'binary_value']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'esm_name')
    self.esm_name = attributes[:'esm_name']
  else
    self.esm_name = nil
  end

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

  if attributes.key?(:'secret_id')
    self.secret_id = attributes[:'secret_id']
  else
    self.secret_id = nil
  end

  if attributes.key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Hash)
      self.tags = value
    end
  end

  if attributes.key?(:'token')
    self.token = attributes[:'token']
  end

  if attributes.key?(:'uid_token')
    self.uid_token = attributes[:'uid_token']
  end

  if attributes.key?(:'value')
    self.value = attributes[:'value']
  else
    self.value = nil
  end
end

Instance Attribute Details

#binary_value ⇒ Object

Use this option if the external secret value is a base64 encoded binary



20
21
22
 
# File 'lib/akeyless/models/esm_update.rb', line 20

def binary_value
  @binary_value
end

#description ⇒ Object

Description of the external secret



23
24
25
 
# File 'lib/akeyless/models/esm_update.rb', line 23

def description
  @description
end

#esm_name ⇒ Object

Name of the External Secrets Manager item



26
27
28
 
# File 'lib/akeyless/models/esm_update.rb', line 26

def esm_name
  @esm_name
end

#json ⇒ Object

Set output format to JSON



29
30
31
 
# File 'lib/akeyless/models/esm_update.rb', line 29

def json
  @json
end

#secret_id ⇒ Object

The external secret id (or name, for AWS, Azure or K8s targets) to update



32
33
34
 
# File 'lib/akeyless/models/esm_update.rb', line 32

def secret_id
  @secret_id
end

#tags ⇒ Object

Tags for the external secret



35
36
37
 
# File 'lib/akeyless/models/esm_update.rb', line 35

def tags
  @tags
end

#token ⇒ Object

Authentication token (see ‘/auth` and `/configure`)



38
39
40
 
# File 'lib/akeyless/models/esm_update.rb', line 38

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



41
42
43
 
# File 'lib/akeyless/models/esm_update.rb', line 41

def uid_token
  @uid_token
end

#value ⇒ Object

Value of the external secret item, either text or base64 encoded binary



44
45
46
 
# File 'lib/akeyless/models/esm_update.rb', line 44

def value
  @value
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/akeyless/models/esm_update.rb', line 234

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



62
63
64
 
# File 'lib/akeyless/models/esm_update.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/akeyless/models/esm_update.rb', line 47

def self.attribute_map
  {
    :'binary_value' => :'binary-value',
    :'description' => :'description',
    :'esm_name' => :'esm-name',
    :'json' => :'json',
    :'secret_id' => :'secret-id',
    :'tags' => :'tags',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'value' => :'value'
  }
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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/akeyless/models/esm_update.rb', line 210

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/akeyless/models/esm_update.rb', line 82

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/akeyless/models/esm_update.rb', line 67

def self.openapi_types
  {
    :'binary_value' => :'Boolean',
    :'description' => :'String',
    :'esm_name' => :'String',
    :'json' => :'Boolean',
    :'secret_id' => :'String',
    :'tags' => :'Hash<String, String>',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/akeyless/models/esm_update.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      binary_value == o.binary_value &&
      description == o.description &&
      esm_name == o.esm_name &&
      json == o.json &&
      secret_id == o.secret_id &&
      tags == o.tags &&
      token == o.token &&
      uid_token == o.uid_token &&
      value == o.value
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/akeyless/models/esm_update.rb', line 305

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


197
198
199
 
# File 'lib/akeyless/models/esm_update.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



203
204
205
 
# File 'lib/akeyless/models/esm_update.rb', line 203

def hash
  [binary_value, description, esm_name, json, secret_id, tags, token, uid_token, value].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/akeyless/models/esm_update.rb', line 151

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @esm_name.nil?
    invalid_properties.push('invalid value for "esm_name", esm_name cannot be nil.')
  end

  if @secret_id.nil?
    invalid_properties.push('invalid value for "secret_id", secret_id cannot be nil.')
  end

  if @value.nil?
    invalid_properties.push('invalid value for "value", value cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



281
282
283
 
# File 'lib/akeyless/models/esm_update.rb', line 281

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/akeyless/models/esm_update.rb', line 287

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



275
276
277
 
# File 'lib/akeyless/models/esm_update.rb', line 275

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



171
172
173
174
175
176
177
 
# File 'lib/akeyless/models/esm_update.rb', line 171

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @esm_name.nil?
  return false if @secret_id.nil?
  return false if @value.nil?
  true
end