Page

Collection of paging-related metadata to be included by composition via allOf. This type should be included in pageable responses to avoid duplicating these common properties. It is intended to be included by composition rather than inheritance. Because of this, it has no discriminator and should be embedded via allOf. See QueryResults for a reference usage.


Properties

array of Association
associations Optional

Association info for each result.

Added in 33.0

integer
page Optional

The page that was fetched, 1-indexed.


integer
pageCount Optional

How many pages there are in total.


integer
pageSize Optional

Result count for page that was fetched.


integer
resultTotal Optional

How many results there are in total (i.e., considering all pages).

JSON Example

{
    "associations": [
        {
            "associationId": "string",
            "entityId": "string"
        }
    ],
    "page": 0,
    "pageCount": 0,
    "pageSize": 0,
    "resultTotal": 0
}
Returned By

Get Query Result
Used By

RightsBundles
FirewallGroups
ExternalServices
Services
VirtualMachineClasses
BehaviorAccesses
EdgeGateways
ServiceItems
AllowedOrigins
AccessibleLocations
StorageProfiles
ApplicationPortProfiles
PvdcComputePolicies
Sessions
Capabilities
LoadBalancerServiceEngineGroups
LoadBalancerClouds
Configs
VdcComputePolicies
EntityReferences
OrgVdcs
GatewayUsedIpAddresses
VmcSddcs
NsxAlbClouds
Advisories
ServiceApps
EdgeClusters
PvdcStoragePolicies
AccessControlGrants
StoragePolicies
VCenterServers
PreferenceDefinitions
PvdcComputePolicies2
Proxies
DistributedPortGroups
VcdUsers
SecurityTagValues
Certificates
RightsCategoryNodes
Behaviors
FirewallGroupAssociatedVMs
StoragePolicySupportedEntityTypes
GlobalRoles
AllocatedIpAddresses
ExternalNetworks
DefinedEntityTypes
Tokens
DvSwitches
Rights
SddcProxies
Roles
VdcComputePolicies2
UserGroups
ProviderVdcs
NetworkingCandidateVdcs
SecurityTaggedEntities
LoadBalancerControllers
Sddcs
LogicalVmGroups
MetadataEntries
Preferences
VdcGroups
DefinedEntities
ProxyConfigurations
Cells
ResourcePools
StorageContainers
VdcNetworks
DefinedInterfaces
CrossVdcNetworks
EdgeLoadBalancerVirtualServiceSummaries
NetworkContextProfiles
CertificateLibraryItems
UsedIpAddresses
AdvisoryDefinitions
UnmanagedVirtualMachines
VroRemoteWorkflowItems
AuditTrailEvents
CustomEntityTypes
Orgs
NetworkPoolsSummary
AccessLevels
OrgVdcStoragePolicies
SddcEndpoints
QuotaPolicies
EdgeLoadBalancerPoolSummaries
LoadBalancerServiceEngineGroupAssignments
FeatureFlags
PortGroups
Clusters
Feedback

Was this page helpful?