PlacementOptionApiDTO

Description

Model to describe the property of provider options.

Optional Parameters

uuid

  • type: string

displayName

  • type: string

  • description: A user readable name of the api object. Cannot be blank. The UTF-8 encoding must be at most 255 bytes.

className

  • type: string

constraintType

  • type: string

  • description: constraint type, if a commodity is AccessCommodity, then the class name of that commodity is a constraint type

  • enum: ['ApplicationCommodity', 'ClusterCommodity', 'DataCenterCommodity', 'DatastoreCommodity etc']

scope

  • description: scope or placement policy

  • reference: BaseApiDTO

target

  • description: for placement policy, if it's an user placement policy is null.

  • reference: TargetApiDTO

numPotentialEntities

  • type: integer

  • format: int32

  • description: example: other VMs, which buys this constraint but not on this host

key

  • type: string

  • description: commodity key, this information is needed when trying to retrieve the intersaction of providers or consumers

currentEntities

  • type: array

  • description: for consumers only. example: VMs, which are currently on this host per constraint they are buying