Skip to content

Commit 295755e

Browse files
author
Kanji Yomoda
authored
Regenerate docs (#166)
1 parent 3b40d9a commit 295755e

File tree

54 files changed

+983
-983
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+983
-983
lines changed

docs/data-sources/elasticsearch_ingest_processor_append.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,21 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {
3939

4040
### Required
4141

42-
- **field** (String) The field to be appended to.
43-
- **value** (List of String) The value to be appended.
42+
- `field` (String) The field to be appended to.
43+
- `value` (List of String) The value to be appended.
4444

4545
### Optional
4646

47-
- **allow_duplicates** (Boolean) If `false`, the processor does not append values already present in the field.
48-
- **description** (String) Description of the processor.
49-
- **if** (String) Conditionally execute the processor
50-
- **ignore_failure** (Boolean) Ignore failures for the processor.
51-
- **media_type** (String) The media type for encoding value. Applies only when value is a template snippet. Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. Supported only from Elasticsearch version **7.15**.
52-
- **on_failure** (List of String) Handle failures for the processor.
53-
- **tag** (String) Identifier for the processor.
47+
- `allow_duplicates` (Boolean) If `false`, the processor does not append values already present in the field.
48+
- `description` (String) Description of the processor.
49+
- `if` (String) Conditionally execute the processor
50+
- `ignore_failure` (Boolean) Ignore failures for the processor.
51+
- `media_type` (String) The media type for encoding value. Applies only when value is a template snippet. Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. Supported only from Elasticsearch version **7.15**.
52+
- `on_failure` (List of String) Handle failures for the processor.
53+
- `tag` (String) Identifier for the processor.
5454

5555
### Read-Only
5656

57-
- **id** (String) Internal identifier of the resource
58-
- **json** (String) JSON representation of this data source.
57+
- `id` (String) Internal identifier of the resource
58+
- `json` (String) JSON representation of this data source.
5959

docs/data-sources/elasticsearch_ingest_processor_bytes.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,20 +39,20 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {
3939

4040
### Required
4141

42-
- **field** (String) The field to convert
42+
- `field` (String) The field to convert
4343

4444
### Optional
4545

46-
- **description** (String) Description of the processor.
47-
- **if** (String) Conditionally execute the processor
48-
- **ignore_failure** (Boolean) Ignore failures for the processor.
49-
- **ignore_missing** (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
50-
- **on_failure** (List of String) Handle failures for the processor.
51-
- **tag** (String) Identifier for the processor.
52-
- **target_field** (String) The field to assign the converted value to, by default `field` is updated in-place
46+
- `description` (String) Description of the processor.
47+
- `if` (String) Conditionally execute the processor
48+
- `ignore_failure` (Boolean) Ignore failures for the processor.
49+
- `ignore_missing` (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
50+
- `on_failure` (List of String) Handle failures for the processor.
51+
- `tag` (String) Identifier for the processor.
52+
- `target_field` (String) The field to assign the converted value to, by default `field` is updated in-place
5353

5454
### Read-Only
5555

56-
- **id** (String) Internal identifier of the resource
57-
- **json** (String) JSON representation of this data source.
56+
- `id` (String) Internal identifier of the resource
57+
- `json` (String) JSON representation of this data source.
5858

docs/data-sources/elasticsearch_ingest_processor_circle.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,22 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {
3939

4040
### Required
4141

42-
- **error_distance** (Number) The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`)
43-
- **field** (String) The string-valued field to trim whitespace from.
44-
- **shape_type** (String) Which field mapping type is to be used when processing the circle.
42+
- `error_distance` (Number) The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`)
43+
- `field` (String) The string-valued field to trim whitespace from.
44+
- `shape_type` (String) Which field mapping type is to be used when processing the circle.
4545

4646
### Optional
4747

48-
- **description** (String) Description of the processor.
49-
- **if** (String) Conditionally execute the processor
50-
- **ignore_failure** (Boolean) Ignore failures for the processor.
51-
- **ignore_missing** (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
52-
- **on_failure** (List of String) Handle failures for the processor.
53-
- **tag** (String) Identifier for the processor.
54-
- **target_field** (String) The field to assign the converted value to, by default `field` is updated in-place
48+
- `description` (String) Description of the processor.
49+
- `if` (String) Conditionally execute the processor
50+
- `ignore_failure` (Boolean) Ignore failures for the processor.
51+
- `ignore_missing` (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
52+
- `on_failure` (List of String) Handle failures for the processor.
53+
- `tag` (String) Identifier for the processor.
54+
- `target_field` (String) The field to assign the converted value to, by default `field` is updated in-place
5555

5656
### Read-Only
5757

58-
- **id** (String) Internal identifier of the resource
59-
- **json** (String) JSON representation of this data source.
58+
- `id` (String) Internal identifier of the resource
59+
- `json` (String) JSON representation of this data source.
6060

docs/data-sources/elasticsearch_ingest_processor_community_id.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -38,25 +38,25 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {
3838

3939
### Optional
4040

41-
- **description** (String) Description of the processor.
42-
- **destination_ip** (String) Field containing the destination IP address.
43-
- **destination_port** (Number) Field containing the destination port.
44-
- **iana_number** (Number) Field containing the IANA number.
45-
- **icmp_code** (Number) Field containing the ICMP code.
46-
- **icmp_type** (Number) Field containing the ICMP type.
47-
- **if** (String) Conditionally execute the processor
48-
- **ignore_failure** (Boolean) Ignore failures for the processor.
49-
- **ignore_missing** (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
50-
- **on_failure** (List of String) Handle failures for the processor.
51-
- **seed** (Number) Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
52-
- **source_ip** (String) Field containing the source IP address.
53-
- **source_port** (Number) Field containing the source port.
54-
- **tag** (String) Identifier for the processor.
55-
- **target_field** (String) Output field for the community ID.
56-
- **transport** (String) Field containing the transport protocol. Used only when the `iana_number` field is not present.
41+
- `description` (String) Description of the processor.
42+
- `destination_ip` (String) Field containing the destination IP address.
43+
- `destination_port` (Number) Field containing the destination port.
44+
- `iana_number` (Number) Field containing the IANA number.
45+
- `icmp_code` (Number) Field containing the ICMP code.
46+
- `icmp_type` (Number) Field containing the ICMP type.
47+
- `if` (String) Conditionally execute the processor
48+
- `ignore_failure` (Boolean) Ignore failures for the processor.
49+
- `ignore_missing` (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
50+
- `on_failure` (List of String) Handle failures for the processor.
51+
- `seed` (Number) Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
52+
- `source_ip` (String) Field containing the source IP address.
53+
- `source_port` (Number) Field containing the source port.
54+
- `tag` (String) Identifier for the processor.
55+
- `target_field` (String) Output field for the community ID.
56+
- `transport` (String) Field containing the transport protocol. Used only when the `iana_number` field is not present.
5757

5858
### Read-Only
5959

60-
- **id** (String) Internal identifier of the resource
61-
- **json** (String) JSON representation of this data source.
60+
- `id` (String) Internal identifier of the resource
61+
- `json` (String) JSON representation of this data source.
6262

docs/data-sources/elasticsearch_ingest_processor_convert.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,21 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {
4747

4848
### Required
4949

50-
- **field** (String) The field whose value is to be converted.
51-
- **type** (String) The type to convert the existing value to
50+
- `field` (String) The field whose value is to be converted.
51+
- `type` (String) The type to convert the existing value to
5252

5353
### Optional
5454

55-
- **description** (String) Description of the processor.
56-
- **if** (String) Conditionally execute the processor
57-
- **ignore_failure** (Boolean) Ignore failures for the processor.
58-
- **ignore_missing** (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
59-
- **on_failure** (List of String) Handle failures for the processor.
60-
- **tag** (String) Identifier for the processor.
61-
- **target_field** (String) The field to assign the converted value to.
55+
- `description` (String) Description of the processor.
56+
- `if` (String) Conditionally execute the processor
57+
- `ignore_failure` (Boolean) Ignore failures for the processor.
58+
- `ignore_missing` (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
59+
- `on_failure` (List of String) Handle failures for the processor.
60+
- `tag` (String) Identifier for the processor.
61+
- `target_field` (String) The field to assign the converted value to.
6262

6363
### Read-Only
6464

65-
- **id** (String) Internal identifier of the resource
66-
- **json** (String) JSON representation of this data source.
65+
- `id` (String) Internal identifier of the resource
66+
- `json` (String) JSON representation of this data source.
6767

docs/data-sources/elasticsearch_ingest_processor_csv.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,24 +40,24 @@ If the `trim` option is enabled then any whitespace in the beginning and in the
4040

4141
### Required
4242

43-
- **field** (String) The field to extract data from.
44-
- **target_fields** (List of String) The array of fields to assign extracted values to.
43+
- `field` (String) The field to extract data from.
44+
- `target_fields` (List of String) The array of fields to assign extracted values to.
4545

4646
### Optional
4747

48-
- **description** (String) Description of the processor.
49-
- **empty_value** (String) Value used to fill empty fields, empty fields will be skipped if this is not provided.
50-
- **if** (String) Conditionally execute the processor
51-
- **ignore_failure** (Boolean) Ignore failures for the processor.
52-
- **ignore_missing** (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
53-
- **on_failure** (List of String) Handle failures for the processor.
54-
- **quote** (String) Quote used in CSV, has to be single character string
55-
- **separator** (String) Separator used in CSV, has to be single character string.
56-
- **tag** (String) Identifier for the processor.
57-
- **trim** (Boolean) Trim whitespaces in unquoted fields.
48+
- `description` (String) Description of the processor.
49+
- `empty_value` (String) Value used to fill empty fields, empty fields will be skipped if this is not provided.
50+
- `if` (String) Conditionally execute the processor
51+
- `ignore_failure` (Boolean) Ignore failures for the processor.
52+
- `ignore_missing` (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
53+
- `on_failure` (List of String) Handle failures for the processor.
54+
- `quote` (String) Quote used in CSV, has to be single character string
55+
- `separator` (String) Separator used in CSV, has to be single character string.
56+
- `tag` (String) Identifier for the processor.
57+
- `trim` (Boolean) Trim whitespaces in unquoted fields.
5858

5959
### Read-Only
6060

61-
- **id** (String) Internal identifier of the resource
62-
- **json** (String) JSON representation of this data source.
61+
- `id` (String) Internal identifier of the resource
62+
- `json` (String) JSON representation of this data source.
6363

docs/data-sources/elasticsearch_ingest_processor_date.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,22 +43,22 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {
4343

4444
### Required
4545

46-
- **field** (String) The field to get the date from.
47-
- **formats** (List of String) An array of the expected date formats.
46+
- `field` (String) The field to get the date from.
47+
- `formats` (List of String) An array of the expected date formats.
4848

4949
### Optional
5050

51-
- **description** (String) Description of the processor.
52-
- **if** (String) Conditionally execute the processor
53-
- **ignore_failure** (Boolean) Ignore failures for the processor.
54-
- **locale** (String) The locale to use when parsing the date, relevant when parsing month names or week days.
55-
- **on_failure** (List of String) Handle failures for the processor.
56-
- **output_format** (String) The format to use when writing the date to `target_field`.
57-
- **tag** (String) Identifier for the processor.
58-
- **target_field** (String) The field that will hold the parsed date.
59-
- **timezone** (String) The timezone to use when parsing the date.
51+
- `description` (String) Description of the processor.
52+
- `if` (String) Conditionally execute the processor
53+
- `ignore_failure` (Boolean) Ignore failures for the processor.
54+
- `locale` (String) The locale to use when parsing the date, relevant when parsing month names or week days.
55+
- `on_failure` (List of String) Handle failures for the processor.
56+
- `output_format` (String) The format to use when writing the date to `target_field`.
57+
- `tag` (String) Identifier for the processor.
58+
- `target_field` (String) The field that will hold the parsed date.
59+
- `timezone` (String) The timezone to use when parsing the date.
6060

6161
### Read-Only
6262

63-
- **id** (String) Internal identifier of the resource
64-
- **json** (String) JSON representation of this data source.
63+
- `id` (String) Internal identifier of the resource
64+
- `json` (String) JSON representation of this data source.

docs/data-sources/elasticsearch_ingest_processor_date_index_name.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -44,23 +44,23 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {
4444

4545
### Required
4646

47-
- **date_rounding** (String) How to round the date when formatting the date into the index name.
48-
- **field** (String) The field to get the date or timestamp from.
47+
- `date_rounding` (String) How to round the date when formatting the date into the index name.
48+
- `field` (String) The field to get the date or timestamp from.
4949

5050
### Optional
5151

52-
- **date_formats** (List of String) An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
53-
- **description** (String) Description of the processor.
54-
- **if** (String) Conditionally execute the processor
55-
- **ignore_failure** (Boolean) Ignore failures for the processor.
56-
- **index_name_format** (String) The format to be used when printing the parsed date into the index name.
57-
- **index_name_prefix** (String) A prefix of the index name to be prepended before the printed date.
58-
- **locale** (String) The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.
59-
- **on_failure** (List of String) Handle failures for the processor.
60-
- **tag** (String) Identifier for the processor.
61-
- **timezone** (String) The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.
52+
- `date_formats` (List of String) An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
53+
- `description` (String) Description of the processor.
54+
- `if` (String) Conditionally execute the processor
55+
- `ignore_failure` (Boolean) Ignore failures for the processor.
56+
- `index_name_format` (String) The format to be used when printing the parsed date into the index name.
57+
- `index_name_prefix` (String) A prefix of the index name to be prepended before the printed date.
58+
- `locale` (String) The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.
59+
- `on_failure` (List of String) Handle failures for the processor.
60+
- `tag` (String) Identifier for the processor.
61+
- `timezone` (String) The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.
6262

6363
### Read-Only
6464

65-
- **id** (String) Internal identifier of the resource
66-
- **json** (String) JSON representation of this data source.
65+
- `id` (String) Internal identifier of the resource
66+
- `json` (String) JSON representation of this data source.

docs/data-sources/elasticsearch_ingest_processor_dissect.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,20 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {
4141

4242
### Required
4343

44-
- **field** (String) The field to dissect.
45-
- **pattern** (String) The pattern to apply to the field.
44+
- `field` (String) The field to dissect.
45+
- `pattern` (String) The pattern to apply to the field.
4646

4747
### Optional
4848

49-
- **append_separator** (String) The character(s) that separate the appended fields.
50-
- **description** (String) Description of the processor.
51-
- **if** (String) Conditionally execute the processor
52-
- **ignore_failure** (Boolean) Ignore failures for the processor.
53-
- **ignore_missing** (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
54-
- **on_failure** (List of String) Handle failures for the processor.
55-
- **tag** (String) Identifier for the processor.
49+
- `append_separator` (String) The character(s) that separate the appended fields.
50+
- `description` (String) Description of the processor.
51+
- `if` (String) Conditionally execute the processor
52+
- `ignore_failure` (Boolean) Ignore failures for the processor.
53+
- `ignore_missing` (Boolean) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.
54+
- `on_failure` (List of String) Handle failures for the processor.
55+
- `tag` (String) Identifier for the processor.
5656

5757
### Read-Only
5858

59-
- **id** (String) Internal identifier of the resource
60-
- **json** (String) JSON representation of this data source.
59+
- `id` (String) Internal identifier of the resource
60+
- `json` (String) JSON representation of this data source.

docs/data-sources/elasticsearch_ingest_processor_dot_expander.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,19 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" {
3838

3939
### Required
4040

41-
- **field** (String) The field to expand into an object field. If set to *, all top-level fields will be expanded.
41+
- `field` (String) The field to expand into an object field. If set to *, all top-level fields will be expanded.
4242

4343
### Optional
4444

45-
- **description** (String) Description of the processor.
46-
- **if** (String) Conditionally execute the processor
47-
- **ignore_failure** (Boolean) Ignore failures for the processor.
48-
- **on_failure** (List of String) Handle failures for the processor.
49-
- **override** (Boolean) Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
50-
- **path** (String) The field that contains the field to expand.
51-
- **tag** (String) Identifier for the processor.
45+
- `description` (String) Description of the processor.
46+
- `if` (String) Conditionally execute the processor
47+
- `ignore_failure` (Boolean) Ignore failures for the processor.
48+
- `on_failure` (List of String) Handle failures for the processor.
49+
- `override` (Boolean) Controls the behavior when there is already an existing nested object that conflicts with the expanded field.
50+
- `path` (String) The field that contains the field to expand.
51+
- `tag` (String) Identifier for the processor.
5252

5353
### Read-Only
5454

55-
- **id** (String) Internal identifier of the resource
56-
- **json** (String) JSON representation of this data source.
55+
- `id` (String) Internal identifier of the resource
56+
- `json` (String) JSON representation of this data source.

0 commit comments

Comments
 (0)