Class: Akeyless::GeneralConfigPart

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GeneralConfigPart

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/akeyless/models/general_config_part.rb', line 120

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#akeyless_url ⇒ Object

AkeylessUrl is here for BC only. Gator will still return it if it exists in the configuration, but new clients (>=2.34.0) will ignore it and override it with what exists in their local file. It will no longer be sent to Gator for update, so new clusters will only have the default value saved in the DB.



19
20
21
 
# File 'lib/akeyless/models/general_config_part.rb', line 19

def akeyless_url
  @akeyless_url
end

#api_token_ttl ⇒ Object

Returns the value of attribute api_token_ttl.



21
22
23
 
# File 'lib/akeyless/models/general_config_part.rb', line 21

def api_token_ttl
  @api_token_ttl
end

#display_name ⇒ Object

Returns the value of attribute display_name.



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

def display_name
  @display_name
end

#enable_json_body_limit ⇒ Object

Returns the value of attribute enable_json_body_limit.



25
26
27
 
# File 'lib/akeyless/models/general_config_part.rb', line 25

def enable_json_body_limit
  @enable_json_body_limit
end

#enable_sni_proxy ⇒ Object

Returns the value of attribute enable_sni_proxy.



27
28
29
 
# File 'lib/akeyless/models/general_config_part.rb', line 27

def enable_sni_proxy
  @enable_sni_proxy
end

#enable_tls ⇒ Object

Returns the value of attribute enable_tls.



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

def enable_tls
  @enable_tls
end

#enable_tls_configure ⇒ Object

Returns the value of attribute enable_tls_configure.



31
32
33
 
# File 'lib/akeyless/models/general_config_part.rb', line 31

def enable_tls_configure
  @enable_tls_configure
end

#enable_tls_curl ⇒ Object

Returns the value of attribute enable_tls_curl.



33
34
35
 
# File 'lib/akeyless/models/general_config_part.rb', line 33

def enable_tls_curl
  @enable_tls_curl
end

#enable_tls_hvp ⇒ Object

Returns the value of attribute enable_tls_hvp.



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

def enable_tls_hvp
  @enable_tls_hvp
end

#gw_cluster_url ⇒ Object

Returns the value of attribute gw_cluster_url.



37
38
39
 
# File 'lib/akeyless/models/general_config_part.rb', line 37

def gw_cluster_url
  @gw_cluster_url
end

#hvp_route_version ⇒ Object

Returns the value of attribute hvp_route_version.



39
40
41
 
# File 'lib/akeyless/models/general_config_part.rb', line 39

def hvp_route_version
  @hvp_route_version
end

#json_body_limit_mb ⇒ Object

Returns the value of attribute json_body_limit_mb.



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

def json_body_limit_mb
  @json_body_limit_mb
end

#notify_on_status_change ⇒ Object

Returns the value of attribute notify_on_status_change.



43
44
45
 
# File 'lib/akeyless/models/general_config_part.rb', line 43

def notify_on_status_change
  @notify_on_status_change
end

#tcp_port ⇒ Object

Returns the value of attribute tcp_port.



45
46
47
 
# File 'lib/akeyless/models/general_config_part.rb', line 45

def tcp_port
  @tcp_port
end

#tls_cert ⇒ Object

Returns the value of attribute tls_cert.



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

def tls_cert
  @tls_cert
end

#tls_cert_common_name ⇒ Object

Returns the value of attribute tls_cert_common_name.



49
50
51
 
# File 'lib/akeyless/models/general_config_part.rb', line 49

def tls_cert_common_name
  @tls_cert_common_name
end

#tls_cert_expiration_date ⇒ Object

Returns the value of attribute tls_cert_expiration_date.



51
52
53
 
# File 'lib/akeyless/models/general_config_part.rb', line 51

def tls_cert_expiration_date
  @tls_cert_expiration_date
end

#tls_cert_expiration_events ⇒ Object

Returns the value of attribute tls_cert_expiration_events.



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

def tls_cert_expiration_events
  @tls_cert_expiration_events
end

#tls_key ⇒ Object

Returns the value of attribute tls_key.



55
56
57
 
# File 'lib/akeyless/models/general_config_part.rb', line 55

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/akeyless/models/general_config_part.rb', line 292

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/akeyless/models/general_config_part.rb', line 58

def self.attribute_map
  {
    :'akeyless_url' => :'akeyless_url',
    :'api_token_ttl' => :'api_token_ttl',
    :'display_name' => :'display_name',
    :'enable_json_body_limit' => :'enable_json_body_limit',
    :'enable_sni_proxy' => :'enable_sni_proxy',
    :'enable_tls' => :'enable_tls',
    :'enable_tls_configure' => :'enable_tls_configure',
    :'enable_tls_curl' => :'enable_tls_curl',
    :'enable_tls_hvp' => :'enable_tls_hvp',
    :'gw_cluster_url' => :'gw_cluster_url',
    :'hvp_route_version' => :'hvp_route_version',
    :'json_body_limit_mb' => :'json_body_limit_mb',
    :'notify_on_status_change' => :'notify_on_status_change',
    :'tcp_port' => :'tcp_port',
    :'tls_cert' => :'tls_cert',
    :'tls_cert_common_name' => :'tls_cert_common_name',
    :'tls_cert_expiration_date' => :'tls_cert_expiration_date',
    :'tls_cert_expiration_events' => :'tls_cert_expiration_events',
    :'tls_key' => :'tls_key'
  }
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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/akeyless/models/general_config_part.rb', line 268

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



113
114
115
116
 
# File 'lib/akeyless/models/general_config_part.rb', line 113

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/akeyless/models/general_config_part.rb', line 88

def self.openapi_types
  {
    :'akeyless_url' => :'String',
    :'api_token_ttl' => :'String',
    :'display_name' => :'String',
    :'enable_json_body_limit' => :'Boolean',
    :'enable_sni_proxy' => :'Boolean',
    :'enable_tls' => :'Boolean',
    :'enable_tls_configure' => :'Boolean',
    :'enable_tls_curl' => :'Boolean',
    :'enable_tls_hvp' => :'Boolean',
    :'gw_cluster_url' => :'String',
    :'hvp_route_version' => :'Integer',
    :'json_body_limit_mb' => :'Integer',
    :'notify_on_status_change' => :'Boolean',
    :'tcp_port' => :'String',
    :'tls_cert' => :'String',
    :'tls_cert_common_name' => :'String',
    :'tls_cert_expiration_date' => :'Time',
    :'tls_cert_expiration_events' => :'Array<CertificateExpirationEvent>',
    :'tls_key' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/akeyless/models/general_config_part.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      akeyless_url == o.akeyless_url &&
      api_token_ttl == o.api_token_ttl &&
      display_name == o.display_name &&
      enable_json_body_limit == o.enable_json_body_limit &&
      enable_sni_proxy == o.enable_sni_proxy &&
      enable_tls == o.enable_tls &&
      enable_tls_configure == o.enable_tls_configure &&
      enable_tls_curl == o.enable_tls_curl &&
      enable_tls_hvp == o.enable_tls_hvp &&
      gw_cluster_url == o.gw_cluster_url &&
      hvp_route_version == o.hvp_route_version &&
      json_body_limit_mb == o.json_body_limit_mb &&
      notify_on_status_change == o.notify_on_status_change &&
      tcp_port == o.tcp_port &&
      tls_cert == o.tls_cert &&
      tls_cert_common_name == o.tls_cert_common_name &&
      tls_cert_expiration_date == o.tls_cert_expiration_date &&
      tls_cert_expiration_events == o.tls_cert_expiration_events &&
      tls_key == o.tls_key
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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/akeyless/models/general_config_part.rb', line 363

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


255
256
257
 
# File 'lib/akeyless/models/general_config_part.rb', line 255

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



261
262
263
 
# File 'lib/akeyless/models/general_config_part.rb', line 261

def hash
  [akeyless_url, api_token_ttl, display_name, enable_json_body_limit, enable_sni_proxy, enable_tls, enable_tls_configure, enable_tls_curl, enable_tls_hvp, gw_cluster_url, hvp_route_version, json_body_limit_mb, notify_on_status_change, tcp_port, tls_cert, tls_cert_common_name, tls_cert_expiration_date, tls_cert_expiration_events, tls_key].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



214
215
216
217
218
 
# File 'lib/akeyless/models/general_config_part.rb', line 214

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



339
340
341
 
# File 'lib/akeyless/models/general_config_part.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/akeyless/models/general_config_part.rb', line 345

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



333
334
335
 
# File 'lib/akeyless/models/general_config_part.rb', line 333

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end