zfs.tier.rewrite_job_query ========================== Query rewrite jobs, optionally filtered by status. .. raw:: html
ZfsTierRewriteJobQueryArgs parameters.
No Additional PropertiesLimit results to jobs in the specified states. Pass null or omit to return all jobs.
List of filters for query results. See API documentation for "Query Methods" for more guidance.
No Additional Items[
[
"name",
"=",
"bob"
]
]
[
[
"OR",
[
[
"name",
"=",
"bob"
],
[
"name",
"=",
"larry"
]
]
]
]
Options controlling sort order, pagination, and result format.
No Additional PropertiesExtra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.
An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.
This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
Force use of SQL for result filtering to reduce response time. May not work for all methods.
Rewrite job identifier in dataset_name@job_uuid format.
Must be at least 1 characters long
ZFS dataset this job is operating on.
Must be at least 1 characters long
Unique identifier for this rewrite job.
Must be at least 1 characters long
Current lifecycle state of the job.
COMPLETE - All files in the dataset have been processed.RUNNING - Job is actively processing files.QUEUED - Job is waiting for a free execution slot (see max_concurrent_jobs).CANCELLED - Job was stopped via zfs_tier_job.cancel. Not resumable.STOPPED - Job was RUNNING but its process is no longer active (e.g. daemon restart). This state is computed on read and is never written to persistent storage.ERROR - Job halted due to an unrecoverable error. Use zfs_tier_job.recover to retry failed files.Rewrite job identifier in dataset_name@job_uuid format.
Must be at least 1 characters long
ZFS dataset this job is operating on.
Must be at least 1 characters long
Unique identifier for this rewrite job.
Must be at least 1 characters long
Current lifecycle state of the job.
COMPLETE - All files in the dataset have been processed.RUNNING - Job is actively processing files.QUEUED - Job is waiting for a free execution slot (see max_concurrent_jobs).CANCELLED - Job was stopped via zfs_tier_job.cancel. Not resumable.STOPPED - Job was RUNNING but its process is no longer active (e.g. daemon restart). This state is computed on read and is never written to persistent storage.ERROR - Job halted due to an unrecoverable error. Use zfs_tier_job.recover to retry failed files.