TaskInfoFilterSpecFilterTaskResults

TaskInfoFilterSpecFilterTaskResults
TaskInfoFilterSpecFilterTaskResults

This data object type enables to filter the results information for all or the specified tasks.

1. If removeAll=true, the results information of all tasks will be excluded. 2. If removeAll=false/unset: a. If descriptionIds is empty, the results information of all tasks will be included. b. If descriptionIds is non-empty: i. If filterIn=true, the results information of all tasks will be included. ii. If filterIn=false/unset, the results information of all tasks will be excluded.

Since: vSphere API Release 8.0.3.0

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "removeAll": false,
    "descriptionIds": [
        "string"
    ],
    "filterIn": false
}
boolean
removeAll
Optional

Excludes results information of all tasks.

If set to true, the results information of all tasks will be excluded.

array of string
descriptionIds
Optional

The description IDs of tasks that have to be filtered out.

The filterIn option can switch the behavior to filter in.

boolean
filterIn
Optional

Boolean Flag to invert the filter semantics to filter in the results instead of filtering out.

If set to true, then the results of only the tasks specified by the descriptionIds will be included. If unset or set to false, then the results of only the tasks specified by the descriptionIds will be excluded. This boolean flag will only be considered if descriptionsIds is non-empty and if removeAll is false.

Availability
Added in vSphere API Release 8.0.3.0