Class: Carbon::PRComment

Inherits:
Object
  • Object
show all
Defined in:
lib/carbon_ruby_sdk/models/pr_comment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PRComment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
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
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
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 91

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

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

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

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

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

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

  if attributes.key?(:'body')
    self.body = attributes[:'body']
  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

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

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

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

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body.



26
27
28
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 26

def body
  @body
end

#created_at ⇒ Object

Returns the value of attribute created_at.



28
29
30
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 28

def created_at
  @created_at
end

#diff_hunk ⇒ Object

Returns the value of attribute diff_hunk.



20
21
22
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 20

def diff_hunk
  @diff_hunk
end

#id ⇒ Object

Returns the value of attribute id.



14
15
16
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 14

def id
  @id
end

#line ⇒ Object

Returns the value of attribute line.



34
35
36
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 34

def line
  @line
end

#path ⇒ Object

Returns the value of attribute path.



22
23
24
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 22

def path
  @path
end

#pull_request_review_id ⇒ Object

Returns the value of attribute pull_request_review_id.



16
17
18
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 16

def pull_request_review_id
  @pull_request_review_id
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



36
37
38
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 36

def remote_data
  @remote_data
end

#start_line ⇒ Object

Returns the value of attribute start_line.



32
33
34
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 32

def start_line
  @start_line
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



30
31
32
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 30

def updated_at
  @updated_at
end

#url ⇒ Object

Returns the value of attribute url.



18
19
20
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 18

def url
  @url
end

#user ⇒ Object

Returns the value of attribute user.



24
25
26
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 24

def user
  @user
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



57
58
59
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 57

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 39

def self.attribute_map
  {
    :'id' => :'id',
    :'pull_request_review_id' => :'pull_request_review_id',
    :'url' => :'url',
    :'diff_hunk' => :'diff_hunk',
    :'path' => :'path',
    :'user' => :'user',
    :'body' => :'body',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'start_line' => :'start_line',
    :'line' => :'line',
    :'remote_data' => :'remote_data'
  }
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



240
241
242
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 240

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
84
85
86
87
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 80

def self.openapi_nullable
  Set.new([
    :'pull_request_review_id',
    :'start_line',
    :'line',
    :'remote_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 62

def self.openapi_types
  {
    :'id' => :'Integer',
    :'pull_request_review_id' => :'Integer',
    :'url' => :'String',
    :'diff_hunk' => :'String',
    :'path' => :'String',
    :'user' => :'User',
    :'body' => :'String',
    :'created_at' => :'String',
    :'updated_at' => :'String',
    :'start_line' => :'Integer',
    :'line' => :'Integer',
    :'remote_data' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      pull_request_review_id == o.pull_request_review_id &&
      url == o.url &&
      diff_hunk == o.diff_hunk &&
      path == o.path &&
      user == o.user &&
      body == o.body &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      start_line == o.start_line &&
      line == o.line &&
      remote_data == o.remote_data
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



271
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
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 271

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 = Carbon.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 342

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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 247

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


227
228
229
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



233
234
235
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 233

def hash
  [id, pull_request_review_id, url, diff_hunk, path, user, body, created_at, updated_at, start_line, line, remote_data].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



155
156
157
158
159
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
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 155

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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

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

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

  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



318
319
320
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 318

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 324

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

Returns:

  • (String) —

    String presentation of the object



312
313
314
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 312

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



194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/carbon_ruby_sdk/models/pr_comment.rb', line 194

def valid?
  return false if @id.nil?
  return false if @url.nil?
  return false if @diff_hunk.nil?
  return false if @path.nil?
  return false if @user.nil?
  return false if @body.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  true
end