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

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

Feedback

Was this page helpful?