Class: Akeyless::CreateUSC

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

Overview

CreateUSC is a command that creates a Universal Secrets Connector

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateUSC

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/akeyless/models/create_usc.rb', line 104

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::CreateUSC` 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::CreateUSC`. 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?(:'azure_kv_name')
    self.azure_kv_name = attributes[:'azure_kv_name']
  end

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

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

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

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

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

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

  if attributes.key?(:'target_to_associate')
    self.target_to_associate = attributes[:'target_to_associate']
  else
    self.target_to_associate = nil
  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?(:'usc_prefix')
    self.usc_prefix = attributes[:'usc_prefix']
  end

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

Instance Attribute Details

#azure_kv_name ⇒ Object

Azure Key Vault name (Relevant only for Azure targets)


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

def azure_kv_name
  @azure_kv_name
end

#delete_protection ⇒ Object

Protection from accidental deletion of this object [true/false]


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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the Universal Secrets Connector


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

def description
  @description
end

#json ⇒ Object

Set output format to JSON


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

def json
  @json
end

#k8s_namespace ⇒ Object

K8s namespace (Relevant to Kubernetes targets)


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

def k8s_namespace
  @k8s_namespace
end

#name ⇒ Object

Universal Secrets Connector name


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

def name
  @name
end

#tags ⇒ Object

List of the tags attached to this Universal Secrets Connector


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

def tags
  @tags
end

#target_to_associate ⇒ Object

Target Universal Secrets Connector to connect


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

def target_to_associate
  @target_to_associate
end

#token ⇒ Object

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


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

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication


47
48
49
 
# File 'lib/akeyless/models/create_usc.rb', line 47

def uid_token
  @uid_token
end

#usc_prefix ⇒ Object

Prefix for all secrets created in AWS Secrets Manager


50
51
52
 
# File 'lib/akeyless/models/create_usc.rb', line 50

def usc_prefix
  @usc_prefix
end

#use_prefix_as_filter ⇒ Object

Whether to filter the USC secret list using the specified usc-prefix [true/false]


53
54
55
 
# File 'lib/akeyless/models/create_usc.rb', line 53

def use_prefix_as_filter
  @use_prefix_as_filter
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

[View source]

259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/akeyless/models/create_usc.rb', line 259

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

[View source]

74
75
76
 
# File 'lib/akeyless/models/create_usc.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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

[View source]

56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/akeyless/models/create_usc.rb', line 56

def self.attribute_map
  {
    :'azure_kv_name' => :'azure-kv-name',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'json' => :'json',
    :'k8s_namespace' => :'k8s-namespace',
    :'name' => :'name',
    :'tags' => :'tags',
    :'target_to_associate' => :'target-to-associate',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'usc_prefix' => :'usc-prefix',
    :'use_prefix_as_filter' => :'use-prefix-as-filter'
  }
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

[View source]

235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/akeyless/models/create_usc.rb', line 235

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

[View source]

97
98
99
100
 
# File 'lib/akeyless/models/create_usc.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.

[View source]

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/akeyless/models/create_usc.rb', line 79

def self.openapi_types
  {
    :'azure_kv_name' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'json' => :'Boolean',
    :'k8s_namespace' => :'String',
    :'name' => :'String',
    :'tags' => :'Array<String>',
    :'target_to_associate' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'usc_prefix' => :'String',
    :'use_prefix_as_filter' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared

[View source]

203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/akeyless/models/create_usc.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      azure_kv_name == o.azure_kv_name &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      json == o.json &&
      k8s_namespace == o.k8s_namespace &&
      name == o.name &&
      tags == o.tags &&
      target_to_associate == o.target_to_associate &&
      token == o.token &&
      uid_token == o.uid_token &&
      usc_prefix == o.usc_prefix &&
      use_prefix_as_filter == o.use_prefix_as_filter
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

[View source]

330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/akeyless/models/create_usc.rb', line 330

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
[View source]

222
223
224
 
# File 'lib/akeyless/models/create_usc.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code

[View source]

228
229
230
 
# File 'lib/akeyless/models/create_usc.rb', line 228

def hash
  [azure_kv_name, delete_protection, description, json, k8s_namespace, name, tags, target_to_associate, token, uid_token, usc_prefix, use_prefix_as_filter].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

[View source]

178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/akeyless/models/create_usc.rb', line 178

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

  if @target_to_associate.nil?
    invalid_properties.push('invalid value for "target_to_associate", target_to_associate 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

[View source]

306
307
308
 
# File 'lib/akeyless/models/create_usc.rb', line 306

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

[View source]

312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/akeyless/models/create_usc.rb', line 312

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

[View source]

300
301
302
 
# File 'lib/akeyless/models/create_usc.rb', line 300

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

[View source]

194
195
196
197
198
199
 
# File 'lib/akeyless/models/create_usc.rb', line 194

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