task_domain_arguments

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

Overview

Name	task_domain_arguments
Type	Resource
Id	ovh.me.task_domain_arguments

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
accepted_formats	array	List of accepted formats (wire: acceptedFormats)
accepted_values	array	List of accepted values (wire: acceptedValues)
description	string	Description of the argument
fields	array	List of impacted field names
key	string	Key of the argument
maximum_size	integer	Maximum of the content length that you can send (wire: maximumSize)
minimum_size	integer	Minimum of the content length that you can send (wire: minimumSize)
read_only	boolean	True if the argument is in read only (wire: readOnly)
template	string	Template of the content
type	string	Type of the argument
value	string	Value of the argument

list

Domain operation argument

Name	Datatype	Description
accepted_formats	array	List of accepted formats (wire: acceptedFormats)
accepted_values	array	List of accepted values (wire: acceptedValues)
description	string	Description of the argument
fields	array	List of impacted field names
key	string	Key of the argument
maximum_size	integer	Maximum of the content length that you can send (wire: maximumSize)
minimum_size	integer	Minimum of the content length that you can send (wire: minimumSize)
read_only	boolean	True if the argument is in read only (wire: readOnly)
template	string	Template of the content
type	string	Type of the argument
value	string	Value of the argument

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, key		Get this object properties
list	select	id	x_pagination_mode	List of arguments
update	update	id, key		Alter this object properties

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"}})
id	integer	Id
key	string	Key
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 this object properties

SELECT
accepted_formats,
accepted_values,
description,
fields,
key,
maximum_size,
minimum_size,
read_only,
template,
type,
value
FROM ovh.me.task_domain_arguments
WHERE id = '{{ id }}' -- required
AND key = '{{ key }}' -- required
;

list

List of arguments

SELECT
accepted_formats,
accepted_values,
description,
fields,
key,
maximum_size,
minimum_size,
read_only,
template,
type,
value
FROM ovh.me.task_domain_arguments
WHERE id = '{{ id }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Alter this object properties

UPDATE ovh.me.task_domain_arguments
SET 
value = '{{ value }}'
WHERE 
id = '{{ id }}' --required
AND key = '{{ key }}' --required;