Add support for configuring Splunk sourcetype in Custom Destinations (DataDog#3883)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -18216,6 +18216,16 @@ components:
             Must have HTTPS scheme and forwarding back to Datadog is not allowed.
           example: https://example.com
           type: string
+        sourcetype:
+          description: |-
+            The Splunk sourcetype for the events sent to this Splunk destination.
+
+            If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
+            field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
+            value is used as the sourcetype.
+          example: my-source
+          nullable: true
+          type: string
         type:
           $ref: "#/components/schemas/CustomDestinationForwardDestinationSplunkType"
       required:
@@ -18491,6 +18501,16 @@ components:
             Must have HTTPS scheme and forwarding back to Datadog is not allowed.
           example: https://example.com
           type: string
+        sourcetype:
+          description: |-
+            The Splunk sourcetype for the events sent to this Splunk destination.
+
+            If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
+            field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
+            value is used as the sourcetype.
+          example: my-source
+          nullable: true
+          type: string
         type:
           $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationSplunkType"
       required:

api/datadogV2/model_custom_destination_forward_destination_splunk.go

@@ -17,6 +17,12 @@ type CustomDestinationForwardDestinationSplunk struct {
 	// The destination for which logs will be forwarded to.
 	// Must have HTTPS scheme and forwarding back to Datadog is not allowed.
 	Endpoint string `json:"endpoint"`
+	// The Splunk sourcetype for the events sent to this Splunk destination.
+	//
+	// If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
+	// field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
+	// value is used as the sourcetype.
+	Sourcetype datadog.NullableString `json:"sourcetype,omitempty"`
 	// Type of the Splunk HTTP Event Collector (HEC) destination.
 	Type CustomDestinationForwardDestinationSplunkType `json:"type"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
@@ -92,6 +98,45 @@ func (o *CustomDestinationForwardDestinationSplunk) SetEndpoint(v string) {
 	o.Endpoint = v
 }
 
+// GetSourcetype returns the Sourcetype field value if set, zero value otherwise (both if not set or set to explicit null).
+func (o *CustomDestinationForwardDestinationSplunk) GetSourcetype() string {
+	if o == nil || o.Sourcetype.Get() == nil {
+		var ret string
+		return ret
+	}
+	return *o.Sourcetype.Get()
+}
+
+// GetSourcetypeOk returns a tuple with the Sourcetype field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+// NOTE: If the value is an explicit nil, `nil, true` will be returned.
+func (o *CustomDestinationForwardDestinationSplunk) GetSourcetypeOk() (*string, bool) {
+	if o == nil {
+		return nil, false
+	}
+	return o.Sourcetype.Get(), o.Sourcetype.IsSet()
+}
+
+// HasSourcetype returns a boolean if a field has been set.
+func (o *CustomDestinationForwardDestinationSplunk) HasSourcetype() bool {
+	return o != nil && o.Sourcetype.IsSet()
+}
+
+// SetSourcetype gets a reference to the given datadog.NullableString and assigns it to the Sourcetype field.
+func (o *CustomDestinationForwardDestinationSplunk) SetSourcetype(v string) {
+	o.Sourcetype.Set(&v)
+}
+
+// SetSourcetypeNil sets the value for Sourcetype to be an explicit nil.
+func (o *CustomDestinationForwardDestinationSplunk) SetSourcetypeNil() {
+	o.Sourcetype.Set(nil)
+}
+
+// UnsetSourcetype ensures that no value is present for Sourcetype, not even an explicit nil.
+func (o *CustomDestinationForwardDestinationSplunk) UnsetSourcetype() {
+	o.Sourcetype.Unset()
+}
+
 // GetType returns the Type field value.
 func (o *CustomDestinationForwardDestinationSplunk) GetType() CustomDestinationForwardDestinationSplunkType {
 	if o == nil {
@@ -123,6 +168,9 @@ func (o CustomDestinationForwardDestinationSplunk) MarshalJSON() ([]byte, error)
 	}
 	toSerialize["access_token"] = o.AccessToken
 	toSerialize["endpoint"] = o.Endpoint
+	if o.Sourcetype.IsSet() {
+		toSerialize["sourcetype"] = o.Sourcetype.Get()
+	}
 	toSerialize["type"] = o.Type
 
 	for key, value := range o.AdditionalProperties {
@@ -136,6 +184,7 @@ func (o *CustomDestinationForwardDestinationSplunk) UnmarshalJSON(bytes []byte)
 	all := struct {
 		AccessToken *string                                        `json:"access_token"`
 		Endpoint    *string                                        `json:"endpoint"`
+		Sourcetype  datadog.NullableString                         `json:"sourcetype,omitempty"`
 		Type        *CustomDestinationForwardDestinationSplunkType `json:"type"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
@@ -152,14 +201,15 @@ func (o *CustomDestinationForwardDestinationSplunk) UnmarshalJSON(bytes []byte)
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"access_token", "endpoint", "type"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"access_token", "endpoint", "sourcetype", "type"})
 	} else {
 		return err
 	}
 
 	hasInvalidField := false
 	o.AccessToken = *all.AccessToken
 	o.Endpoint = *all.Endpoint
+	o.Sourcetype = all.Sourcetype
 	if !all.Type.IsValid() {
 		hasInvalidField = true
 	} else {

api/datadogV2/model_custom_destination_response_forward_destination_splunk.go

@@ -15,6 +15,12 @@ type CustomDestinationResponseForwardDestinationSplunk struct {
 	// The destination for which logs will be forwarded to.
 	// Must have HTTPS scheme and forwarding back to Datadog is not allowed.
 	Endpoint string `json:"endpoint"`
+	// The Splunk sourcetype for the events sent to this Splunk destination.
+	//
+	// If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
+	// field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
+	// value is used as the sourcetype.
+	Sourcetype datadog.NullableString `json:"sourcetype,omitempty"`
 	// Type of the Splunk HTTP Event Collector (HEC) destination.
 	Type CustomDestinationResponseForwardDestinationSplunkType `json:"type"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
@@ -66,6 +72,45 @@ func (o *CustomDestinationResponseForwardDestinationSplunk) SetEndpoint(v string
 	o.Endpoint = v
 }
 
+// GetSourcetype returns the Sourcetype field value if set, zero value otherwise (both if not set or set to explicit null).
+func (o *CustomDestinationResponseForwardDestinationSplunk) GetSourcetype() string {
+	if o == nil || o.Sourcetype.Get() == nil {
+		var ret string
+		return ret
+	}
+	return *o.Sourcetype.Get()
+}
+
+// GetSourcetypeOk returns a tuple with the Sourcetype field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+// NOTE: If the value is an explicit nil, `nil, true` will be returned.
+func (o *CustomDestinationResponseForwardDestinationSplunk) GetSourcetypeOk() (*string, bool) {
+	if o == nil {
+		return nil, false
+	}
+	return o.Sourcetype.Get(), o.Sourcetype.IsSet()
+}
+
+// HasSourcetype returns a boolean if a field has been set.
+func (o *CustomDestinationResponseForwardDestinationSplunk) HasSourcetype() bool {
+	return o != nil && o.Sourcetype.IsSet()
+}
+
+// SetSourcetype gets a reference to the given datadog.NullableString and assigns it to the Sourcetype field.
+func (o *CustomDestinationResponseForwardDestinationSplunk) SetSourcetype(v string) {
+	o.Sourcetype.Set(&v)
+}
+
+// SetSourcetypeNil sets the value for Sourcetype to be an explicit nil.
+func (o *CustomDestinationResponseForwardDestinationSplunk) SetSourcetypeNil() {
+	o.Sourcetype.Set(nil)
+}
+
+// UnsetSourcetype ensures that no value is present for Sourcetype, not even an explicit nil.
+func (o *CustomDestinationResponseForwardDestinationSplunk) UnsetSourcetype() {
+	o.Sourcetype.Unset()
+}
+
 // GetType returns the Type field value.
 func (o *CustomDestinationResponseForwardDestinationSplunk) GetType() CustomDestinationResponseForwardDestinationSplunkType {
 	if o == nil {
@@ -96,6 +141,9 @@ func (o CustomDestinationResponseForwardDestinationSplunk) MarshalJSON() ([]byte
 		return datadog.Marshal(o.UnparsedObject)
 	}
 	toSerialize["endpoint"] = o.Endpoint
+	if o.Sourcetype.IsSet() {
+		toSerialize["sourcetype"] = o.Sourcetype.Get()
+	}
 	toSerialize["type"] = o.Type
 
 	for key, value := range o.AdditionalProperties {
@@ -107,8 +155,9 @@ func (o CustomDestinationResponseForwardDestinationSplunk) MarshalJSON() ([]byte
 // UnmarshalJSON deserializes the given payload.
 func (o *CustomDestinationResponseForwardDestinationSplunk) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
-		Endpoint *string                                                `json:"endpoint"`
-		Type     *CustomDestinationResponseForwardDestinationSplunkType `json:"type"`
+		Endpoint   *string                                                `json:"endpoint"`
+		Sourcetype datadog.NullableString                                 `json:"sourcetype,omitempty"`
+		Type       *CustomDestinationResponseForwardDestinationSplunkType `json:"type"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)
@@ -121,13 +170,14 @@ func (o *CustomDestinationResponseForwardDestinationSplunk) UnmarshalJSON(bytes
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"endpoint", "type"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"endpoint", "sourcetype", "type"})
 	} else {
 		return err
 	}
 
 	hasInvalidField := false
 	o.Endpoint = *all.Endpoint
+	o.Sourcetype = all.Sourcetype
 	if !all.Type.IsValid() {
 		hasInvalidField = true
 	} else {

examples/v2/logs-custom-destinations/CreateLogsCustomDestination_140188544.go

@@ -0,0 +1,47 @@
+// Create a Splunk custom destination with a sourcetype returns "OK" response
+
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
+)
+
+func main() {
+	body := datadogV2.CustomDestinationCreateRequest{
+		Data: &datadogV2.CustomDestinationCreateRequestDefinition{
+			Attributes: datadogV2.CustomDestinationCreateRequestAttributes{
+				Enabled:     datadog.PtrBool(false),
+				ForwardTags: datadog.PtrBool(false),
+				ForwarderDestination: datadogV2.CustomDestinationForwardDestination{
+					CustomDestinationForwardDestinationSplunk: &datadogV2.CustomDestinationForwardDestinationSplunk{
+						AccessToken: "my-access-token",
+						Endpoint:    "https://example.com",
+						Type:        datadogV2.CUSTOMDESTINATIONFORWARDDESTINATIONSPLUNKTYPE_SPLUNK_HEC,
+						Sourcetype:  *datadog.NewNullableString(datadog.PtrString("my-sourcetype")),
+					}},
+				Name:  "Nginx logs",
+				Query: datadog.PtrString("source:nginx"),
+			},
+			Type: datadogV2.CUSTOMDESTINATIONTYPE_CUSTOM_DESTINATION,
+		},
+	}
+	ctx := datadog.NewDefaultContext(context.Background())
+	configuration := datadog.NewConfiguration()
+	apiClient := datadog.NewAPIClient(configuration)
+	api := datadogV2.NewLogsCustomDestinationsApi(apiClient)
+	resp, r, err := api.CreateLogsCustomDestination(ctx, body)
+
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error when calling `LogsCustomDestinationsApi.CreateLogsCustomDestination`: %v\n", err)
+		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
+	}
+
+	responseContent, _ := json.MarshalIndent(resp, "", "  ")
+	fmt.Fprintf(os.Stdout, "Response from `LogsCustomDestinationsApi.CreateLogsCustomDestination`:\n%s\n", responseContent)
+}

examples/v2/logs-custom-destinations/CreateLogsCustomDestination_1718754520.go

@@ -0,0 +1,46 @@
+// Create a Splunk custom destination without a sourcetype returns "OK" response
+
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
+)
+
+func main() {
+	body := datadogV2.CustomDestinationCreateRequest{
+		Data: &datadogV2.CustomDestinationCreateRequestDefinition{
+			Attributes: datadogV2.CustomDestinationCreateRequestAttributes{
+				Enabled:     datadog.PtrBool(false),
+				ForwardTags: datadog.PtrBool(false),
+				ForwarderDestination: datadogV2.CustomDestinationForwardDestination{
+					CustomDestinationForwardDestinationSplunk: &datadogV2.CustomDestinationForwardDestinationSplunk{
+						AccessToken: "my-access-token",
+						Endpoint:    "https://example.com",
+						Type:        datadogV2.CUSTOMDESTINATIONFORWARDDESTINATIONSPLUNKTYPE_SPLUNK_HEC,
+					}},
+				Name:  "Nginx logs",
+				Query: datadog.PtrString("source:nginx"),
+			},
+			Type: datadogV2.CUSTOMDESTINATIONTYPE_CUSTOM_DESTINATION,
+		},
+	}
+	ctx := datadog.NewDefaultContext(context.Background())
+	configuration := datadog.NewConfiguration()
+	apiClient := datadog.NewAPIClient(configuration)
+	api := datadogV2.NewLogsCustomDestinationsApi(apiClient)
+	resp, r, err := api.CreateLogsCustomDestination(ctx, body)
+
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error when calling `LogsCustomDestinationsApi.CreateLogsCustomDestination`: %v\n", err)
+		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
+	}
+
+	responseContent, _ := json.MarshalIndent(resp, "", "  ")
+	fmt.Fprintf(os.Stdout, "Response from `LogsCustomDestinationsApi.CreateLogsCustomDestination`:\n%s\n", responseContent)
+}

examples/v2/logs-custom-destinations/CreateLogsCustomDestination_2534546779.go

@@ -0,0 +1,47 @@
+// Create a Splunk custom destination with a null sourcetype returns "OK" response
+
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
+)
+
+func main() {
+	body := datadogV2.CustomDestinationCreateRequest{
+		Data: &datadogV2.CustomDestinationCreateRequestDefinition{
+			Attributes: datadogV2.CustomDestinationCreateRequestAttributes{
+				Enabled:     datadog.PtrBool(false),
+				ForwardTags: datadog.PtrBool(false),
+				ForwarderDestination: datadogV2.CustomDestinationForwardDestination{
+					CustomDestinationForwardDestinationSplunk: &datadogV2.CustomDestinationForwardDestinationSplunk{
+						AccessToken: "my-access-token",
+						Endpoint:    "https://example.com",
+						Type:        datadogV2.CUSTOMDESTINATIONFORWARDDESTINATIONSPLUNKTYPE_SPLUNK_HEC,
+						Sourcetype:  *datadog.NewNullableString(nil),
+					}},
+				Name:  "Nginx logs",
+				Query: datadog.PtrString("source:nginx"),
+			},
+			Type: datadogV2.CUSTOMDESTINATIONTYPE_CUSTOM_DESTINATION,
+		},
+	}
+	ctx := datadog.NewDefaultContext(context.Background())
+	configuration := datadog.NewConfiguration()
+	apiClient := datadog.NewAPIClient(configuration)
+	api := datadogV2.NewLogsCustomDestinationsApi(apiClient)
+	resp, r, err := api.CreateLogsCustomDestination(ctx, body)
+
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error when calling `LogsCustomDestinationsApi.CreateLogsCustomDestination`: %v\n", err)
+		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
+	}
+
+	responseContent, _ := json.MarshalIndent(resp, "", "  ")
+	fmt.Fprintf(os.Stdout, "Response from `LogsCustomDestinationsApi.CreateLogsCustomDestination`:\n%s\n", responseContent)
+}