opensearch_patterns

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

Overview

Name	opensearch_patterns
Type	Resource
Id	ovh.public_cloud_analytics.opensearch_patterns

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the index pattern
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
maximum_index_count	integer	Maximum number of indexes matching this pattern. Oldest indexes are deleted when this limit is reached. (wire: maximumIndexCount)
pattern	string	Glob pattern matching index names
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)

list

An index pattern on a managed OpenSearch service

Name	Datatype	Description
id	string (uuid)	Unique identifier of the index pattern
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
maximum_index_count	integer	Maximum number of indexes matching this pattern. Oldest indexes are deleted when this limit is reached. (wire: maximumIndexCount)
pattern	string	Glob pattern matching index names
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	pattern_id, service_id, project_id		Returns the glob pattern and the maximum number of indexes it keeps. (Beta version)
list	select	service_id, project_id	x_pagination_cursor, x_pagination_size	Returns the index patterns of the service with their maximum number of indexes. (Beta version)
create	insert	service_id, project_id, maximum_index_count, pattern		Creates a glob pattern matching index names, with a maximum number of matching indexes. When the limit is reached, the oldest indexes are deleted. (Beta version)
delete	delete	pattern_id, service_id, project_id		Deletes the index pattern and the indexes matching it. (Beta version)

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"}})
pattern_id	string (uuid)	Pattern ID (wire: patternId)
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
service_id	string (uuid)	Service ID (wire: serviceId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the glob pattern and the maximum number of indexes it keeps. (Beta version)

SELECT
id,
checksum,
created_at,
maximum_index_count,
pattern,
updated_at
FROM ovh.public_cloud_analytics.opensearch_patterns
WHERE pattern_id = '{{ pattern_id }}' -- required
AND service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the index patterns of the service with their maximum number of indexes. (Beta version)

SELECT
id,
checksum,
created_at,
maximum_index_count,
pattern,
updated_at
FROM ovh.public_cloud_analytics.opensearch_patterns
WHERE service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

INSERT examples

create

Creates a glob pattern matching index names, with a maximum number of matching indexes. When the limit is reached, the oldest indexes are deleted. (Beta version)

INSERT INTO ovh.public_cloud_analytics.opensearch_patterns (
maximum_index_count,
pattern,
service_id,
project_id
)
SELECT 
{{ maximum_index_count }} /* required */,
'{{ pattern }}' /* required */,
'{{ service_id }}',
'{{ project_id }}'
RETURNING
id,
checksum,
created_at,
maximum_index_count,
pattern,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: opensearch_patterns
props:
  - name: service_id
    value: "{{ service_id }}"
    description: Required parameter for the opensearch_patterns resource.
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the opensearch_patterns resource.
  - name: maximum_index_count
    value: {{ maximum_index_count }}
    description: |
      Maximum number of indexes matching this pattern
  - name: pattern
    value: "{{ pattern }}"
    description: |
      Glob pattern matching index names

DELETE examples

delete

Deletes the index pattern and the indexes matching it. (Beta version)

DELETE FROM ovh.public_cloud_analytics.opensearch_patterns
WHERE pattern_id = '{{ pattern_id }}' --required
AND service_id = '{{ service_id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;