com.files.models

Class UsageDailySnapshot

java.lang.Object

com.files.models.UsageDailySnapshot

All Implemented Interfaces:

ModelInterface

public class UsageDailySnapshot
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	apiUsageAvailable True if the API usage fields `read_api_usage` and `write_api_usage` can be relied upon.
Long	currentStorage GB of Files Native Storage used on this day.
Date	date The date of this usage record
Long	deletedFilesCountedInMinimum 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.
Long	deletedFilesStorage GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.
Long	id ID of the usage record
Long	readApiUsage Read API Calls used on this day.
Long	rootStorage GB of Files Native Storage used for the root folder.
Map<String,String>	usageByTopLevelDir Usage broken down by each top-level folder
Long	userCount Number of billable users as of this day.
Long	writeApiUsage Write API Calls used on this day.

Constructor Summary

Constructors

Constructor and Description
UsageDailySnapshot()
UsageDailySnapshot(HashMap<String,Object> parameters)
UsageDailySnapshot(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<UsageDailySnapshot>	all()
static ListIterator<UsageDailySnapshot>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<UsageDailySnapshot>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<UsageDailySnapshot>	list(HashMap<String,Object> parameters)
static ListIterator<UsageDailySnapshot>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

id

public Long id

ID of the usage record

date

public Date date

The date of this usage record

apiUsageAvailable

public Boolean apiUsageAvailable

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.

readApiUsage

public Long readApiUsage

Read API Calls used on this day. Note: only updated for days before the current day.

writeApiUsage

public Long writeApiUsage

Write API Calls used on this day. Note: only updated for days before the current day.

userCount

public Long userCount

Number of billable users as of this day.

currentStorage

public Long currentStorage

GB of Files Native Storage used on this day.

deletedFilesStorage

public Long deletedFilesStorage

GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.

deletedFilesCountedInMinimum

public Long deletedFilesCountedInMinimum

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.

rootStorage

public Long rootStorage

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`

usageByTopLevelDir

public Map<String,String> usageByTopLevelDir

Usage broken down by each top-level folder

Constructor Detail

UsageDailySnapshot

public UsageDailySnapshot()

UsageDailySnapshot

public UsageDailySnapshot(HashMap<String,Object> parameters)

UsageDailySnapshot

public UsageDailySnapshot(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)

Method Detail

list

public static ListIterator<UsageDailySnapshot> list()
                                             throws RuntimeException

Parameters: cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. 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. 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 `[ date, usage_snapshot_id ]`. filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `date`. filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`. filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `date`. filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `date`.

Throws:

RuntimeException

list

public static ListIterator<UsageDailySnapshot> list(HashMap<String,Object> parameters)
                                             throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<UsageDailySnapshot> list(HashMap<String,Object> parameters,
                                                    HashMap<String,Object> options)
                                             throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<UsageDailySnapshot> all()
                                            throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<UsageDailySnapshot> all(HashMap<String,Object> parameters,
                                                   HashMap<String,Object> options)
                                            throws RuntimeException

Throws:

RuntimeException