Skip to content

Commit e53532d

Browse files
prontpront
committed
generate docs
1 parent 4566dc5 commit e53532d

18 files changed

+306
-0
lines changed

‎website/cue/reference/components/sources/base/amqp.cue

+17
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,11 @@ base: components: sources: amqp: configuration: {
8383
[vector_native_json]: https://github.com/vectordotdev/vector/blob/master/lib/codecs/tests/data/native_encoding/schema.cue
8484
[experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs
8585
"""
86+
protobuf: """
87+
Decodes the raw bytes as [protobuf][protobuf].
88+
89+
[protobuf]: https://protobuf.dev/
90+
"""
8691
syslog: """
8792
Decodes the raw bytes as a Syslog message.
8893
@@ -95,6 +100,12 @@ base: components: sources: amqp: configuration: {
95100
}
96101
}
97102
}
103+
desc_file: {
104+
description: "Path to desc file"
105+
relevant_when: "codec = \"protobuf\""
106+
required: true
107+
type: string: {}
108+
}
98109
gelf: {
99110
description: "GELF-specific decoding options."
100111
relevant_when: "codec = \"gelf\""
@@ -127,6 +138,12 @@ base: components: sources: amqp: configuration: {
127138
type: bool: default: true
128139
}
129140
}
141+
message_type: {
142+
description: "message type. e.g package.message"
143+
relevant_when: "codec = \"protobuf\""
144+
required: true
145+
type: string: {}
146+
}
130147
native_json: {
131148
description: "Vector's native JSON-specific decoding options."
132149
relevant_when: "codec = \"native_json\""

‎website/cue/reference/components/sources/base/aws_kinesis_firehose.cue

+17
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,11 @@ base: components: sources: aws_kinesis_firehose: configuration: {
8686
[vector_native_json]: https://github.com/vectordotdev/vector/blob/master/lib/codecs/tests/data/native_encoding/schema.cue
8787
[experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs
8888
"""
89+
protobuf: """
90+
Decodes the raw bytes as [protobuf][protobuf].
91+
92+
[protobuf]: https://protobuf.dev/
93+
"""
8994
syslog: """
9095
Decodes the raw bytes as a Syslog message.
9196
@@ -98,6 +103,12 @@ base: components: sources: aws_kinesis_firehose: configuration: {
98103
}
99104
}
100105
}
106+
desc_file: {
107+
description: "Path to desc file"
108+
relevant_when: "codec = \"protobuf\""
109+
required: true
110+
type: string: {}
111+
}
101112
gelf: {
102113
description: "GELF-specific decoding options."
103114
relevant_when: "codec = \"gelf\""
@@ -130,6 +141,12 @@ base: components: sources: aws_kinesis_firehose: configuration: {
130141
type: bool: default: true
131142
}
132143
}
144+
message_type: {
145+
description: "message type. e.g package.message"
146+
relevant_when: "codec = \"protobuf\""
147+
required: true
148+
type: string: {}
149+
}
133150
native_json: {
134151
description: "Vector's native JSON-specific decoding options."
135152
relevant_when: "codec = \"native_json\""

‎website/cue/reference/components/sources/base/aws_s3.cue

+17
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,11 @@ base: components: sources: aws_s3: configuration: {
181181
[vector_native_json]: https://github.com/vectordotdev/vector/blob/master/lib/codecs/tests/data/native_encoding/schema.cue
182182
[experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs
183183
"""
184+
protobuf: """
185+
Decodes the raw bytes as [protobuf][protobuf].
186+
187+
[protobuf]: https://protobuf.dev/
188+
"""
184189
syslog: """
185190
Decodes the raw bytes as a Syslog message.
186191
@@ -193,6 +198,12 @@ base: components: sources: aws_s3: configuration: {
193198
}
194199
}
195200
}
201+
desc_file: {
202+
description: "Path to desc file"
203+
relevant_when: "codec = \"protobuf\""
204+
required: true
205+
type: string: {}
206+
}
196207
gelf: {
197208
description: "GELF-specific decoding options."
198209
relevant_when: "codec = \"gelf\""
@@ -225,6 +236,12 @@ base: components: sources: aws_s3: configuration: {
225236
type: bool: default: true
226237
}
227238
}
239+
message_type: {
240+
description: "message type. e.g package.message"
241+
relevant_when: "codec = \"protobuf\""
242+
required: true
243+
type: string: {}
244+
}
228245
native_json: {
229246
description: "Vector's native JSON-specific decoding options."
230247
relevant_when: "codec = \"native_json\""

‎website/cue/reference/components/sources/base/aws_sqs.cue

+17
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,11 @@ base: components: sources: aws_sqs: configuration: {
176176
[vector_native_json]: https://github.com/vectordotdev/vector/blob/master/lib/codecs/tests/data/native_encoding/schema.cue
177177
[experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs
178178
"""
179+
protobuf: """
180+
Decodes the raw bytes as [protobuf][protobuf].
181+
182+
[protobuf]: https://protobuf.dev/
183+
"""
179184
syslog: """
180185
Decodes the raw bytes as a Syslog message.
181186
@@ -188,6 +193,12 @@ base: components: sources: aws_sqs: configuration: {
188193
}
189194
}
190195
}
196+
desc_file: {
197+
description: "Path to desc file"
198+
relevant_when: "codec = \"protobuf\""
199+
required: true
200+
type: string: {}
201+
}
191202
gelf: {
192203
description: "GELF-specific decoding options."
193204
relevant_when: "codec = \"gelf\""
@@ -220,6 +231,12 @@ base: components: sources: aws_sqs: configuration: {
220231
type: bool: default: true
221232
}
222233
}
234+
message_type: {
235+
description: "message type. e.g package.message"
236+
relevant_when: "codec = \"protobuf\""
237+
required: true
238+
type: string: {}
239+
}
223240
native_json: {
224241
description: "Vector's native JSON-specific decoding options."
225242
relevant_when: "codec = \"native_json\""

‎website/cue/reference/components/sources/base/datadog_agent.cue

+17
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,11 @@ base: components: sources: datadog_agent: configuration: {
6868
[vector_native_json]: https://github.com/vectordotdev/vector/blob/master/lib/codecs/tests/data/native_encoding/schema.cue
6969
[experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs
7070
"""
71+
protobuf: """
72+
Decodes the raw bytes as [protobuf][protobuf].
73+
74+
[protobuf]: https://protobuf.dev/
75+
"""
7176
syslog: """
7277
Decodes the raw bytes as a Syslog message.
7378
@@ -80,6 +85,12 @@ base: components: sources: datadog_agent: configuration: {
8085
}
8186
}
8287
}
88+
desc_file: {
89+
description: "Path to desc file"
90+
relevant_when: "codec = \"protobuf\""
91+
required: true
92+
type: string: {}
93+
}
8394
gelf: {
8495
description: "GELF-specific decoding options."
8596
relevant_when: "codec = \"gelf\""
@@ -112,6 +123,12 @@ base: components: sources: datadog_agent: configuration: {
112123
type: bool: default: true
113124
}
114125
}
126+
message_type: {
127+
description: "message type. e.g package.message"
128+
relevant_when: "codec = \"protobuf\""
129+
required: true
130+
type: string: {}
131+
}
115132
native_json: {
116133
description: "Vector's native JSON-specific decoding options."
117134
relevant_when: "codec = \"native_json\""

‎website/cue/reference/components/sources/base/demo_logs.cue

+17
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@ base: components: sources: demo_logs: configuration: {
4747
[vector_native_json]: https://github.com/vectordotdev/vector/blob/master/lib/codecs/tests/data/native_encoding/schema.cue
4848
[experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs
4949
"""
50+
protobuf: """
51+
Decodes the raw bytes as [protobuf][protobuf].
52+
53+
[protobuf]: https://protobuf.dev/
54+
"""
5055
syslog: """
5156
Decodes the raw bytes as a Syslog message.
5257
@@ -59,6 +64,12 @@ base: components: sources: demo_logs: configuration: {
5964
}
6065
}
6166
}
67+
desc_file: {
68+
description: "Path to desc file"
69+
relevant_when: "codec = \"protobuf\""
70+
required: true
71+
type: string: {}
72+
}
6273
gelf: {
6374
description: "GELF-specific decoding options."
6475
relevant_when: "codec = \"gelf\""
@@ -91,6 +102,12 @@ base: components: sources: demo_logs: configuration: {
91102
type: bool: default: true
92103
}
93104
}
105+
message_type: {
106+
description: "message type. e.g package.message"
107+
relevant_when: "codec = \"protobuf\""
108+
required: true
109+
type: string: {}
110+
}
94111
native_json: {
95112
description: "Vector's native JSON-specific decoding options."
96113
relevant_when: "codec = \"native_json\""

‎website/cue/reference/components/sources/base/exec.cue

+17
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ base: components: sources: exec: configuration: {
4343
[vector_native_json]: https://github.com/vectordotdev/vector/blob/master/lib/codecs/tests/data/native_encoding/schema.cue
4444
[experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs
4545
"""
46+
protobuf: """
47+
Decodes the raw bytes as [protobuf][protobuf].
48+
49+
[protobuf]: https://protobuf.dev/
50+
"""
4651
syslog: """
4752
Decodes the raw bytes as a Syslog message.
4853
@@ -55,6 +60,12 @@ base: components: sources: exec: configuration: {
5560
}
5661
}
5762
}
63+
desc_file: {
64+
description: "Path to desc file"
65+
relevant_when: "codec = \"protobuf\""
66+
required: true
67+
type: string: {}
68+
}
5869
gelf: {
5970
description: "GELF-specific decoding options."
6071
relevant_when: "codec = \"gelf\""
@@ -87,6 +98,12 @@ base: components: sources: exec: configuration: {
8798
type: bool: default: true
8899
}
89100
}
101+
message_type: {
102+
description: "message type. e.g package.message"
103+
relevant_when: "codec = \"protobuf\""
104+
required: true
105+
type: string: {}
106+
}
90107
native_json: {
91108
description: "Vector's native JSON-specific decoding options."
92109
relevant_when: "codec = \"native_json\""

‎website/cue/reference/components/sources/base/file_descriptor.cue

+17
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ base: components: sources: file_descriptor: configuration: {
3838
[vector_native_json]: https://github.com/vectordotdev/vector/blob/master/lib/codecs/tests/data/native_encoding/schema.cue
3939
[experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs
4040
"""
41+
protobuf: """
42+
Decodes the raw bytes as [protobuf][protobuf].
43+
44+
[protobuf]: https://protobuf.dev/
45+
"""
4146
syslog: """
4247
Decodes the raw bytes as a Syslog message.
4348
@@ -50,6 +55,12 @@ base: components: sources: file_descriptor: configuration: {
5055
}
5156
}
5257
}
58+
desc_file: {
59+
description: "Path to desc file"
60+
relevant_when: "codec = \"protobuf\""
61+
required: true
62+
type: string: {}
63+
}
5364
gelf: {
5465
description: "GELF-specific decoding options."
5566
relevant_when: "codec = \"gelf\""
@@ -82,6 +93,12 @@ base: components: sources: file_descriptor: configuration: {
8293
type: bool: default: true
8394
}
8495
}
96+
message_type: {
97+
description: "message type. e.g package.message"
98+
relevant_when: "codec = \"protobuf\""
99+
required: true
100+
type: string: {}
101+
}
85102
native_json: {
86103
description: "Vector's native JSON-specific decoding options."
87104
relevant_when: "codec = \"native_json\""

‎website/cue/reference/components/sources/base/gcp_pubsub.cue

+17
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,11 @@ base: components: sources: gcp_pubsub: configuration: {
114114
[vector_native_json]: https://github.com/vectordotdev/vector/blob/master/lib/codecs/tests/data/native_encoding/schema.cue
115115
[experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs
116116
"""
117+
protobuf: """
118+
Decodes the raw bytes as [protobuf][protobuf].
119+
120+
[protobuf]: https://protobuf.dev/
121+
"""
117122
syslog: """
118123
Decodes the raw bytes as a Syslog message.
119124
@@ -126,6 +131,12 @@ base: components: sources: gcp_pubsub: configuration: {
126131
}
127132
}
128133
}
134+
desc_file: {
135+
description: "Path to desc file"
136+
relevant_when: "codec = \"protobuf\""
137+
required: true
138+
type: string: {}
139+
}
129140
gelf: {
130141
description: "GELF-specific decoding options."
131142
relevant_when: "codec = \"gelf\""
@@ -158,6 +169,12 @@ base: components: sources: gcp_pubsub: configuration: {
158169
type: bool: default: true
159170
}
160171
}
172+
message_type: {
173+
description: "message type. e.g package.message"
174+
relevant_when: "codec = \"protobuf\""
175+
required: true
176+
type: string: {}
177+
}
161178
native_json: {
162179
description: "Vector's native JSON-specific decoding options."
163180
relevant_when: "codec = \"native_json\""

‎website/cue/reference/components/sources/base/heroku_logs.cue

+17
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,11 @@ base: components: sources: heroku_logs: configuration: {
8080
[vector_native_json]: https://github.com/vectordotdev/vector/blob/master/lib/codecs/tests/data/native_encoding/schema.cue
8181
[experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs
8282
"""
83+
protobuf: """
84+
Decodes the raw bytes as [protobuf][protobuf].
85+
86+
[protobuf]: https://protobuf.dev/
87+
"""
8388
syslog: """
8489
Decodes the raw bytes as a Syslog message.
8590
@@ -92,6 +97,12 @@ base: components: sources: heroku_logs: configuration: {
9297
}
9398
}
9499
}
100+
desc_file: {
101+
description: "Path to desc file"
102+
relevant_when: "codec = \"protobuf\""
103+
required: true
104+
type: string: {}
105+
}
95106
gelf: {
96107
description: "GELF-specific decoding options."
97108
relevant_when: "codec = \"gelf\""
@@ -124,6 +135,12 @@ base: components: sources: heroku_logs: configuration: {
124135
type: bool: default: true
125136
}
126137
}
138+
message_type: {
139+
description: "message type. e.g package.message"
140+
relevant_when: "codec = \"protobuf\""
141+
required: true
142+
type: string: {}
143+
}
127144
native_json: {
128145
description: "Vector's native JSON-specific decoding options."
129146
relevant_when: "codec = \"native_json\""

0 commit comments

Comments
 (0)