TasksFilterSpec

The Tasks.FilterSpec structure contains fields used to filter the results when listing tasks (see Tasks.list). If multiple fields are specified, only tasks matching all of the fields match the filter. Currently at least one of Tasks.FilterSpec.tasks or Tasks.FilterSpec.services must be specified and not empty.


Properties

array of string
operations Optional

Identifiers of operations. Tasks created by these operations match the filter (see CommonInfo.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 Tasks.FilterSpec.services.

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.


array of string
services Optional

Identifiers of services. Tasks created by operations in these services match the filter (see CommonInfo.service). This field may be unset if Tasks.FilterSpec.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.


array of TaskStatus
status Optional

Status that a task must have to match the filter (see CommonInfo.status). If unset or empty, tasks with any status match the filter.

Possible values are: PENDINGRUNNINGBLOCKEDSUCCEEDEDFAILED


array of StdDynamicID
targets Optional

Identifiers of the targets the operation for the associated task created or was performed on (see CommonInfo.target). If unset or empty, tasks associated with operations on any target match the filter.


array of string
tasks Optional

Identifiers of tasks that can match the filter. This field may be unset if Tasks.FilterSpec.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.


array of string
users Optional

Users who must have initiated the operation for the associated task to match the filter (see CommonInfo.user). If unset or empty, tasks associated with operations initiated by any user match the filter.

JSON Example

{
    "operations": [
        "string"
    ],
    "services": [
        "string"
    ],
    "status": "enum",
    "targets": [
        {
            "id": "string",
            "type": "string"
        }
    ],
    "tasks": [
        "string"
    ],
    "users": [
        "string"
    ]
}
Feedback

Was this page helpful?