Class: Forgejo::ContentsResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/forgejo/models/contents_response.rb

Overview

ContentsResponse contains information about a repo’s entry’s (dir, file, symlink, submodule) metadata and content

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContentsResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/forgejo/models/contents_response.rb', line 114

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



19
20
21
 
# File 'lib/forgejo/models/contents_response.rb', line 19

def _links
  @_links
end

#content ⇒ Object

‘content` is populated when `type` is `file`, otherwise null



22
23
24
 
# File 'lib/forgejo/models/contents_response.rb', line 22

def content
  @content
end

#download_url ⇒ Object

Returns the value of attribute download_url.



24
25
26
 
# File 'lib/forgejo/models/contents_response.rb', line 24

def download_url
  @download_url
end

#encoding ⇒ Object

‘encoding` is populated when `type` is `file`, otherwise null



27
28
29
 
# File 'lib/forgejo/models/contents_response.rb', line 27

def encoding
  @encoding
end

#git_url ⇒ Object

Returns the value of attribute git_url.



29
30
31
 
# File 'lib/forgejo/models/contents_response.rb', line 29

def git_url
  @git_url
end

#html_url ⇒ Object

Returns the value of attribute html_url.



31
32
33
 
# File 'lib/forgejo/models/contents_response.rb', line 31

def html_url
  @html_url
end

#last_commit_sha ⇒ Object

Returns the value of attribute last_commit_sha.



33
34
35
 
# File 'lib/forgejo/models/contents_response.rb', line 33

def last_commit_sha
  @last_commit_sha
end

#name ⇒ Object

Returns the value of attribute name.



35
36
37
 
# File 'lib/forgejo/models/contents_response.rb', line 35

def name
  @name
end

#path ⇒ Object

Returns the value of attribute path.



37
38
39
 
# File 'lib/forgejo/models/contents_response.rb', line 37

def path
  @path
end

#sha ⇒ Object

Returns the value of attribute sha.



39
40
41
 
# File 'lib/forgejo/models/contents_response.rb', line 39

def sha
  @sha
end

#size ⇒ Object

Returns the value of attribute size.



41
42
43
 
# File 'lib/forgejo/models/contents_response.rb', line 41

def size
  @size
end

#submodule_git_url ⇒ Object

‘submodule_git_url` is populated when `type` is `submodule`, otherwise null



44
45
46
 
# File 'lib/forgejo/models/contents_response.rb', line 44

def submodule_git_url
  @submodule_git_url
end

#target ⇒ Object

‘target` is populated when `type` is `symlink`, otherwise null



47
48
49
 
# File 'lib/forgejo/models/contents_response.rb', line 47

def target
  @target
end

#type ⇒ Object

‘type` will be `file`, `dir`, `symlink`, or `submodule`



50
51
52
 
# File 'lib/forgejo/models/contents_response.rb', line 50

def type
  @type
end

#url ⇒ Object

Returns the value of attribute url.



52
53
54
 
# File 'lib/forgejo/models/contents_response.rb', line 52

def url
  @url
end

Class Method Details

._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



265
266
267
268
269
270
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
 
# File 'lib/forgejo/models/contents_response.rb', line 265

def self._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 = Forgejo.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



76
77
78
 
# File 'lib/forgejo/models/contents_response.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/forgejo/models/contents_response.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/forgejo/models/contents_response.rb', line 55

def self.attribute_map
  {
    :'_links' => :'_links',
    :'content' => :'content',
    :'download_url' => :'download_url',
    :'encoding' => :'encoding',
    :'git_url' => :'git_url',
    :'html_url' => :'html_url',
    :'last_commit_sha' => :'last_commit_sha',
    :'name' => :'name',
    :'path' => :'path',
    :'sha' => :'sha',
    :'size' => :'size',
    :'submodule_git_url' => :'submodule_git_url',
    :'target' => :'target',
    :'type' => :'type',
    :'url' => :'url'
  }
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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/forgejo/models/contents_response.rb', line 241

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



107
108
109
110
 
# File 'lib/forgejo/models/contents_response.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/forgejo/models/contents_response.rb', line 86

def self.openapi_types
  {
    :'_links' => :'FileLinksResponse',
    :'content' => :'String',
    :'download_url' => :'String',
    :'encoding' => :'String',
    :'git_url' => :'String',
    :'html_url' => :'String',
    :'last_commit_sha' => :'String',
    :'name' => :'String',
    :'path' => :'String',
    :'sha' => :'String',
    :'size' => :'Integer',
    :'submodule_git_url' => :'String',
    :'target' => :'String',
    :'type' => :'String',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/forgejo/models/contents_response.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _links == o._links &&
      content == o.content &&
      download_url == o.download_url &&
      encoding == o.encoding &&
      git_url == o.git_url &&
      html_url == o.html_url &&
      last_commit_sha == o.last_commit_sha &&
      name == o.name &&
      path == o.path &&
      sha == o.sha &&
      size == o.size &&
      submodule_git_url == o.submodule_git_url &&
      target == o.target &&
      type == o.type &&
      url == o.url
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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/forgejo/models/contents_response.rb', line 336

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


228
229
230
 
# File 'lib/forgejo/models/contents_response.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



234
235
236
 
# File 'lib/forgejo/models/contents_response.rb', line 234

def hash
  [_links, content, download_url, encoding, git_url, html_url, last_commit_sha, name, path, sha, size, submodule_git_url, target, type, url].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



191
192
193
194
195
 
# File 'lib/forgejo/models/contents_response.rb', line 191

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



312
313
314
 
# File 'lib/forgejo/models/contents_response.rb', line 312

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/forgejo/models/contents_response.rb', line 318

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



306
307
308
 
# File 'lib/forgejo/models/contents_response.rb', line 306

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



199
200
201
202
 
# File 'lib/forgejo/models/contents_response.rb', line 199

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end