Class: LaunchDarklyApi::ApprovalRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApprovalRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'_id')
    self._id = attributes[:'_id']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_id ⇒ Object

Returns the value of attribute _id.



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

def _id
  @_id
end

#_version ⇒ Object

Returns the value of attribute _version.



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

def _version
  @_version
end

#all_reviews ⇒ Object

Returns the value of attribute all_reviews.



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

def all_reviews
  @all_reviews
end

#applied_by_member_id ⇒ Object

The id of the member that applied the approval request



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

def applied_by_member_id
  @applied_by_member_id
end

#applied_date ⇒ Object

A unix epoch time in milliseconds specifying the date the approval request was applied



36
37
38
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 36

def applied_date
  @applied_date
end

#creation_date ⇒ Object

A unix epoch time in milliseconds specifying the date the approval request was requested



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

def creation_date
  @creation_date
end

#instructions ⇒ Object

Returns the value of attribute instructions.



42
43
44
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 42

def instructions
  @instructions
end

#notify_member_ids ⇒ Object

Returns the value of attribute notify_member_ids.



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

def notify_member_ids
  @notify_member_ids
end

#requestor_id ⇒ Object

The id of the member that requested the change



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

def requestor_id
  @requestor_id
end

#review_status ⇒ Object

Returns the value of attribute review_status.



27
28
29
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 27

def review_status
  @review_status
end

#status ⇒ Object

| Name | Description | | ——–:| ———– | | pending | the approval request has not been applied yet | | completed| the approval request has been applied successfully | | failed | the approval request has been applied but the changes were not applied successfully |



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

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 67

def self.attribute_map
  {
    :'_id' => :'_id',
    :'_version' => :'_version',
    :'creation_date' => :'creationDate',
    :'requestor_id' => :'requestorId',
    :'review_status' => :'reviewStatus',
    :'status' => :'status',
    :'applied_by_member_id' => :'appliedByMemberID',
    :'applied_date' => :'appliedDate',
    :'all_reviews' => :'allReviews',
    :'notify_member_ids' => :'notifyMemberIds',
    :'instructions' => :'instructions'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 84

def self.swagger_types
  {
    :'_id' => :'Id',
    :'_version' => :'Integer',
    :'creation_date' => :'Integer',
    :'requestor_id' => :'String',
    :'review_status' => :'ApprovalRequestReviewStatus',
    :'status' => :'String',
    :'applied_by_member_id' => :'String',
    :'applied_date' => :'Integer',
    :'all_reviews' => :'Array<ApprovalRequestReview>',
    :'notify_member_ids' => :'Array<String>',
    :'instructions' => :'SemanticPatchInstruction'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _id == o._id &&
      _version == o._version &&
      creation_date == o.creation_date &&
      requestor_id == o.requestor_id &&
      review_status == o.review_status &&
      status == o.status &&
      applied_by_member_id == o.applied_by_member_id &&
      applied_date == o.applied_date &&
      all_reviews == o.all_reviews &&
      notify_member_ids == o.notify_member_ids &&
      instructions == o.instructions
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



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
270
271
272
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 236

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 302

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 215

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


202
203
204
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



208
209
210
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 208

def hash
  [_id, _version, creation_date, requestor_id, review_status, status, applied_by_member_id, applied_date, all_reviews, notify_member_ids, instructions].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



159
160
161
162
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 159

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



282
283
284
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 282

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



288
289
290
291
292
293
294
295
296
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 288

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



276
277
278
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 276

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



166
167
168
169
170
 
# File 'lib/launchdarkly_api/models/approval_request.rb', line 166

def valid?
  status_validator = EnumAttributeValidator.new('String', ['pending', 'completed', 'failed'])
  return false unless status_validator.valid?(@status)
  true
end