input_engine_helpers
Creates, updates, deletes, gets or lists an input_engine_helpers resource.
Overview​
| Name | input_engine_helpers |
| Type | Resource |
| Id | ovh.dbaas_logs.input_engine_helpers |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
engine_id | string (uuid) | Input engine UUID (wire: engineId) |
helper_id | string (uuid) | Helper UUID (wire: helperId) |
description | string | Helper description |
sections | array | Helper sections |
title | string | Helper title |
Helper
| Name | Datatype | Description |
|---|---|---|
engine_id | string (uuid) | Input engine UUID (wire: engineId) |
helper_id | string (uuid) | Helper UUID (wire: helperId) |
description | string | Helper description |
sections | array | Helper sections |
title | string | Helper title |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | engine_id, helper_id, service_name | Returns the engine helper. | |
list | select | engine_id, service_name | x_pagination_mode | Returns the engine helpers of the Logs Data Platform service. |
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"}}) |
engine_id | string (uuid) | Engine ID (wire: engineId) |
helper_id | string (uuid) | Helper ID (wire: helperId) |
service_name | string | Service name (wire: serviceName) |
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
- list
Returns the engine helper.
SELECT
engine_id,
helper_id,
description,
sections,
title
FROM ovh.dbaas_logs.input_engine_helpers
WHERE engine_id = '{{ engine_id }}' -- required
AND helper_id = '{{ helper_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Returns the engine helpers of the Logs Data Platform service.
SELECT
engine_id,
helper_id,
description,
sections,
title
FROM ovh.dbaas_logs.input_engine_helpers
WHERE engine_id = '{{ engine_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;