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



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
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/akeyless/models/general_config_part.rb', line 96

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_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?(:'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_key')
    self.tls_key = attributes[:'tls_key']
  end
end

Instance Attribute Details

#akeyless_urlObject

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_ttlObject

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_nameObject

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_sni_proxyObject

Returns the value of attribute enable_sni_proxy.



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

def enable_sni_proxy
  @enable_sni_proxy
end

#enable_tlsObject

Returns the value of attribute enable_tls.



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

def enable_tls
  @enable_tls
end

#enable_tls_configureObject

Returns the value of attribute enable_tls_configure.



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

def enable_tls_configure
  @enable_tls_configure
end

#enable_tls_curlObject

Returns the value of attribute enable_tls_curl.



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

def enable_tls_curl
  @enable_tls_curl
end

#enable_tls_hvpObject

Returns the value of attribute enable_tls_hvp.



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

def enable_tls_hvp
  @enable_tls_hvp
end

#gw_cluster_urlObject

Returns the value of attribute gw_cluster_url.



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

def gw_cluster_url
  @gw_cluster_url
end

#notify_on_status_changeObject

Returns the value of attribute notify_on_status_change.



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

def notify_on_status_change
  @notify_on_status_change
end

#tcp_portObject

Returns the value of attribute tcp_port.



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

def tcp_port
  @tcp_port
end

#tls_certObject

Returns the value of attribute tls_cert.



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

def tls_cert
  @tls_cert
end

#tls_keyObject

Returns the value of attribute tls_key.



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

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



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
272
273
# File 'lib/akeyless/models/general_config_part.rb', line 236

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_attributesObject

Returns all the JSON keys this model knows about



65
66
67
# File 'lib/akeyless/models/general_config_part.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'akeyless_url' => :'akeyless_url',
    :'api_token_ttl' => :'api_token_ttl',
    :'display_name' => :'display_name',
    :'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',
    :'notify_on_status_change' => :'notify_on_status_change',
    :'tcp_port' => :'tcp_port',
    :'tls_cert' => :'tls_cert',
    :'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



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

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_nullableObject

List of attributes with nullable: true



89
90
91
92
# File 'lib/akeyless/models/general_config_part.rb', line 89

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

.openapi_typesObject

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/akeyless/models/general_config_part.rb', line 70

def self.openapi_types
  {
    :'akeyless_url' => :'String',
    :'api_token_ttl' => :'String',
    :'display_name' => :'String',
    :'enable_sni_proxy' => :'Boolean',
    :'enable_tls' => :'Boolean',
    :'enable_tls_configure' => :'Boolean',
    :'enable_tls_curl' => :'Boolean',
    :'enable_tls_hvp' => :'Boolean',
    :'gw_cluster_url' => :'String',
    :'notify_on_status_change' => :'Boolean',
    :'tcp_port' => :'String',
    :'tls_cert' => :'String',
    :'tls_key' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

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_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 &&
      notify_on_status_change == o.notify_on_status_change &&
      tcp_port == o.tcp_port &&
      tls_cert == o.tls_cert &&
      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



307
308
309
310
311
312
313
314
315
316
317
318
319
# File 'lib/akeyless/models/general_config_part.rb', line 307

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


199
200
201
# File 'lib/akeyless/models/general_config_part.rb', line 199

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



205
206
207
# File 'lib/akeyless/models/general_config_part.rb', line 205

def hash
  [akeyless_url, api_token_ttl, display_name, enable_sni_proxy, enable_tls, enable_tls_configure, enable_tls_curl, enable_tls_hvp, gw_cluster_url, notify_on_status_change, tcp_port, tls_cert, tls_key].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



164
165
166
167
168
# File 'lib/akeyless/models/general_config_part.rb', line 164

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



283
284
285
# File 'lib/akeyless/models/general_config_part.rb', line 283

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/akeyless/models/general_config_part.rb', line 289

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



277
278
279
# File 'lib/akeyless/models/general_config_part.rb', line 277

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



172
173
174
175
# File 'lib/akeyless/models/general_config_part.rb', line 172

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