PbmCapabilityPropertyMetadata

PbmCapabilityPropertyMetadata
PbmCapabilityPropertyMetadata

The PbmCapabilityPropertyMetadata data object describes storage capability.

An instance of property metadata may apply to many property instances (PbmCapabilityPropertyInstance).

This structure may be used only with operations rendered under /pbm.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "id": "string",
    "summary": {
        "_typeName": "string",
        "label": "string",
        "summary": "string",
        "key": "string",
        "messageCatalogKeyPrefix": "string",
        "messageArg": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ]
    },
    "mandatory": false,
    "type": {
        "_typeName": "string",
        "typeName": "string"
    },
    "defaultValue": {
        "_typeName": "string"
    },
    "allowedValue": {
        "_typeName": "string"
    },
    "requirementsTypeHint": "string"
}
string
id
Required

Property identifier.

Should be unique within the definition of the capability. Property instances refer to this identifier (PbmCapabilityPropertyInstance.id).

PbmExtendedElementDescription
summary
Required

This structure may be used only with operations rendered under /pbm.

boolean
mandatory
Required

Indicates whether incorporating given capability is mandatory during creation of profile.

PbmCapabilityTypeInfo
type
Optional

The PbmCapabilityTypeInfo data object defines the datatype for a requirement or capability property.

See PbmCapabilityPropertyMetadata.

This structure may be used only with operations rendered under /pbm.

Any
defaultValue
Optional

The base of all data types. Not to be used directly on the wire.

Any
allowedValue
Optional

The base of all data types. Not to be used directly on the wire.

string
requirementsTypeHint
Optional

A hint for data-driven systems that assist in authoring requirements constraints.

Acceptable values defined by PbmBuiltinGenericTypeEnum. A property will typically only have constraints of a given type in requirement profiles, even if it is likely to use constraints of different types across capability profiles. This value, if specified, specifies the expected kind of constraint used in requirement profiles. Considerations for using this information:

  • This is only a hint; any properly formed constraint (see value) is still valid for a requirement profile.
  • If VMW_SET is hinted, then a single value matching the property metadata type is also an expected form of constraint, as the latter is an allowed convenience for expressing a single-member set.
  • If this hint is not specified, then the authoring system may default to a form of constraint determined by its own criteria.
Property Of