com.files.models

Class UsageSnapshot

java.lang.Object

com.files.models.UsageSnapshot

All Implemented Interfaces:

ModelInterface

public class UsageSnapshot
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Double	bytesSent Transfer Usage for period - Outbound GB from Files Native Storage
Double	currentStorage Current total Storage Usage GB as of end date (not necessarily high water mark, which is used for billing)
Double	deletedFilesCountedInMinimum Storage Usage for files that are deleted but uploaded within last 30 days as of end date (not necessarily high water mark, which is used for billing)
Double	deletedFilesStorage Storage Usage for files that are deleted but retained as backups as of end date (not necessarily high water mark, which is used for billing)
Date	endAt Usage snapshot end date/time
Double	highWaterStorage Highest Storage Usage GB recorded in time period (used for billing)
Double	highWaterUserCount Highest user count number in time period
Long	id Usage snapshot ID
Double	rootStorage Storage Usage for root folder as of end date (not necessarily high water mark, which is used for billing)
Date	startAt Usage snapshot start date/time
Double	syncBytesReceived Transfer Usage for period - Inbound GB to Remote Servers (Sync/Mount)
Double	syncBytesSent Transfer Usage for period - Outbound GB from Remote Servers (Sync/Mount)
Double	totalBillableTransferUsage Transfer usage for period - Total Billable amount
Double	totalBillableUsage Storage + Transfer Usage - Total Billable amount
Map<String,String>	usageByTopLevelDir Storage Usage - map of root folders to their usage as of end date (not necessarily high water mark, which is used for billing)

Constructor Summary

Constructors

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

Method Summary

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

Usage snapshot ID

startAt

public Date startAt

Usage snapshot start date/time

endAt

public Date endAt

Usage snapshot end date/time

highWaterUserCount

public Double highWaterUserCount

Highest user count number in time period

currentStorage

public Double currentStorage

Current total Storage Usage GB as of end date (not necessarily high water mark, which is used for billing)

highWaterStorage

public Double highWaterStorage

Highest Storage Usage GB recorded in time period (used for billing)

usageByTopLevelDir

public Map<String,String> usageByTopLevelDir

Storage Usage - map of root folders to their usage as of end date (not necessarily high water mark, which is used for billing)

rootStorage

public Double rootStorage

Storage Usage for root folder as of end date (not necessarily high water mark, which is used for billing)

deletedFilesCountedInMinimum

public Double deletedFilesCountedInMinimum

Storage Usage for files that are deleted but uploaded within last 30 days as of end date (not necessarily high water mark, which is used for billing)

deletedFilesStorage

public Double deletedFilesStorage

Storage Usage for files that are deleted but retained as backups as of end date (not necessarily high water mark, which is used for billing)

totalBillableUsage

public Double totalBillableUsage

Storage + Transfer Usage - Total Billable amount

totalBillableTransferUsage

public Double totalBillableTransferUsage

Transfer usage for period - Total Billable amount

bytesSent

public Double bytesSent

Transfer Usage for period - Outbound GB from Files Native Storage

syncBytesReceived

public Double syncBytesReceived

Transfer Usage for period - Inbound GB to Remote Servers (Sync/Mount)

syncBytesSent

public Double syncBytesSent

Transfer Usage for period - Outbound GB from Remote Servers (Sync/Mount)

Constructor Detail

UsageSnapshot

public UsageSnapshot()

UsageSnapshot

public UsageSnapshot(HashMap<String,Object> parameters)

UsageSnapshot

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

Method Detail

list

public static ListIterator<UsageSnapshot> 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).

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<UsageSnapshot> all()
                                       throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException