Overview
detail: element | attribute | value

Name: VirtualEntityFilterSpec

Base class for virtual entities like VirtualMachine, VirtualDisk etc. Contains common query parameters that are applicable to any virtual entity.

Data Structure
{
   "typeId": "com.tintri.api.rest.v310.dto.VirtualEntityFilterSpec",
   "allStats": <Boolean>,
   "cloneDedupeFactor": <String>,
   "compressionFactor": <String>,
   "dedupeFactor": <String>,
   "filterAttributeList": [SortFilterAttribute],
   "filterParams": MultivaluedMap,
   "flashHitPercent": <String>,
   "instanceUuid": <String>,
   "ioAlignedPercent": <String>,
   "latencyContentionMs": <String>,
   "latencyDiskMs": <String>,
   "latencyFlashMs": <String>,
   "latencyHostMs": <String>,
   "latencyNetworkMs": <String>,
   "latencyStorageMs": <String>,
   "latencyThrottleMs": <String>,
   "latencyTotalMs": <String>,
   "limit": <Number>,
   "liveLogicalFootprint": <String>,
   "metric": <String>,
   "name": <String>,
   "offset": <Number>,
   "offsetType": 'POSITION' | 'NAME' | 'UUID' | 'INVALID',
   "offsetValue": <Object>,
   "page": <Number>,
   "performanceReserveAutoAllocated": <String>,
   "performanceReserveChange": <String>,
   "performanceReserveChangePercent": <String>,
   "performanceReserveUsed": <String>,
   "qParams": MultivaluedMap,
   "QUERY_JOB_COMPLETION_TIMEOUT_IN_MINUTES_MAX": <Number>,
   "QUERY_TIMEOUT_IN_SEC_DEFAULT": <Number>,
   "QUERY_TIMEOUT_IN_SEC_MAX": <Number>,
   "queryType": 'TOP_DOCS_BY_TIME' | 'TOP_DOCS_BY_LATEST_TIME' | 'OFFSET_BY_TIME' | 'OFFSET_BY_SEQUENCE',
   "refresh": <Boolean>,
   "replLinkId": Uuid,
   "requestSizeKiB": <String>,
   "since": <Date>,
   "sortedBy": <String>,
   "sortOrder": <String>,
   "spaceProvisionedGiB": <String>,
   "spaceSavingsFactor": <String>,
   "spaceUsedChangeGiB": <String>,
   "spaceUsedChangePercent": <String>,
   "spaceUsedGiB": <String>,
   "spaceUsedLiveGiB": <String>,
   "spaceUsedSnapshotsHypervisorGiB": <String>,
   "spaceUsedSnapshotsTintriGiB": <String>,
   "syslogForwarding": <String>,
   "target": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP',
   "timeout": <Number>,
   "totalIops": <String>,
   "totalMBps": <String>,
   "totalNormalizedIops": <String>,
   "totalUsedSpace": <String>,
   "until": <Date>,
   "uuid": <String>,
}
Elements
NameTypeDescription
allStatsxsd:boolean
For query param info, refer to: allStats
cloneDedupeFactorxsd:string
Query Param Info:
Param Name: cloneDedupeFactor
Description: Numeric filter on clone deduplication factor specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.cloneDedupeFactor
  • VirtualMachine.stat.latestSlice.cloneDedupeFactor
Usage: ?cloneDedupeFactor=value
compressionFactorxsd:string
Query Param Info:
Param Name: compressionFactor
Description: Numeric filter on compression factor specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.compressionFactor
  • VirtualMachine.stat.latestSlice.compressionFactor
Usage: ?compressionFactor=value
dedupeFactorxsd:string
Query Param Info: (VMstoreOnly)
Param Name: dedupeFactor
Description: Numeric filter on deduplication factor specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.dedupeFactor
  • VirtualMachine.stat.latestSlice.dedupeFactor
Usage: ?dedupeFactor=value
filterAttributeListxsd:list[SortFilterAttribute]Iterates over all the @Filter query params and builds SortFilterAttribute objects from it. SortFilterAttribute wraps attribute name and String value; per mapped attribute.
filterParamsMultivaluedMap
flashHitPercentxsd:string
Query Param Info: (VMstoreOnly)
Param Name: flashHitPercent
Description: Numeric filter on % flash hit specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.flashHitPercent
  • VirtualMachine.stat.latestSlice.flashHitPercent
Usage: ?flashHitPercent=value
instanceUuidxsd:string
Query Param Info:
Param Name: instanceUuid
Description: Hypervisor provided instance UUID of an entity.
Multivalued: No
Mapped to attributes:
  • VirtualDisk.instanceUuid
  • VirtualMachine.vmware.instanceUuids
Usage: ?instanceUuid=value
ioAlignedPercentxsd:string
Query Param Info: (VMstoreOnly)
Param Name: ioAlignedPercent
Description: Numeric filter on % aligned read and writes specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.ioAlignedPercent
  • VirtualMachine.stat.latestSlice.ioAlignedPercent
Usage: ?ioAlignedPercent=value
latencyContentionMsxsd:string
Query Param Info:
Param Name: latencyContentionMs
Description: Numeric filter on contention latency specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.latencyContentionMs
  • VirtualMachine.stat.latestSlice.latencyContentionMs
Usage: ?latencyContentionMs=value
latencyDiskMsxsd:string
Query Param Info: (VMstoreOnly)
Param Name: latencyDiskMs
Description: Numeric filter on disk latency specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.latencyDiskMs
  • VirtualMachine.stat.latestSlice.latencyDiskMs
Usage: ?latencyDiskMs=value
latencyFlashMsxsd:string
Query Param Info:
Param Name: latencyFlashMs
Description: Numeric filter on flash latency specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.latencyFlashMs
  • VirtualMachine.stat.latestSlice.latencyFlashMs
Usage: ?latencyFlashMs=value
latencyHostMsxsd:string
Query Param Info:
Param Name: latencyHostMs
Description: Numeric filter on host latency specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.latencyHostMs
  • VirtualMachine.stat.latestSlice.latencyHostMs
Usage: ?latencyHostMs=value
latencyNetworkMsxsd:string
Query Param Info:
Param Name: latencyNetworkMs
Description: Numeric filter on network latency specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.latencyNetworkMs
  • VirtualMachine.stat.latestSlice.latencyNetworkMs
Usage: ?latencyNetworkMs=value
latencyStorageMsxsd:string
Query Param Info:
Param Name: latencyStorageMs
Description: Numeric filter on storage latency specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.latencyStorageMs
  • VirtualMachine.stat.latestSlice.latencyStorageMs
Usage: ?latencyStorageMs=value
latencyThrottleMsxsd:string
Query Param Info:
Param Name: latencyThrottleMs
Description: Numeric filter on throttle latency specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.latencyThrottleMs
  • VirtualMachine.stat.latestSlice.latencyThrottleMs
Usage: ?latencyThrottleMs=value
latencyTotalMsxsd:string
Query Param Info:
Param Name: latencyTotalMs
Description: Numeric filter on total latency specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.latencyTotalMs
  • VirtualMachine.stat.latestSlice.latencyTotalMs
Usage: ?latencyTotalMs=value
limitxsd:int
For query param info, refer to: limit
liveLogicalFootprintxsd:string
Query Param Info: (VMstoreOnly)
Param Name: liveLogicalFootprint
Description: Numeric filter on live logical footprint(GiB) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.liveLogicalFootprint
  • VirtualMachine.stat.latestSlice.liveLogicalFootprint
Usage: ?liveLogicalFootprint=value
metricxsd:string
For query param info, refer to: metric
namexsd:string
For query param info, refer to: name
offsetxsd:int
For query param info, refer to: offset
offsetTypePOSITION | NAME | UUID | INVALIDThe offset type of 'offsetValue'.
POSITIONoffsetType is a position in the page
NAMEoffterType is a name string
UUIDofftestType is a name UUID
INVALIDofftestType is invalid
offsetValuexsd:anyThe offset value in the terms of 'offsetType'.
pagexsd:int
For query param info, refer to: page
performanceReserveAutoAllocatedxsd:string
Query Param Info: (VMstoreOnly)
Param Name: performanceReserveAutoAllocated
Description: Numeric filter on performance reserve autoallocated in use specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.performanceReserveAutoAllocated
  • VirtualMachine.stat.latestSlice.performanceReserveAutoAllocated
Usage: ?performanceReserveAutoAllocated=value
performanceReserveChangexsd:string
Query Param Info:
Param Name: performanceReserveChange
Description: Numeric filter on performance reserves change specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.performanceReserveChange
  • VirtualMachine.stat.latestSlice.performanceReserveChange
Usage: ?performanceReserveChange=value
performanceReserveChangePercentxsd:string
Query Param Info: (VMstoreOnly)
Param Name: performanceReserveChangePercent
Description: Numeric filter on '%' change in performance reserves specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.performanceReserveChangePercent
  • VirtualMachine.stat.latestSlice.performanceReserveChangePercent
Usage: ?performanceReserveChangePercent=value
performanceReserveUsedxsd:string
Query Param Info: (VMstoreOnly)
Param Name: performanceReserveUsed
Description: Numeric filter on performance reserves in use specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.performanceReserveUsed
  • VirtualMachine.stat.latestSlice.performanceReserveUsed
Usage: ?performanceReserveUsed=value
qParamsMultivaluedMap
QUERY_JOB_COMPLETION_TIMEOUT_IN_MINUTES_MAXxsd:intMax job completion timeout (in minutes)
QUERY_TIMEOUT_IN_SEC_DEFAULTxsd:intDefault search timeout (in seconds)
QUERY_TIMEOUT_IN_SEC_MAXxsd:intMax search timeout (in seconds)
queryTypeTOP_DOCS_BY_TIME | TOP_DOCS_BY_LATEST_TIME | OFFSET_BY_TIME | OFFSET_BY_SEQUENCE
TOP_DOCS_BY_TIMEsort top contributors by time based on since and until values
TOP_DOCS_BY_LATEST_TIMEsort top contributors by time based on latest update time
OFFSET_BY_TIMEsort by time starting with a time offset
OFFSET_BY_SEQUENCEsort by offset starting with a page offset
For query param info, refer to: queryType
refreshxsd:boolean
For query param info, refer to: refresh
replLinkIdUuid
For query param info, refer to: replLinkId
requestSizeKiBxsd:string
Query Param Info: (VMstoreOnly)
Param Name: requestSizeKiB
Description: Numeric filter on block size (KiB) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.requestSizeKiB
  • VirtualMachine.stat.latestSlice.requestSizeKiB
Usage: ?requestSizeKiB=value
sincexsd:datetime
For query param info, refer to: since
sortedByxsd:string
For query param info, refer to: sortedBy
sortOrderxsd:string
For query param info, refer to: sortOrder
spaceProvisionedGiBxsd:string
Query Param Info:
Param Name: spaceProvisionedGiB
Description: Numeric filter on provisioned space(GiB) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.spaceProvisionedGiB
  • VirtualMachine.stat.latestSlice.spaceProvisionedGiB
Usage: ?spaceProvisionedGiB=value
spaceSavingsFactorxsd:string
Query Param Info:
Param Name: spaceSavingsFactor
Description: Numeric filter on space saving factor specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.spaceSavingsFactor
  • VirtualMachine.stat.latestSlice.spaceSavingsFactor
Usage: ?spaceSavingsFactor=value
spaceUsedChangeGiBxsd:string
Query Param Info:
Param Name: spaceUsedChangeGiB
Description: Numeric filter on space used change(GiB) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.spaceUsedChangeGiB
  • VirtualMachine.stat.latestSlice.spaceUsedChangeGiB
Usage: ?spaceUsedChangeGiB=value
spaceUsedChangePercentxsd:string
Query Param Info:
Param Name: spaceUsedChangePercent
Description: Numeric filter on '%' change in used space specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.spaceUsedChangePercent
  • VirtualMachine.stat.latestSlice.spaceUsedChangePercent
Usage: ?spaceUsedChangePercent=value
spaceUsedGiBxsd:string
Query Param Info:
Param Name: spaceUsedGiB
Description: Numeric filter on used space(GiB) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.spaceUsedGiB
  • VirtualMachine.stat.latestSlice.spaceUsedGiB
Usage: ?spaceUsedGiB=value
spaceUsedLiveGiBxsd:string
Query Param Info:
Param Name: spaceUsedLiveGiB
Description: Numeric filter on live used space(GiB) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.spaceUsedLiveGiB
  • VirtualMachine.stat.latestSlice.spaceUsedLiveGiB
Usage: ?spaceUsedLiveGiB=value
spaceUsedSnapshotsHypervisorGiBxsd:string
Query Param Info:
Param Name: spaceUsedSnapshotsHypervisorGiB
Description: Numeric filter on space used(GiB) by hypervisor created snapshots specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.spaceUsedSnapshotsHypervisorGiB
  • VirtualMachine.stat.latestSlice.spaceUsedSnapshotsHypervisorGiB
Usage: ?spaceUsedSnapshotsHypervisorGiB=value
spaceUsedSnapshotsTintriGiBxsd:string
Query Param Info:
Param Name: spaceUsedSnapshotsTintriGiB
Description: Numeric filter on space used(GiB) by Tintri created snapshots specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.spaceUsedSnapshotsTintriGiB
  • VirtualMachine.stat.latestSlice.spaceUsedSnapshotsTintriGiB
Usage: ?spaceUsedSnapshotsTintriGiB=value
syslogForwardingxsd:string
For query param info, refer to: syslogForwarding
targetVM | VDISK | SNAPSHOT | JOB | ALERTS | DATASTORE_STAT | VM_STAT | VDISK_STAT | SERVICE_GROUP
VMVirtual machine
VDISKVirtual disk
SNAPSHOTSnapshot
JOBJob
ALERTSAlert
DATASTORE_STATDatastore statistics
VM_STATVirtual Machine statistics
VDISK_STATVirtual disk statistics
SERVICE_GROUPService group
For query param info, refer to: target
timeoutxsd:long
For query param info, refer to: timeout
totalIopsxsd:string
Query Param Info:
Param Name: totalIops
Description: Numeric filter on total IOPS specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.operationsTotalIops
  • VirtualMachine.stat.latestSlice.operationsTotalIops
Usage: ?totalIops=value
totalMBpsxsd:string
Query Param Info:
Param Name: totalMBps
Description: Numeric filter on total throughput (MBps) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.throughputTotalMBps
  • VirtualMachine.stat.latestSlice.throughputTotalMBps
Usage: ?totalMBps=value
totalNormalizedIopsxsd:string
Query Param Info:
Param Name: totalNormalizedIops
Description: Numeric filter on total normalized IOPS specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.normalizedTotalIops
  • VirtualMachine.stat.latestSlice.normalizedTotalIops
Usage: ?totalNormalizedIops=value
totalUsedSpacexsd:string
Query Param Info:
Param Name: totalUsedSpace
Description: Numeric filter on physical used space(GiB) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualDisk.stat.spaceUsedPhysicalGiB
  • VirtualMachine.stat.latestSlice.spaceUsedPhysicalGiB
Usage: ?totalUsedSpace=value
untilxsd:datetime
For query param info, refer to: until
uuidxsd:string
For query param info, refer to: uuid
Overview
detail: element | attribute | value
Generated by Lunatech Labs jax-doclets v0.8