PbmCapabilityMetadata

PbmCapabilityMetadata
PbmCapabilityMetadata

Metadata for a single unique setting defined by a provider.

A simple setting is a setting with one property. A complex setting contains more than one property.

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

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "id": {
        "_typeName": "string",
        "namespace": "string",
        "id": "string"
    },
    "summary": {
        "_typeName": "string",
        "label": "string",
        "summary": "string",
        "key": "string",
        "messageCatalogKeyPrefix": "string",
        "messageArg": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ]
    },
    "mandatory": false,
    "hint": false,
    "keyId": "string",
    "allowMultipleConstraints": false,
    "propertyMetadata": [
        {
            "_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"
        }
    ]
}
id
Required

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

summary
Required

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

boolean
mandatory
Optional

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

boolean
hint
Optional

The flag hint dictates the interpretation of constraints specified for this capability in a storage policy profile.

If hint is false, then constraints will affect placement. If hint is true, constraints will not affect placement, but will still be passed to provisioning operations if the provider understands the relevant namespace. Optional property, false if not set.

string
keyId
Optional

Property Id of the key property, if this capability represents a key value pair.

Value is empty string if not set.

boolean
allowMultipleConstraints
Optional

Flag to indicate if multiple constraints are allowed in the capability instance.

False if not set.

propertyMetadata
Required

Metadata for the properties that comprise this capability.