Data Object - CnsCursor(vim.cns.Cursor)

Property of: CnsQueryFilter, CnsQueryResult
Extends: DynamicData
Since: vSAN API vSAN 6.7U3

Data Object Description

Cursor object to facilitate pagination of multi-value result for an operation, such as querying volumes.
Usage: Client can set desired values of offset and limit in the first request. Cursor will also be returned as part of result, pointing to next set of values. Client can simply put the cursor object from result back in the next request.
If client does not set cursor object for the request, default offset 0 and default limit 100 will be used. The returned cursor object will set offset to next offset and limit to the default limit.

Properties

Name	Type	Description
limit	xsd:long	Limit value sets upper cap for maximum number of values to be included in result. Default value for limit is 100 and maximum is 1000 (implementation dependent. Subject to change). If a value higher than maximum allowed is set in input, it will be limited to the maximum.
offset	xsd:long	Offset value. These many results will be skipped and not included in result.
totalRecords*	xsd:long	This is the total number of records for given input parameters. This value should be used by client to decide if there is a need to make further calls to server. Client request with offset greater than total number of records would have empty result.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="CnsCursor">
            <complexContent>
               <extension base="vsan:DynamicData">
                  <sequence>
                     <element name="offset" type="xsd:long"/>
                     <element name="limit" type="xsd:long"/>
                     <element name="totalRecords" type="xsd:long" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>