vSphere Client SDK API Documentation : version 5.5.0.1300321

com.vmware.vise.data.query
Class ResultSpec

java.lang.Object
  extended by com.vmware.vise.data.query.ResultSpec

@data(base="Object")
public class ResultSpec
extends Object

Describes additional transformations/filters to be applied on the result set.


Field Summary
 com.vmware.vise.data.query.FacetSpec[] facets
          Specification of which facets to compute on the result (internal use only).
 Integer maxResultCount
          The maximum number of results to retrieve.
 Integer offset
          The offset into the result set.
 OrderingCriteria order
          The criteria specifying how the results should be ordered.
 
Constructor Summary
ResultSpec()
           
 
Method Summary
 boolean equals(Object obj)
           
 int hashCode()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

maxResultCount

@optional
public Integer maxResultCount
The maximum number of results to retrieve. By default all results are retrieved.


offset

@optional
public Integer offset
The offset into the result set. If the offset is N then items from N to N + maxResultCount - 1 will be returned. If maxResultCount is not specified then all results greater or equal to the offset will be returned. If no offset is specified value will default to 0.


order

@optional
public OrderingCriteria order
The criteria specifying how the results should be ordered.


facets

@optional
public com.vmware.vise.data.query.FacetSpec[] facets
Specification of which facets to compute on the result (internal use only).

Constructor Detail

ResultSpec

public ResultSpec()
Method Detail

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

vSphere Client SDK API Documentation : version 5.5.0.1300321

Copyright @ 2012 VMware, Inc. All rights reserved.