XML element SortFilterAttribute

Name: SortFilterAttribute

Data Structure

{
   "typeId": "com.tintri.api.rest.vcommon.dto.warehouse.SortFilterAttribute",
   "actualAttributeName": <String>,
   "associatedDTOSimpleName": <String>,
   "attributeFilterByType": 'STRING' | 'BOOLEAN' | 'ENUM' | 'ENUM_SNAPSHOT_SCHEDULES' | 'NUMERIC',
   "attributeName": <String>,
   "attributeStringValue": <String>,
}

Elements

Name

Type

Description

actualAttributeName

xsd:string

When specifying sorting or filtering on an attribute, REST client will send that attribute in plain text that directly points to the DTO field in DOT notation. For instance, client would have to name "stat.hitRatioPercent" to refer to VirtualMachine.stat.hitRatioPercent. Most or all attributes can be referred to directly. There might be cases where some mappings would have to be done between the attribute name that UI specifies and the actual object field that the back-end understands how to handle. For example, UI may specify "iops" but this method returns "stat.operationalIopsTotal" instead.

associatedDTOSimpleName

xsd:string

Returns simple name of the DTO class which is associated with this SortFilterAttribute. Concrete classes should implement this method and should return the appropriate class name of the DTO.

attributeFilterByType

STRING | BOOLEAN | ENUM | ENUM_SNAPSHOT_SCHEDULES | NUMERIC

STRING
BOOLEAN
ENUM
ENUM_SNAPSHOT_SCHEDULES
NUMERIC

attributeName

xsd:string

attributeStringValue

xsd:string