Class: SmplkitGeneratedClient::Flags::Flag

Inherits:
ApiModelBase show all
Defined in:
lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb

Overview

A feature flag whose value is resolved at runtime from environment rules and a default. A flag has a value type (‘BOOLEAN`, `STRING`, `NUMERIC`, or `JSON`) and either a fixed set of allowed values (constrained) or accepts any value matching the type (unconstrained). Each environment can enable or disable the flag, set its own default, and define targeting rules that override the default for specific evaluation contexts.

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ Flag

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 127

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

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

  if attributes.key?(:'values')
    if (value = attributes[:'values']).is_a?(Array)
      self.values = 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?(:'sources')
    if (value = attributes[:'sources']).is_a?(Array)
      self.sources = value
    end
  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 flag was created.



43
44
45
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 43

def created_at
  @created_at
end

#default ⇒ Object

Returns the value of attribute default.



28
29
30
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 28

def default
  @default
end

#description ⇒ Object

Human-readable description of the flag’s purpose.



23
24
25
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 23

def description
  @description
end

#environments ⇒ Object

Per-environment configuration keyed by environment name (‘production`, `staging`, etc.). Environments not listed fall back to the flag’s global ‘default`.



34
35
36
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 34

def environments
  @environments
end

#managed ⇒ Object

‘true` when the flag was created through the API, `false` when it was auto-discovered from a bulk-register call. Auto-discovered flags can be edited and converted to managed by setting this to `true`.



37
38
39
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 37

def managed
  @managed
end

#name ⇒ Object

Human-readable display name for the flag.



20
21
22
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 20

def name
  @name
end

#sources ⇒ Object

SDK-reported observations of this flag, grouped by service and environment. Populated automatically by the bulk-register endpoint.



40
41
42
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 40

def sources
  @sources
end

#type ⇒ Object

Value type of the flag. Accepted case-insensitively. Changing the type cascades to ‘values`, `default`, and every environment’s rules and default.



26
27
28
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 26

def type
  @type
end

#updated_at ⇒ Object

When the flag was last modified.



46
47
48
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 46

def updated_at
  @updated_at
end

#values ⇒ Object

Ordered set of allowed values for a constrained flag, or ‘null` for an unconstrained flag. `BOOLEAN` flags, if constrained, must declare exactly two values.



31
32
33
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 31

def values
  @values
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



87
88
89
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 87

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 92

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 71

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'type' => :'type',
    :'default' => :'default',
    :'values' => :'values',
    :'environments' => :'environments',
    :'managed' => :'managed',
    :'sources' => :'sources',
    :'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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 273

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
117
118
119
120
121
122
123
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 113

def self.openapi_nullable
  Set.new([
    :'description',
    :'default',
    :'values',
    :'managed',
    :'sources',
    :'created_at',
    :'updated_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 97

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'type' => :'String',
    :'default' => :'Object',
    :'values' => :'Array<FlagValue>',
    :'environments' => :'Hash<String, FlagEnvironment>',
    :'managed' => :'Boolean',
    :'sources' => :'Array<FlagSource>',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      type == o.type &&
      default == o.default &&
      values == o.values &&
      environments == o.environments &&
      managed == o.managed &&
      sources == o.sources &&
      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


260
261
262
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



266
267
268
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 266

def hash
  [name, description, type, default, values, environments, managed, sources, 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



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 196

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 @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 295

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



212
213
214
215
216
217
218
219
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag.rb', line 212

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["BOOLEAN", "STRING", "NUMERIC", "JSON"])
  return false unless type_validator.valid?(@type)
  true
end