RetentionStoreUsage

Represents the total usage of the org's retention store measured at specific points in time. This object is available in API version 66.0 and later.

Supported Calls

describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields

Field Details
AttributeDetail
Type
textarea
Properties
Nillable
Description
(For future use) Additional metadata or contextual details about the usage measurement.
MetricType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Categorizes the type of usage being measured. Only DATA type is currently captured.
  • DATA: Total storage capacity usage (in bytes).
  • FILES: Files and attachments storage capacity usage (in bytes).
  • RECORDS: Retained record count (in rows).
Only DATA type is currently captured.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the retention storage usage record.
OwnerId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the account owner associated with the storage.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
RetentionType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Identifies which retention system this usage record belongs to.
Possible values are:
  • ARCHIVE
  • PRIVACY_CENTER
UnitOfMeasure
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies the unit of measurement for the Usage field value.
Possible values are:
  • BYTES
  • ROWS
Usage
Type
long
Properties
Filter, Group, Nillable, Sort
Description
The numeric usage value in the unit of measure specified in UnitOfMeasure.
UsageDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Timestamp when the usage measurement was captured.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

RetentionStoreUsageOwnerSharingRule
Sharing rules are available for the object.
RetentionStoreUsageShare
Sharing is available for the object.