output_graylog_stream_rules

Creates, updates, deletes, gets or lists an output_graylog_stream_rules resource.

Overview

Name	output_graylog_stream_rules
Type	Resource
Id	ovh.dbaas_logs.output_graylog_stream_rules

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
rule_id	string (uuid)	Stream rule ID (wire: ruleId)
field	string	Field name
is_inverted	boolean	Invert condition (wire: isInverted)
operator	string	Field operator (FIELD_PRESENCE, GREATER_THAN, MATCH_EXACTLY, SMALLER_THAN)
value	string	Field value

list

Stream rule

Name	Datatype	Description
rule_id	string (uuid)	Stream rule ID (wire: ruleId)
field	string	Field name
is_inverted	boolean	Invert condition (wire: isInverted)
operator	string	Field operator (FIELD_PRESENCE, GREATER_THAN, MATCH_EXACTLY, SMALLER_THAN)
value	string	Field value

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	rule_id, service_name, stream_id		Returns the stream rule.
list	select	service_name, stream_id	x_pagination_mode	Returns the stream rules of the Logs Data Platform service.
create	insert	service_name, stream_id, field, operator, value		Creates a stream rule on the Logs Data Platform service.
delete	delete	rule_id, service_name, stream_id		Deletes the stream rule.

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"}})
rule_id	string (uuid)	Rule ID (wire: ruleId)
service_name	string	Service name (wire: serviceName)
stream_id	string (uuid)	Stream ID (wire: streamId)
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

Returns the stream rule.

SELECT
rule_id,
field,
is_inverted,
operator,
value
FROM ovh.dbaas_logs.output_graylog_stream_rules
WHERE rule_id = '{{ rule_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND stream_id = '{{ stream_id }}' -- required
;

list

Returns the stream rules of the Logs Data Platform service.

SELECT
rule_id,
field,
is_inverted,
operator,
value
FROM ovh.dbaas_logs.output_graylog_stream_rules
WHERE service_name = '{{ service_name }}' -- required
AND stream_id = '{{ stream_id }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Creates a stream rule on the Logs Data Platform service.

INSERT INTO ovh.dbaas_logs.output_graylog_stream_rules (
field,
is_inverted,
operator,
value,
service_name,
stream_id
)
SELECT 
'{{ field }}' /* required */,
{{ is_inverted }},
'{{ operator }}' /* required */,
'{{ value }}' /* required */,
'{{ service_name }}',
'{{ stream_id }}'
RETURNING
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: output_graylog_stream_rules
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the output_graylog_stream_rules resource.
  - name: stream_id
    value: "{{ stream_id }}"
    description: Required parameter for the output_graylog_stream_rules resource.
  - name: field
    value: "{{ field }}"
    description: |
      Field name
  - name: is_inverted
    value: {{ is_inverted }}
    description: |
      Invert condition
  - name: operator
    value: "{{ operator }}"
    description: |
      Field operator
    valid_values: ['FIELD_PRESENCE', 'GREATER_THAN', 'MATCH_EXACTLY', 'SMALLER_THAN']
  - name: value
    value: "{{ value }}"
    description: |
      Field value

DELETE examples

delete

Deletes the stream rule.

DELETE FROM ovh.dbaas_logs.output_graylog_stream_rules
WHERE rule_id = '{{ rule_id }}' --required
AND service_name = '{{ service_name }}' --required
AND stream_id = '{{ stream_id }}' --required
;