PropertySpec

PropertySpec

Within a PropertyFilterSpec, A PropertySpec specifies which properties should be reported to the client for objects of the given managed object type that are visited and not skipped.

One more subtle side effect is that if a managed object is visited and not skipped, but there is no PropertySpec associated with the managed object's type, the managed object will not be reported to the client.

Also, the set of properties applicable to a given managed object type is the union of the properties implied by the PropertySpec objects even, in the case of a RetrieveResult, where there may be an applicable PropertySpec in more than one filter.

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "type": "string",
    "all": false,
    "pathSet": [
        "string"
    ]
}

string

type

Required

Name of the managed object type being collected.

boolean

all

Optional

Specifies whether or not all properties of the object are read.

If this property is set to true, the pathSet property is ignored.

array of string

pathSet

Optional

Specifies which managed object properties are retrieved.

If the pathSet is empty, then the PropertyCollector retrieves references to the managed objects and no managed object properties are collected.

Property Of

ArrayOfPropertySpec

PropertyFilterSpec