Class: SmplkitGeneratedClient::Flags::FlagSource

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

Overview

A record of an SDK observing a feature flag from a particular service and environment. The flags service auto-registers a source the first time an SDK reports a flag from a given service/environment pair and refreshes ‘last_seen` on every subsequent report. Each source captures the value type and default value the SDK declared in source code at that location, which makes it possible to detect when service code has drifted from the flag’s authoritative configuration.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

  if attributes.key?(:'last_seen')
    self.last_seen = attributes[:'last_seen']
  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 source record was created.



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

def created_at
  @created_at
end

#declared_default ⇒ Object

Returns the value of attribute declared_default.



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

def declared_default
  @declared_default
end

#declared_type ⇒ Object

Value type the SDK reported when registering the flag from this service/environment. May differ from the flag’s authoritative ‘type` if the service is running stale code.



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

def declared_type
  @declared_type
end

#environment ⇒ Object

Environment in which the service declared the flag.



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

def environment
  @environment
end

#first_observed ⇒ Object

When this source was first observed.



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

def first_observed
  @first_observed
end

#last_seen ⇒ Object

Most recent time the SDK re-registered this source.



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

def last_seen
  @last_seen
end

#service ⇒ Object

Service that declared the flag.



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

def service
  @service
end

#updated_at ⇒ Object

When the source record was last modified.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



79
80
81
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb', line 79

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb', line 84

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb', line 65

def self.attribute_map
  {
    :'service' => :'service',
    :'environment' => :'environment',
    :'declared_type' => :'declared_type',
    :'declared_default' => :'declared_default',
    :'first_observed' => :'first_observed',
    :'last_seen' => :'last_seen',
    :'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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb', line 222

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



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb', line 103

def self.openapi_nullable
  Set.new([
    :'service',
    :'environment',
    :'declared_type',
    :'declared_default',
    :'first_observed',
    :'last_seen',
    :'created_at',
    :'updated_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb', line 89

def self.openapi_types
  {
    :'service' => :'String',
    :'environment' => :'String',
    :'declared_type' => :'String',
    :'declared_default' => :'Object',
    :'first_observed' => :'Time',
    :'last_seen' => :'Time',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      service == o.service &&
      environment == o.environment &&
      declared_type == o.declared_type &&
      declared_default == o.declared_default &&
      first_observed == o.first_observed &&
      last_seen == o.last_seen &&
      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


209
210
211
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb', line 209

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



215
216
217
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb', line 215

def hash
  [service, environment, declared_type, declared_default, first_observed, last_seen, 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



167
168
169
170
171
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb', line 167

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



175
176
177
178
179
180
 
# File 'lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb', line 175

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