Class: Carbon::CommentsInput

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CommentsInput

Initializes the object



78
79
80
81
82
83
84
85
86
87
88
89
90
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
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 78

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#data_source_id ⇒ Object

Returns the value of attribute data_source_id.



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

def data_source_id
  @data_source_id
end

#include_remote_data ⇒ Object

Returns the value of attribute include_remote_data.



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

def include_remote_data
  @include_remote_data
end

#next_cursor ⇒ Object

Returns the value of attribute next_cursor.



25
26
27
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 25

def next_cursor
  @next_cursor
end

#order_by ⇒ Object

Returns the value of attribute order_by.



29
30
31
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 29

def order_by
  @order_by
end

#order_dir ⇒ Object

Returns the value of attribute order_dir.



31
32
33
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 31

def order_dir
  @order_dir
end

#page ⇒ Object

Returns the value of attribute page.



21
22
23
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 21

def page
  @page
end

#page_size ⇒ Object

Returns the value of attribute page_size.



23
24
25
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 23

def page_size
  @page_size
end

#pull_number ⇒ Object

Returns the value of attribute pull_number.



27
28
29
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 27

def pull_number
  @pull_number
end

#repository ⇒ Object

Full name of the repository, denoted as owner/repo



19
20
21
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 19

def repository
  @repository
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 34

def self.attribute_map
  {
    :'data_source_id' => :'data_source_id',
    :'include_remote_data' => :'include_remote_data',
    :'repository' => :'repository',
    :'page' => :'page',
    :'page_size' => :'page_size',
    :'next_cursor' => :'next_cursor',
    :'pull_number' => :'pull_number',
    :'order_by' => :'order_by',
    :'order_dir' => :'order_dir'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



210
211
212
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 210

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
73
74
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 69

def self.openapi_nullable
  Set.new([
    :'next_cursor',
    :'order_dir'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 54

def self.openapi_types
  {
    :'data_source_id' => :'Integer',
    :'include_remote_data' => :'Boolean',
    :'repository' => :'String',
    :'page' => :'Integer',
    :'page_size' => :'Integer',
    :'next_cursor' => :'String',
    :'pull_number' => :'Integer',
    :'order_by' => :'CommentsOrderBy',
    :'order_dir' => :'OrderDirV2Nullable'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      data_source_id == o.data_source_id &&
      include_remote_data == o.include_remote_data &&
      repository == o.repository &&
      page == o.page &&
      page_size == o.page_size &&
      next_cursor == o.next_cursor &&
      pull_number == o.pull_number &&
      order_by == o.order_by &&
      order_dir == o.order_dir
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
273
274
275
276
277
278
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 241

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 312

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 217

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

See Also:

  • `==` method


197
198
199
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



203
204
205
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 203

def hash
  [data_source_id, include_remote_data, repository, page, page_size, next_cursor, pull_number, order_by, order_dir].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 138

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

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

  if !@page_size.nil? && @page_size > 100
    invalid_properties.push('invalid value for "page_size", must be smaller than or equal to 100.')
  end

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



288
289
290
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 288

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 294

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



282
283
284
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 282

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



161
162
163
164
165
166
167
 
# File 'lib/carbon_ruby_sdk/models/comments_input.rb', line 161

def valid?
  return false if @data_source_id.nil?
  return false if @repository.nil?
  return false if !@page_size.nil? && @page_size > 100
  return false if @pull_number.nil?
  true
end