Class: Files::UsageDailySnapshot
- Inherits:
-
Object
- Object
- Files::UsageDailySnapshot
- Defined in:
- lib/files.com/models/usage_daily_snapshot.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Class Method Summary collapse
- .all(params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: cursor - string - Used for pagination.
Instance Method Summary collapse
-
#current_storage ⇒ Object
int64 - The quantity of storage held for this site.
-
#date ⇒ Object
date - The date of this usage record.
-
#id ⇒ Object
int64 - ID of the usage record.
-
#initialize(attributes = {}, options = {}) ⇒ UsageDailySnapshot
constructor
A new instance of UsageDailySnapshot.
-
#usage_by_top_level_dir ⇒ Object
array - Usage broken down by each top-level folder.
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ UsageDailySnapshot
Returns a new instance of UsageDailySnapshot.
7 8 9 10 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 7 def initialize(attributes = {}, = {}) @attributes = attributes || {} @options = || {} end |
Instance Attribute Details
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
5 6 7 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
58 59 60 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 58 def self.all(params = {}, = {}) list(params, ) end |
.list(params = {}, options = {}) ⇒ Object
Parameters:
cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `date` or `usage_snapshot_id`.
filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 42 def self.list(params = {}, = {}) raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String) raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash) List.new(UsageDailySnapshot, params) do Api.send_request("/usage_daily_snapshots", :get, params, ) end end |
Instance Method Details
#current_storage ⇒ Object
int64 - The quantity of storage held for this site
23 24 25 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 23 def current_storage @attributes[:current_storage] end |
#date ⇒ Object
date - The date of this usage record
18 19 20 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 18 def date @attributes[:date] end |
#id ⇒ Object
int64 - ID of the usage record
13 14 15 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 13 def id @attributes[:id] end |
#usage_by_top_level_dir ⇒ Object
array - Usage broken down by each top-level folder
28 29 30 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 28 def usage_by_top_level_dir @attributes[:usage_by_top_level_dir] end |