Snapservice.Tasks.FilterSpec

The Snapservice.Tasks.FilterSpec schema contains properties used to filter the results when listing tasks (see GET /snapservice/tasks). If multiple properties are specified, only tasks matching all of the properties match the filter.

Currently at least one of Snapservice.Tasks.FilterSpec.tasks or Snapservice.Tasks.FilterSpec.services must be specified and not empty.

This schema was added in vSphere API 8.0.3.0.

JSON Example

{
    "tasks": [
        "string"
    ],
    "operations": [
        "string"
    ],
    "services": [
        "string"
    ],
    "status": [
        "string"
    ],
    "users": [
        "string"
    ]
}

array of string

tasks

Optional

Identifiers of tasks that can match the filter.

This property was added in vSphere API 8.0.3.0.

This property may be missing or null if other filters are specified. If missing or null or empty, tasks with any identifier will match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.snapservice.task. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.snapservice.task.

array of string

operations

Optional

Identifiers of operations. Tasks created by these operations match the filter (see Snapservice.Tasks.CommonInfo.operation).

This property was added in vSphere API 8.0.3.0.

If missing or null or empty, tasks associated with any operation will match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.snapservice.operation. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.snapservice.operation.

array of string

services

Optional

Identifiers of services. Tasks created by operations in these services match the filter (see Snapservice.Tasks.CommonInfo.service).

This property was added in vSphere API 8.0.3.0.

This property may be missing or null if tasks is specified. If this property is missing or null or empty, tasks for any service will match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.snapservice.service. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.snapservice.service.

array of string

status

Optional

Status that a task must have to match the filter (see Snapservice.Tasks.CommonInfo.status).

Possible values:

PENDING: The operation is in pending state.
RUNNING: The operation is in progress.
BLOCKED: The operation is blocked.

The operation could be blocked if the system is waiting for resources to be available to perform the operation.

SUCCEEDED: The operation completed successfully.
FAILED: The operation failed.

For more information see: Snapservice.Tasks.Status.

This property was added in vSphere API 8.0.3.0.

If missing or null or empty, tasks with any status match the filter.

array of string

users

Optional

Users who must have initiated the operation for the associated task to match the filter (see Snapservice.Tasks.CommonInfo.user).

This property was added in vSphere API 8.0.3.0.

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