Class: LaunchDarklyApi::FeatureFlag
- Inherits:
-
Object
- Object
- LaunchDarklyApi::FeatureFlag
- Defined in:
- lib/launchdarkly_api/models/feature_flag.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#_links ⇒ Object
Returns the value of attribute _links.
-
#_maintainer ⇒ Object
Returns the value of attribute _maintainer.
-
#_version ⇒ Object
Version of the feature flag.
-
#archived ⇒ Object
Boolean indicating if the feature flag is archived.
-
#archived_date ⇒ Object
Returns the value of attribute archived_date.
-
#client_side_availability ⇒ Object
Returns the value of attribute client_side_availability.
-
#creation_date ⇒ Object
Returns the value of attribute creation_date.
-
#custom_properties ⇒ Object
Returns the value of attribute custom_properties.
-
#defaults ⇒ Object
Returns the value of attribute defaults.
-
#description ⇒ Object
Description of the feature flag.
-
#environments ⇒ Object
Returns the value of attribute environments.
-
#experiments ⇒ Object
Returns the value of attribute experiments.
-
#goal_ids ⇒ Object
Returns the value of attribute goal_ids.
-
#include_in_snippet ⇒ Object
Deprecated, use
clientSideAvailability
. -
#key ⇒ Object
A unique key used to reference the flag in your code.
-
#kind ⇒ Object
Kind of feature flag.
-
#maintainer_id ⇒ Object
Associated maintainerId for the feature flag.
-
#name ⇒ Object
A human-friendly name for the feature flag.
-
#tags ⇒ Object
Tags for the feature flag.
-
#temporary ⇒ Object
Whether the flag is a temporary flag.
-
#variations ⇒ Object
An array of possible variations for the flag.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ FeatureFlag
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ FeatureFlag
Initializes the object
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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 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 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 160 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `LaunchDarklyApi::FeatureFlag` 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 `LaunchDarklyApi::FeatureFlag`. 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?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'kind') self.kind = attributes[:'kind'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'key') self.key = attributes[:'key'] end if attributes.key?(:'_version') self._version = attributes[:'_version'] end if attributes.key?(:'creation_date') self.creation_date = attributes[:'creation_date'] end if attributes.key?(:'include_in_snippet') self.include_in_snippet = attributes[:'include_in_snippet'] end if attributes.key?(:'client_side_availability') self.client_side_availability = attributes[:'client_side_availability'] end if attributes.key?(:'variations') if (value = attributes[:'variations']).is_a?(Array) self.variations = value end end if attributes.key?(:'temporary') self.temporary = attributes[:'temporary'] end if attributes.key?(:'tags') if (value = attributes[:'tags']).is_a?(Array) self. = value end end if attributes.key?(:'_links') if (value = attributes[:'_links']).is_a?(Hash) self._links = value end end if attributes.key?(:'maintainer_id') self.maintainer_id = attributes[:'maintainer_id'] end if attributes.key?(:'_maintainer') self._maintainer = attributes[:'_maintainer'] end if attributes.key?(:'goal_ids') if (value = attributes[:'goal_ids']).is_a?(Array) self.goal_ids = value end end if attributes.key?(:'experiments') self.experiments = attributes[:'experiments'] end if attributes.key?(:'custom_properties') if (value = attributes[:'custom_properties']).is_a?(Hash) self.custom_properties = value end end if attributes.key?(:'archived') self.archived = attributes[:'archived'] end if attributes.key?(:'archived_date') self.archived_date = attributes[:'archived_date'] end if attributes.key?(:'defaults') self.defaults = attributes[:'defaults'] end if attributes.key?(:'environments') if (value = attributes[:'environments']).is_a?(Hash) self.environments = value end end end |
Instance Attribute Details
#_links ⇒ Object
Returns the value of attribute _links.
49 50 51 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 49 def _links @_links end |
#_maintainer ⇒ Object
Returns the value of attribute _maintainer.
54 55 56 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 54 def _maintainer @_maintainer end |
#_version ⇒ Object
Version of the feature flag
31 32 33 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 31 def _version @_version end |
#archived ⇒ Object
Boolean indicating if the feature flag is archived
63 64 65 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 63 def archived @archived end |
#archived_date ⇒ Object
Returns the value of attribute archived_date.
65 66 67 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 65 def archived_date @archived_date end |
#client_side_availability ⇒ Object
Returns the value of attribute client_side_availability.
38 39 40 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 38 def client_side_availability @client_side_availability end |
#creation_date ⇒ Object
Returns the value of attribute creation_date.
33 34 35 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 33 def creation_date @creation_date end |
#custom_properties ⇒ Object
Returns the value of attribute custom_properties.
60 61 62 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 60 def custom_properties @custom_properties end |
#defaults ⇒ Object
Returns the value of attribute defaults.
67 68 69 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 67 def defaults @defaults end |
#description ⇒ Object
Description of the feature flag
25 26 27 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 25 def description @description end |
#environments ⇒ Object
Returns the value of attribute environments.
69 70 71 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 69 def environments @environments end |
#experiments ⇒ Object
Returns the value of attribute experiments.
58 59 60 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 58 def experiments @experiments end |
#goal_ids ⇒ Object
Returns the value of attribute goal_ids.
56 57 58 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 56 def goal_ids @goal_ids end |
#include_in_snippet ⇒ Object
Deprecated, use clientSideAvailability
. Whether this flag should be made available to the client-side JavaScript SDK
36 37 38 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 36 def include_in_snippet @include_in_snippet end |
#key ⇒ Object
A unique key used to reference the flag in your code
28 29 30 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 28 def key @key end |
#kind ⇒ Object
Kind of feature flag
22 23 24 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 22 def kind @kind end |
#maintainer_id ⇒ Object
Associated maintainerId for the feature flag
52 53 54 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 52 def maintainer_id @maintainer_id end |
#name ⇒ Object
A human-friendly name for the feature flag
19 20 21 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 19 def name @name end |
#tags ⇒ Object
Tags for the feature flag
47 48 49 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 47 def @tags end |
#temporary ⇒ Object
Whether the flag is a temporary flag
44 45 46 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 44 def temporary @temporary end |
#variations ⇒ Object
An array of possible variations for the flag
41 42 43 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 41 def variations @variations end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
121 122 123 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 121 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 94 def self.attribute_map { :'name' => :'name', :'kind' => :'kind', :'description' => :'description', :'key' => :'key', :'_version' => :'_version', :'creation_date' => :'creationDate', :'include_in_snippet' => :'includeInSnippet', :'client_side_availability' => :'clientSideAvailability', :'variations' => :'variations', :'temporary' => :'temporary', :'tags' => :'tags', :'_links' => :'_links', :'maintainer_id' => :'maintainerId', :'_maintainer' => :'_maintainer', :'goal_ids' => :'goalIds', :'experiments' => :'experiments', :'custom_properties' => :'customProperties', :'archived' => :'archived', :'archived_date' => :'archivedDate', :'defaults' => :'defaults', :'environments' => :'environments' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
403 404 405 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 403 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
153 154 155 156 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 153 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 126 def self.openapi_types { :'name' => :'String', :'kind' => :'String', :'description' => :'String', :'key' => :'String', :'_version' => :'Integer', :'creation_date' => :'Integer', :'include_in_snippet' => :'Boolean', :'client_side_availability' => :'ClientSideAvailability', :'variations' => :'Array<Variation>', :'temporary' => :'Boolean', :'tags' => :'Array<String>', :'_links' => :'Hash<String, Link>', :'maintainer_id' => :'String', :'_maintainer' => :'MemberSummary', :'goal_ids' => :'Array<String>', :'experiments' => :'ExperimentInfoRep', :'custom_properties' => :'Hash<String, CustomProperty>', :'archived' => :'Boolean', :'archived_date' => :'Integer', :'defaults' => :'Defaults', :'environments' => :'Hash<String, FeatureFlagConfig>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 362 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && kind == o.kind && description == o.description && key == o.key && _version == o._version && creation_date == o.creation_date && include_in_snippet == o.include_in_snippet && client_side_availability == o.client_side_availability && variations == o.variations && temporary == o.temporary && == o. && _links == o._links && maintainer_id == o.maintainer_id && _maintainer == o._maintainer && goal_ids == o.goal_ids && experiments == o.experiments && custom_properties == o.custom_properties && archived == o.archived && archived_date == o.archived_date && defaults == o.defaults && environments == o.environments end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 434 def _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 = LaunchDarklyApi.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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
505 506 507 508 509 510 511 512 513 514 515 516 517 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 505 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
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 410 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{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[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 end self end |
#eql?(o) ⇒ Boolean
390 391 392 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 390 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
396 397 398 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 396 def hash [name, kind, description, key, _version, creation_date, include_in_snippet, client_side_availability, variations, temporary, , _links, maintainer_id, _maintainer, goal_ids, experiments, custom_properties, archived, archived_date, defaults, environments].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 272 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @kind.nil? invalid_properties.push('invalid value for "kind", kind cannot be nil.') end if @key.nil? invalid_properties.push('invalid value for "key", key cannot be nil.') end if @_version.nil? invalid_properties.push('invalid value for "_version", _version cannot be nil.') end if @creation_date.nil? invalid_properties.push('invalid value for "creation_date", creation_date cannot be nil.') end if @variations.nil? invalid_properties.push('invalid value for "variations", variations cannot be nil.') end if @temporary.nil? invalid_properties.push('invalid value for "temporary", temporary cannot be nil.') end if @tags.nil? invalid_properties.push('invalid value for "tags", tags cannot be nil.') end if @_links.nil? invalid_properties.push('invalid value for "_links", _links cannot be nil.') end if @experiments.nil? invalid_properties.push('invalid value for "experiments", experiments cannot be nil.') end if @custom_properties.nil? invalid_properties.push('invalid value for "custom_properties", custom_properties cannot be nil.') end if @archived.nil? invalid_properties.push('invalid value for "archived", archived cannot be nil.') end if @environments.nil? invalid_properties.push('invalid value for "environments", environments cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
481 482 483 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 481 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
487 488 489 490 491 492 493 494 495 496 497 498 499 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 487 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_s ⇒ String
Returns the string representation of the object
475 476 477 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 475 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
# File 'lib/launchdarkly_api/models/feature_flag.rb', line 331 def valid? return false if @name.nil? return false if @kind.nil? kind_validator = EnumAttributeValidator.new('String', ["boolean", "multivariate"]) return false unless kind_validator.valid?(@kind) return false if @key.nil? return false if @_version.nil? return false if @creation_date.nil? return false if @variations.nil? return false if @temporary.nil? return false if @tags.nil? return false if @_links.nil? return false if @experiments.nil? return false if @custom_properties.nil? return false if @archived.nil? return false if @environments.nil? true end |