Class: RagieRubySdk::PartitionStats

Inherits:
Object
  • Object
show all
Defined in:
lib/ragie_ruby_sdk/models/partition_stats.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PartitionStats

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#audio_processed_monthlyObject

Total number of seconds of audio processed in the current month in this partition.



40
41
42
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 40

def audio_processed_monthly
  @audio_processed_monthly
end

#audio_processed_totalObject

Total number of seconds of audio processed in this partition.



43
44
45
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 43

def audio_processed_total
  @audio_processed_total
end

#document_countObject

Total number of documents, inclusive of all files types, in this partition.



31
32
33
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 31

def document_count
  @document_count
end

#media_hosted_monthlyObject

Total number of MBs hosted in the current month in this partition.



52
53
54
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 52

def media_hosted_monthly
  @media_hosted_monthly
end

#media_hosted_totalObject

Total number of MBs hosted in this partition.



55
56
57
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 55

def media_hosted_total
  @media_hosted_total
end

#media_streamed_monthlyObject

Total number of MBs streamed in the current month in this partition.



46
47
48
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 46

def media_streamed_monthly
  @media_streamed_monthly
end

#media_streamed_totalObject

Total number of MBs streamed in this partition.



49
50
51
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 49

def media_streamed_total
  @media_streamed_total
end

#pages_hosted_monthlyObject

Number of hosted pages added in the current month in this partition.



22
23
24
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 22

def pages_hosted_monthly
  @pages_hosted_monthly
end

#pages_hosted_totalObject

Total number of hosted pages in this partition.



28
29
30
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 28

def pages_hosted_total
  @pages_hosted_total
end

#pages_processed_monthlyObject

Number of pages processed in the current month in this partition.



19
20
21
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 19

def pages_processed_monthly
  @pages_processed_monthly
end

#pages_processed_totalObject

Total number of pages processed in this partition.



25
26
27
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 25

def pages_processed_total
  @pages_processed_total
end

#video_processed_monthlyObject

Total number of seconds of video processed in the current month in this partition.



34
35
36
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 34

def video_processed_monthly
  @video_processed_monthly
end

#video_processed_totalObject

Total number of seconds of video processed in this partition.



37
38
39
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 37

def video_processed_total
  @video_processed_total
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



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 475

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 = RagieRubySdk.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_mapObject

Returns attribute mapping this model knows about



77
78
79
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 77

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



82
83
84
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 82

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 58

def self.attribute_map
  {
    :'pages_processed_monthly' => :'pages_processed_monthly',
    :'pages_hosted_monthly' => :'pages_hosted_monthly',
    :'pages_processed_total' => :'pages_processed_total',
    :'pages_hosted_total' => :'pages_hosted_total',
    :'document_count' => :'document_count',
    :'video_processed_monthly' => :'video_processed_monthly',
    :'video_processed_total' => :'video_processed_total',
    :'audio_processed_monthly' => :'audio_processed_monthly',
    :'audio_processed_total' => :'audio_processed_total',
    :'media_streamed_monthly' => :'media_streamed_monthly',
    :'media_streamed_total' => :'media_streamed_total',
    :'media_hosted_monthly' => :'media_hosted_monthly',
    :'media_hosted_total' => :'media_hosted_total'
  }
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



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 451

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_nullableObject

List of attributes with nullable: true



106
107
108
109
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 106

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

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'pages_processed_monthly' => :'Float',
    :'pages_hosted_monthly' => :'Float',
    :'pages_processed_total' => :'Float',
    :'pages_hosted_total' => :'Float',
    :'document_count' => :'Integer',
    :'video_processed_monthly' => :'Float',
    :'video_processed_total' => :'Float',
    :'audio_processed_monthly' => :'Float',
    :'audio_processed_total' => :'Float',
    :'media_streamed_monthly' => :'Float',
    :'media_streamed_total' => :'Float',
    :'media_hosted_monthly' => :'Float',
    :'media_hosted_total' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 418

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pages_processed_monthly == o.pages_processed_monthly &&
      pages_hosted_monthly == o.pages_hosted_monthly &&
      pages_processed_total == o.pages_processed_total &&
      pages_hosted_total == o.pages_hosted_total &&
      document_count == o.document_count &&
      video_processed_monthly == o.video_processed_monthly &&
      video_processed_total == o.video_processed_total &&
      audio_processed_monthly == o.audio_processed_monthly &&
      audio_processed_total == o.audio_processed_total &&
      media_streamed_monthly == o.media_streamed_monthly &&
      media_streamed_total == o.media_streamed_total &&
      media_hosted_monthly == o.media_hosted_monthly &&
      media_hosted_total == o.media_hosted_total
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



546
547
548
549
550
551
552
553
554
555
556
557
558
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 546

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


438
439
440
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 438

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



444
445
446
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 444

def hash
  [pages_processed_monthly, pages_hosted_monthly, pages_processed_total, pages_hosted_total, document_count, video_processed_monthly, video_processed_total, audio_processed_monthly, audio_processed_total, media_streamed_monthly, media_streamed_total, media_hosted_monthly, media_hosted_total].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
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
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 208

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

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

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

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



522
523
524
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 522

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



528
529
530
531
532
533
534
535
536
537
538
539
540
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 528

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



516
517
518
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 516

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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
# File 'lib/ragie_ruby_sdk/models/partition_stats.rb', line 268

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @pages_processed_monthly.nil?
  return false if @pages_hosted_monthly.nil?
  return false if @pages_processed_total.nil?
  return false if @pages_hosted_total.nil?
  return false if @document_count.nil?
  return false if @video_processed_monthly.nil?
  return false if @video_processed_total.nil?
  return false if @audio_processed_monthly.nil?
  return false if @audio_processed_total.nil?
  return false if @media_streamed_monthly.nil?
  return false if @media_streamed_total.nil?
  return false if @media_hosted_monthly.nil?
  return false if @media_hosted_total.nil?
  true
end