Class: SmplkitGeneratedClient::Config::Config

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb

Overview

A named bag of configuration items, optionally inheriting from another config. Items are typed key/value pairs (‘STRING`, `NUMBER`, `BOOLEAN`, `JSON`). Configs may declare per-environment overrides for any item declared on the config itself or anywhere in its inheritance chain; resolving a config against an environment merges the chain top-down and then applies the matching overrides.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Config

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
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 96

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

When the config was created.



38
39
40
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 38

def created_at
  @created_at
end

#description ⇒ Object

Optional human-readable description of what this config holds.



23
24
25
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 23

def description
  @description
end

#environments ⇒ Object

Map of environment keys to per-environment override sets. An environment override applies when this config is resolved against that environment.



32
33
34
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 32

def environments
  @environments
end

#items ⇒ Object

Map of item keys to item definitions declared on this config. Keys must be unique within the config; declared types are immutable once set and must match any type declared for the same key on an ancestor.



29
30
31
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 29

def items
  @items
end

#managed ⇒ Object

Whether this config is admin-managed (‘true`) or auto-discovered by an SDK and not yet claimed (`false`). Configs created through the console or `POST /api/v1/configs` are always managed. Configs registered via `POST /api/v1/configs/bulk` land unmanaged. Setting this field to `true` on a PUT promotes a discovered config to managed, which consumes a slot of the `config.managed_configurations` entitlement.



35
36
37
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 35

def managed
  @managed
end

#name ⇒ Object

Human-readable name for the config.



20
21
22
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 20

def name
  @name
end

#parent ⇒ Object

Key of another config to inherit items from. Inherited items appear as if declared on this config; locally declared items with the same key shadow them. Omit or set to ‘null` for a standalone config with no parent.



26
27
28
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 26

def parent
  @parent
end

#updated_at ⇒ Object

When the config was last modified.



41
42
43
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 41

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



58
59
60
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 58

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 63

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 44

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'parent' => :'parent',
    :'items' => :'items',
    :'environments' => :'environments',
    :'managed' => :'managed',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 233

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
86
87
88
89
90
91
92
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 82

def self.openapi_nullable
  Set.new([
    :'description',
    :'parent',
    :'items',
    :'environments',
    :'managed',
    :'created_at',
    :'updated_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 68

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'parent' => :'String',
    :'items' => :'Hash<String, ConfigItemDefinition>',
    :'environments' => :'Hash<String, EnvironmentOverride>',
    :'managed' => :'Boolean',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      parent == o.parent &&
      items == o.items &&
      environments == o.environments &&
      managed == o.managed &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


220
221
222
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 226

def hash
  [name, description, parent, items, environments, managed, created_at, updated_at].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/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 151

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 @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  if !@description.nil? && @description.to_s.length > 1000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 1000.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 255

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

#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/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb', line 171

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if !@description.nil? && @description.to_s.length > 1000
  true
end