Class: LaunchDarklyApi::Project

Inherits:
ApiModelBase show all
Defined in:
lib/launchdarkly_api/models/project.rb

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/launchdarkly_api/models/project.rb', line 95

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_access ⇒ Object

Returns the value of attribute _access.



35
36
37
 
# File 'lib/launchdarkly_api/models/project.rb', line 35

def _access
  @_access
end

#_id ⇒ Object

The ID of this project



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

def _id
  @_id
end

#_links ⇒ Object

The location and content type of related resources



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

def _links
  @_links
end

#default_client_side_availability ⇒ Object

Returns the value of attribute default_client_side_availability.



30
31
32
 
# File 'lib/launchdarkly_api/models/project.rb', line 30

def default_client_side_availability
  @default_client_side_availability
end

#default_release_pipeline_key ⇒ Object

The key of the default release pipeline for this project



41
42
43
 
# File 'lib/launchdarkly_api/models/project.rb', line 41

def default_release_pipeline_key
  @default_release_pipeline_key
end

#environments ⇒ Object

Returns the value of attribute environments.



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

def environments
  @environments
end

#include_in_snippet_by_default ⇒ Object

Whether or not flags created in this project are made available to the client-side JavaScript SDK by default



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

def include_in_snippet_by_default
  @include_in_snippet_by_default
end

#key ⇒ Object

The key of this project



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

def key
  @key
end

#name ⇒ Object

A human-friendly name for the project



33
34
35
 
# File 'lib/launchdarkly_api/models/project.rb', line 33

def name
  @name
end

#tags ⇒ Object

A list of tags for the project



38
39
40
 
# File 'lib/launchdarkly_api/models/project.rb', line 38

def tags
  @tags
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



62
63
64
 
# File 'lib/launchdarkly_api/models/project.rb', line 62

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/launchdarkly_api/models/project.rb', line 67

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/launchdarkly_api/models/project.rb', line 46

def self.attribute_map
  {
    :'_links' => :'_links',
    :'_id' => :'_id',
    :'key' => :'key',
    :'include_in_snippet_by_default' => :'includeInSnippetByDefault',
    :'default_client_side_availability' => :'defaultClientSideAvailability',
    :'name' => :'name',
    :'_access' => :'_access',
    :'tags' => :'tags',
    :'default_release_pipeline_key' => :'defaultReleasePipelineKey',
    :'environments' => :'environments'
  }
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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/launchdarkly_api/models/project.rb', line 303

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



88
89
90
91
 
# File 'lib/launchdarkly_api/models/project.rb', line 88

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/launchdarkly_api/models/project.rb', line 72

def self.openapi_types
  {
    :'_links' => :'Hash<String, Link>',
    :'_id' => :'String',
    :'key' => :'String',
    :'include_in_snippet_by_default' => :'Boolean',
    :'default_client_side_availability' => :'ClientSideAvailability',
    :'name' => :'String',
    :'_access' => :'Access',
    :'tags' => :'Array<String>',
    :'default_release_pipeline_key' => :'String',
    :'environments' => :'Environments'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/launchdarkly_api/models/project.rb', line 273

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _links == o._links &&
      _id == o._id &&
      key == o.key &&
      include_in_snippet_by_default == o.include_in_snippet_by_default &&
      default_client_side_availability == o.default_client_side_availability &&
      name == o.name &&
      _access == o._access &&
      tags == o.tags &&
      default_release_pipeline_key == o.default_release_pipeline_key &&
      environments == o.environments
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


290
291
292
 
# File 'lib/launchdarkly_api/models/project.rb', line 290

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



296
297
298
 
# File 'lib/launchdarkly_api/models/project.rb', line 296

def hash
  [_links, _id, key, include_in_snippet_by_default, default_client_side_availability, name, _access, tags, default_release_pipeline_key, environments].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @_links.nil?
    invalid_properties.push('invalid value for "_links", _links cannot be nil.')
  end

  if @_id.nil?
    invalid_properties.push('invalid value for "_id", _id cannot be nil.')
  end

  if @key.nil?
    invalid_properties.push('invalid value for "key", key cannot be nil.')
  end

  if @include_in_snippet_by_default.nil?
    invalid_properties.push('invalid value for "include_in_snippet_by_default", include_in_snippet_by_default cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @tags.nil?
    invalid_properties.push('invalid value for "tags", tags 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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/launchdarkly_api/models/project.rb', line 325

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



200
201
202
203
204
205
206
207
208
209
 
# File 'lib/launchdarkly_api/models/project.rb', line 200

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @_links.nil?
  return false if @_id.nil?
  return false if @key.nil?
  return false if @include_in_snippet_by_default.nil?
  return false if @name.nil?
  return false if @tags.nil?
  true
end