Skip to content

Commit 8328c61

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Document behavior of absent Splunk sourcetype in Custom Destinations (#3738)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 94fc56c commit 8328c61

File tree

3 files changed

+18
-12
lines changed

3 files changed

+18
-12
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18679,9 +18679,10 @@ components:
1867918679
description: |-
1868018680
The Splunk sourcetype for the events sent to this Splunk destination.
1868118681

18682-
If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
18683-
field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
18684-
value is used as the sourcetype.
18682+
If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype `_json` is used.
18683+
On update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.
18684+
If set to `null`, the sourcetype field is omitted from the forwarded event entirely.
18685+
Otherwise, the provided string value is used as the sourcetype.
1868518686
example: my-source
1868618687
nullable: true
1868718688
type: string
@@ -18964,9 +18965,10 @@ components:
1896418965
description: |-
1896518966
The Splunk sourcetype for the events sent to this Splunk destination.
1896618967

18967-
If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
18968-
field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
18969-
value is used as the sourcetype.
18968+
If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype `_json` is used.
18969+
On update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.
18970+
If set to `null`, the sourcetype field is omitted from the forwarded event entirely.
18971+
Otherwise, the provided string value is used as the sourcetype.
1897018972
example: my-source
1897118973
nullable: true
1897218974
type: string

src/main/java/com/datadog/api/client/v2/model/CustomDestinationForwardDestinationSplunk.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,11 @@ public CustomDestinationForwardDestinationSplunk sourcetype(String sourcetype) {
105105
/**
106106
* The Splunk sourcetype for the events sent to this Splunk destination.
107107
*
108-
* <p>If absent, the default sourcetype <code>_json</code> is used. If set to null, the <code>
109-
* sourcetype</code> field is omitted from the Splunk HEC payload entirely. Otherwise, the
110-
* provided string value is used as the sourcetype.
108+
* <p>If the field is absent from the request and no sourcetype has been previously set on this
109+
* destination, the default sourcetype <code>_json</code> is used. On update, if the field is
110+
* absent from the request but a sourcetype was previously set, the previous value is kept. If set
111+
* to <code>null</code>, the sourcetype field is omitted from the forwarded event entirely.
112+
* Otherwise, the provided string value is used as the sourcetype.
111113
*
112114
* @return sourcetype
113115
*/

src/main/java/com/datadog/api/client/v2/model/CustomDestinationResponseForwardDestinationSplunk.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,11 @@ public CustomDestinationResponseForwardDestinationSplunk sourcetype(String sourc
7979
/**
8080
* The Splunk sourcetype for the events sent to this Splunk destination.
8181
*
82-
* <p>If absent, the default sourcetype <code>_json</code> is used. If set to null, the <code>
83-
* sourcetype</code> field is omitted from the Splunk HEC payload entirely. Otherwise, the
84-
* provided string value is used as the sourcetype.
82+
* <p>If the field is absent from the request and no sourcetype has been previously set on this
83+
* destination, the default sourcetype <code>_json</code> is used. On update, if the field is
84+
* absent from the request but a sourcetype was previously set, the previous value is kept. If set
85+
* to <code>null</code>, the sourcetype field is omitted from the forwarded event entirely.
86+
* Otherwise, the provided string value is used as the sourcetype.
8587
*
8688
* @return sourcetype
8789
*/

0 commit comments

Comments
 (0)