task_filters

Creates, updates, deletes, gets or lists a task_filters resource.

Overview

Name	task_filters
Type	Resource
Id	ovh.email_domain.task_filters

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Id of task
account	string	Account name of task
action	string	Action of task
domain	string	Domain name of task
timestamp	string (date-time)	Creation date of task

list

Task filter List

Name	Datatype	Description
id	integer	Id of task
account	string	Account name of task
action	string	Action of task
domain	string	Domain name of task
timestamp	string (date-time)	Creation date of task

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, id		Get a filter task. Returns the action, the account, the domain and the creation time (timestamp) of the filter task.
list	select	domain	account, x_pagination_mode	List filter tasks. Returns the IDs of the pending filter tasks of the domain. Filter them by account to see one email account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
domain	string	Name of your domain name
id	integer	Id of task
account	string	Account name
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a filter task. Returns the action, the account, the domain and the creation time (timestamp) of the filter task.

SELECT
id,
account,
action,
domain,
timestamp
FROM ovh.email_domain.task_filters
WHERE domain = '{{ domain }}' -- required
AND id = '{{ id }}' -- required
;

list

List filter tasks. Returns the IDs of the pending filter tasks of the domain. Filter them by account to see one email account.

SELECT
id,
account,
action,
domain,
timestamp
FROM ovh.email_domain.task_filters
WHERE domain = '{{ domain }}' -- required
AND account = '{{ account }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;