Class: LaunchDarklyApi::Environment

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/models/environment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Environment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
161
 
# File 'lib/launchdarkly_api/models/environment.rb', line 98

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'_links')
    self._links = attributes[:'_links']
  end

  if attributes.has_key?(:'_id')
    self._id = attributes[:'_id']
  end

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

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'apiKey')
    self.api_key = attributes[:'apiKey']
  end

  if attributes.has_key?(:'mobileKey')
    self.mobile_key = attributes[:'mobileKey']
  end

  if attributes.has_key?(:'color')
    self.color = attributes[:'color']
  end

  if attributes.has_key?(:'defaultTtl')
    self.default_ttl = attributes[:'defaultTtl']
  end

  if attributes.has_key?(:'secureMode')
    self.secure_mode = attributes[:'secureMode']
  end

  if attributes.has_key?(:'defaultTrackEvents')
    self.default_track_events = attributes[:'defaultTrackEvents']
  end

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

  if attributes.has_key?(:'requireComments')
    self.require_comments = attributes[:'requireComments']
  end

  if attributes.has_key?(:'confirmChanges')
    self.confirm_changes = attributes[:'confirmChanges']
  end

  if attributes.has_key?(:'approvalSettings')
    self.approval_settings = attributes[:'approvalSettings']
  end
end

Instance Attribute Details

#_id ⇒ Object

Returns the value of attribute _id.



19
20
21
 
# File 'lib/launchdarkly_api/models/environment.rb', line 19

def _id
  @_id
end

#_links ⇒ Object

Returns the value of attribute _links.



17
18
19
 
# File 'lib/launchdarkly_api/models/environment.rb', line 17

def _links
  @_links
end

#api_key ⇒ Object

The SDK key for backend LaunchDarkly SDKs.



28
29
30
 
# File 'lib/launchdarkly_api/models/environment.rb', line 28

def api_key
  @api_key
end

#approval_settings ⇒ Object

Returns the value of attribute approval_settings.



54
55
56
 
# File 'lib/launchdarkly_api/models/environment.rb', line 54

def approval_settings
  @approval_settings
end

#color ⇒ Object

The swatch color for the environment.



34
35
36
 
# File 'lib/launchdarkly_api/models/environment.rb', line 34

def color
  @color
end

#confirm_changes ⇒ Object

Determines if this environment requires confirmation for flag and segment changes.



52
53
54
 
# File 'lib/launchdarkly_api/models/environment.rb', line 52

def confirm_changes
  @confirm_changes
end

#default_track_events ⇒ Object

Set to true to send detailed event information for new flags.



43
44
45
 
# File 'lib/launchdarkly_api/models/environment.rb', line 43

def default_track_events
  @default_track_events
end

#default_ttl ⇒ Object

The default TTL.



37
38
39
 
# File 'lib/launchdarkly_api/models/environment.rb', line 37

def default_ttl
  @default_ttl
end

#key ⇒ Object

The key for the environment.



22
23
24
 
# File 'lib/launchdarkly_api/models/environment.rb', line 22

def key
  @key
end

#mobile_key ⇒ Object

The SDK key for mobile LaunchDarkly SDKs.



31
32
33
 
# File 'lib/launchdarkly_api/models/environment.rb', line 31

def mobile_key
  @mobile_key
end

#name ⇒ Object

The name of the environment.



25
26
27
 
# File 'lib/launchdarkly_api/models/environment.rb', line 25

def name
  @name
end

#require_comments ⇒ Object

Determines if this environment requires comments for flag and segment changes.



49
50
51
 
# File 'lib/launchdarkly_api/models/environment.rb', line 49

def require_comments
  @require_comments
end

#secure_mode ⇒ Object

Determines if this environment is in safe mode.



40
41
42
 
# File 'lib/launchdarkly_api/models/environment.rb', line 40

def secure_mode
  @secure_mode
end

#tags ⇒ Object

An array of tags for this environment.



46
47
48
 
# File 'lib/launchdarkly_api/models/environment.rb', line 46

def tags
  @tags
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/launchdarkly_api/models/environment.rb', line 57

def self.attribute_map
  {
    :'_links' => :'_links',
    :'_id' => :'_id',
    :'key' => :'key',
    :'name' => :'name',
    :'api_key' => :'apiKey',
    :'mobile_key' => :'mobileKey',
    :'color' => :'color',
    :'default_ttl' => :'defaultTtl',
    :'secure_mode' => :'secureMode',
    :'default_track_events' => :'defaultTrackEvents',
    :'tags' => :'tags',
    :'require_comments' => :'requireComments',
    :'confirm_changes' => :'confirmChanges',
    :'approval_settings' => :'approvalSettings'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/launchdarkly_api/models/environment.rb', line 77

def self.swagger_types
  {
    :'_links' => :'Links',
    :'_id' => :'Id',
    :'key' => :'String',
    :'name' => :'String',
    :'api_key' => :'String',
    :'mobile_key' => :'String',
    :'color' => :'String',
    :'default_ttl' => :'Float',
    :'secure_mode' => :'BOOLEAN',
    :'default_track_events' => :'BOOLEAN',
    :'tags' => :'Array<String>',
    :'require_comments' => :'BOOLEAN',
    :'confirm_changes' => :'BOOLEAN',
    :'approval_settings' => :'EnvironmentApprovalSettings'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _links == o._links &&
      _id == o._id &&
      key == o.key &&
      name == o.name &&
      api_key == o.api_key &&
      mobile_key == o.mobile_key &&
      color == o.color &&
      default_ttl == o.default_ttl &&
      secure_mode == o.secure_mode &&
      default_track_events == o.default_track_events &&
      tags == o.tags &&
      require_comments == o.require_comments &&
      confirm_changes == o.confirm_changes &&
      approval_settings == o.approval_settings
end

#_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



233
234
235
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
 
# File 'lib/launchdarkly_api/models/environment.rb', line 233

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = LaunchDarklyApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/launchdarkly_api/models/environment.rb', line 299

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

#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
 
# File 'lib/launchdarkly_api/models/environment.rb', line 212

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


199
200
201
 
# File 'lib/launchdarkly_api/models/environment.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



205
206
207
 
# File 'lib/launchdarkly_api/models/environment.rb', line 205

def hash
  [_links, _id, key, name, api_key, mobile_key, color, default_ttl, secure_mode, default_track_events, tags, require_comments, confirm_changes, approval_settings].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



165
166
167
168
 
# File 'lib/launchdarkly_api/models/environment.rb', line 165

def list_invalid_properties
  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



279
280
281
 
# File 'lib/launchdarkly_api/models/environment.rb', line 279

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



285
286
287
288
289
290
291
292
293
 
# File 'lib/launchdarkly_api/models/environment.rb', line 285

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



273
274
275
 
# File 'lib/launchdarkly_api/models/environment.rb', line 273

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
 
# File 'lib/launchdarkly_api/models/environment.rb', line 172

def valid?
  true
end