cis tasks: filter spec

The filter_spec structure contains fields used to filter the results when listing tasks (see list). If multiple fields are specified, only tasks matching all of the fields match the filter.

Currently at least one of cis.tasks.filter_spec.tasks or cis.tasks.filter_spec.services must be specified and not empty.

. This structure was added in vSphere API 6.7.1.

Representation:

{
    "operations"[
        "obj-103",
        "obj-103"
    ],
    "services"[
        "obj-103",
        "obj-103"
    ],
    "targets"[
        {
            "id""obj-103",
            "type""string"
        },
        {
            "id""obj-103",
            "type""string"
        }
    ],
    "tasks"[
        "obj-103",
        "obj-103"
    ],
    "users"[
        "string",
        "string"
    ],
    "status"[
        "PENDING",
        "PENDING"
    ]
}

Attributes:

Name Type Description
Required
targets[].type string The type of resource being identified (for example com.acme.Person).

Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types.

targets[].id string The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type.

When clients pass a value of this structure as a parameter, the field type must contain the actual resource type. When operations return a value of this structure as a result, the field type will contain the actual resource type.

Optional
tasks string[] Identifiers of tasks that can match the filter. This attribute was added in vSphere API 6.7.1.

Optional. This field may be unset if services is specified. Currently all tasks must be from the same provider. If unset or empty, tasks with any identifier will match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.cis.task. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.cis.task.

services string[] Identifiers of services. Tasks created by operations in these services match the filter (see cis.task.common_info.service). This attribute was added in vSphere API 6.7.1.

Optional. This field may be unset if tasks is specified. Currently all services must be from the same provider. If this field is unset or empty, tasks for any service will match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vapi.service. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vapi.service.

operations string[] Identifiers of operations. Tasks created by these operations match the filter (see cis.task.common_info.operation).

Note that an operation identifier by itself is not globally unique. To filter on an operation, the identifier of the service interface containing the operation should also be specified in services.

. This attribute was added in vSphere API 7.0.0.

Optional. If unset or empty, tasks associated with any operation will match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vapi.operation. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vapi.operation.

status string[] Status that a task must have to match the filter (see cis.task.common_info.status). This attribute was added in vSphere API 6.7.1.

Optional. If unset or empty, tasks with any status match the filter.

targets dynamic_ID[] Identifiers of the targets the operation for the associated task created or was performed on (see cis.task.common_info.target). This attribute was added in vSphere API 6.7.1.

Optional. If unset or empty, tasks associated with operations on any target match the filter.

users string[] Users who must have initiated the operation for the associated task to match the filter (see cis.task.common_info.user). This attribute was added in vSphere API 6.7.1.

Optional. If unset or empty, tasks associated with operations initiated by any user match the filter.