Skip to content

flywheel.models.report_usage

ReportUsage

Bases: object

center_compute_ms property writable

Gets the center_compute_ms of this ReportUsage.

The compute time (in ms) used by center-designated jobs in this project during the month (billable to the center)

Returns:

Type Description
int

The center_compute_ms of this ReportUsage

center_job_count property writable

Gets the center_job_count of this ReportUsage.

The number of center-designated gear jobs run in this project during the month (billable to the center)

Returns:

Type Description
int

The center_job_count of this ReportUsage

center_storage_byte_day property writable

Gets the center_storage_byte_day of this ReportUsage.

The storage, in byte-days, used by files originating from devices or center-designated gears in this project during the month (billable to the center)

Returns:

Type Description
int

The center_storage_byte_day of this ReportUsage

center_storage_soft_deleted_byte_day property writable

Gets the center_storage_soft_deleted_byte_day of this ReportUsage.

The storage, in byte-days, used by soft deleted files originating from devices or center-designated gears in this project during the month (billable to the center)

Returns:

Type Description
int

The center_storage_soft_deleted_byte_day of this ReportUsage

days property writable

Gets the days of this ReportUsage.

Number of days captured in this entry (normally the number of days in the month, unless the project was created in that month or it is the current month)

Returns:

Type Description
int

The days of this ReportUsage

group property writable

Gets the group of this ReportUsage.

The group name/ID

Returns:

Type Description
str

The group of this ReportUsage

group_compute_ms property writable

Gets the group_compute_ms of this ReportUsage.

The compute time (in ms) used by non-center-designated (lab) gear jobs in this project during the month (billable to the group)

Returns:

Type Description
int

The group_compute_ms of this ReportUsage

group_job_count property writable

Gets the group_job_count of this ReportUsage.

The number of non-center-designated (lab) gear jobs runin this project during the month (billable to the group)

Returns:

Type Description
int

The group_job_count of this ReportUsage

group_storage_byte_day property writable

Gets the group_storage_byte_day of this ReportUsage.

The storage, in byte-days, used by files not originating from devices or non-center-designated (lab) gears in this project during the month (billable to the group)

Returns:

Type Description
int

The group_storage_byte_day of this ReportUsage

group_storage_soft_deleted_byte_day property writable

Gets the group_storage_soft_deleted_byte_day of this ReportUsage.

The storage, in byte-days, used by soft deleted files not originating from devices or non-center-designated (lab) gears in this project during the month (billable to the group)

Returns:

Type Description
int

The group_storage_soft_deleted_byte_day of this ReportUsage

project property writable

Gets the project of this ReportUsage.

The project ID

Returns:

Type Description
str

The project of this ReportUsage

project_label property writable

Gets the project_label of this ReportUsage.

The project label

Returns:

Type Description
str

The project_label of this ReportUsage

session_count property writable

Gets the session_count of this ReportUsage.

The number of sessions in the project on the last recorded day of the month

Returns:

Type Description
int

The session_count of this ReportUsage

total_compute_ms property writable

Gets the total_compute_ms of this ReportUsage.

The total compute time (in ms) used by gear jobs in this project during the month

Returns:

Type Description
int

The total_compute_ms of this ReportUsage

total_job_count property writable

Gets the total_job_count of this ReportUsage.

The total number of gear jobs run in this project during the month

Returns:

Type Description
int

The total_job_count of this ReportUsage

total_storage_byte_day property writable

Gets the total_storage_byte_day of this ReportUsage.

The total storage, in byte-days, used by files in this project during the month

Returns:

Type Description
int

The total_storage_byte_day of this ReportUsage

total_storage_soft_deleted_byte_day property writable

Gets the total_storage_soft_deleted_byte_day of this ReportUsage.

The total storage, in byte-days, used by soft deleted files in this project during the month

Returns:

Type Description
int

The total_storage_soft_deleted_byte_day of this ReportUsage

__contains__(key)

Checks if the given value is a key in this object

__eq__(other)

Returns true if both objects are equal

__getitem__(key)

Returns the value of key

__init__(project_label=None, group='', project=None, session_count=0, center_job_count=0, group_job_count=0, total_job_count=0, center_compute_ms=0, group_compute_ms=0, total_compute_ms=0, center_storage_byte_day=0, center_storage_soft_deleted_byte_day=0, group_storage_byte_day=0, group_storage_soft_deleted_byte_day=0, total_storage_byte_day=0, total_storage_soft_deleted_byte_day=0, days=0)

ReportUsage - a model defined in Swagger

Parameters:

Name Type Description Default
project_label (str, optional)

The project label, defaults to None

None
group (str, optional)

The group name/ID, defaults to ''

''
project (str, optional)

The project ID, defaults to None

None
session_count (int, optional)

The number of sessions in the project on the last recorded day of the month, defaults to 0

0
center_job_count (int, optional)

The number of center-designated gear jobs run in this project during the month (billable to the center), defaults to 0

0
group_job_count (int, optional)

The number of non-center-designated (lab) gear jobs runin this project during the month (billable to the group), defaults to 0

0
total_job_count (int, optional)

The total number of gear jobs run in this project during the month, defaults to 0

0
center_compute_ms (int, optional)

The compute time (in ms) used by center-designated jobs in this project during the month (billable to the center), defaults to 0

0
group_compute_ms (int, optional)

The compute time (in ms) used by non-center-designated (lab) gear jobs in this project during the month (billable to the group), defaults to 0

0
total_compute_ms (int, optional)

The total compute time (in ms) used by gear jobs in this project during the month, defaults to 0

0
center_storage_byte_day (int, optional)

The storage, in byte-days, used by files originating from devices or center-designated gears in this project during the month (billable to the center), defaults to 0

0
center_storage_soft_deleted_byte_day (int, optional)

The storage, in byte-days, used by soft deleted files originating from devices or center-designated gears in this project during the month (billable to the center), defaults to 0

0
group_storage_byte_day (int, optional)

The storage, in byte-days, used by files not originating from devices or non-center-designated (lab) gears in this project during the month (billable to the group), defaults to 0

0
group_storage_soft_deleted_byte_day (int, optional)

The storage, in byte-days, used by soft deleted files not originating from devices or non-center-designated (lab) gears in this project during the month (billable to the group), defaults to 0

0
total_storage_byte_day (int, optional)

The total storage, in byte-days, used by files in this project during the month, defaults to 0

0
total_storage_soft_deleted_byte_day (int, optional)

The total storage, in byte-days, used by soft deleted files in this project during the month, defaults to 0

0
days (int, optional)

Number of days captured in this entry (normally the number of days in the month, unless the project was created in that month or it is the current month), defaults to 0

0

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

__setitem__(key, value)

Sets the value of key

get(key, default=None)

Get the value of the provided json property, or default

items()

Returns the list of json property to value mapping

keys()

Returns the list of json properties in the object

positional_to_model(value) staticmethod

Converts a positional argument to a model value

return_value()

Unwraps return value from model

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

values()

Returns the list of values in the object