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

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

Feedback

Was this page helpful?