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
-
#api_usage_available ⇒ Object
boolean - True if the API usage fields ‘read_api_usage` and `write_api_usage` can be relied upon.
-
#current_storage ⇒ Object
int64 - GB of Files Native Storage used on this day.
-
#date ⇒ Object
date - The date of this usage record.
-
#deleted_files_counted_in_minimum ⇒ Object
int64 - GB of Files Native Storage used on this day for files that have been permanently deleted but were uploaded less than 30 days ago, and are still billable.
-
#deleted_files_storage ⇒ Object
int64 - GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.
-
#id ⇒ Object
int64 - ID of the usage record.
-
#initialize(attributes = {}, options = {}) ⇒ UsageDailySnapshot
constructor
A new instance of UsageDailySnapshot.
-
#read_api_usage ⇒ Object
int64 - Read API Calls used on this day.
-
#root_storage ⇒ Object
int64 - GB of Files Native Storage used for the root folder.
-
#usage_by_top_level_dir ⇒ Object
object - Usage broken down by each top-level folder.
-
#user_count ⇒ Object
int64 - Number of billable users as of this day.
-
#write_api_usage ⇒ Object
int64 - Write API Calls used on this day.
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
93 94 95 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 93 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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev 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 `date` and `usage_snapshot_id`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 77 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
#api_usage_available ⇒ Object
boolean - True if the API usage fields ‘read_api_usage` and `write_api_usage` can be relied upon. If this is false, we suggest hiding that value from any UI.
23 24 25 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 23 def api_usage_available @attributes[:api_usage_available] end |
#current_storage ⇒ Object
int64 - GB of Files Native Storage used on this day.
43 44 45 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 43 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 |
#deleted_files_counted_in_minimum ⇒ Object
int64 - GB of Files Native Storage used on this day for files that have been permanently deleted but were uploaded less than 30 days ago, and are still billable.
53 54 55 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 53 def deleted_files_counted_in_minimum @attributes[:deleted_files_counted_in_minimum] end |
#deleted_files_storage ⇒ Object
int64 - GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.
48 49 50 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 48 def deleted_files_storage @attributes[:deleted_files_storage] 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 |
#read_api_usage ⇒ Object
int64 - Read API Calls used on this day. Note: only updated for days before the current day.
28 29 30 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 28 def read_api_usage @attributes[:read_api_usage] end |
#root_storage ⇒ Object
int64 - GB of Files Native Storage used for the root folder. Included here because this value will not be part of ‘usage_by_top_level_dir`
58 59 60 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 58 def root_storage @attributes[:root_storage] end |
#usage_by_top_level_dir ⇒ Object
object - Usage broken down by each top-level folder
63 64 65 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 63 def usage_by_top_level_dir @attributes[:usage_by_top_level_dir] end |
#user_count ⇒ Object
int64 - Number of billable users as of this day.
38 39 40 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 38 def user_count @attributes[:user_count] end |
#write_api_usage ⇒ Object
int64 - Write API Calls used on this day. Note: only updated for days before the current day.
33 34 35 |
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 33 def write_api_usage @attributes[:write_api_usage] end |