feat - Add data-jobs alert monitor type support (#4080)

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

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

.generator/schemas/v1/openapi.yaml

@@ -8069,6 +8069,36 @@ components:
         - data_source
         - query
       type: object
+    MonitorFormulaAndFunctionDataJobsQueryDefinition:
+      description: A formula and functions data jobs query.
+      properties:
+        job_type:
+          description: |-
+            The type of job being monitored. Valid values include:
+            `databricks.job`, `spark.application`, `airflow.dag`,
+            `dbt.job`, `dbt.model`, `dbt.test`, `glue.job`.
+            Custom job types are supported with the `custom.ol.` prefix.
+          example: "databricks.job"
+          type: string
+        jobs_query:
+          description: Filter expression used to select the jobs to monitor.
+          example: "job_name:smoke*"
+          type: string
+        name:
+          description: Name of the query for use in formulas. Must be `run_query`.
+          example: "run_query"
+          type: string
+        query_dialect:
+          description: |-
+            Query dialect for data jobs queries. Currently only `metric` is supported.
+          example: "metric"
+          type: string
+      required:
+        - name
+        - jobs_query
+        - job_type
+        - query_dialect
+      type: object
     MonitorFormulaAndFunctionDataQualityDataSource:
       description: Data source for data quality queries.
       enum:
@@ -8375,6 +8405,7 @@ components:
         - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition"
         - $ref: "#/components/schemas/MonitorFormulaAndFunctionCostQueryDefinition"
         - $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityQueryDefinition"
+        - $ref: "#/components/schemas/MonitorFormulaAndFunctionDataJobsQueryDefinition"
         - $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition"
         - $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateFilteredQueryDefinition"
     MonitorFormulaAndFunctionReferenceTableColumn:
@@ -9207,6 +9238,7 @@ components:
         - "cost alert"
         - "data-quality alert"
         - "network-path alert"
+        - "data-jobs alert"
       example: "query alert"
       type: string
       x-enum-varnames:
@@ -9231,6 +9263,7 @@ components:
         - COST_ALERT
         - DATA_QUALITY_ALERT
         - NETWORK_PATH_ALERT
+        - DATA_JOBS_ALERT
     MonitorUpdateRequest:
       description: Object describing a monitor update request.
       properties:

api/datadogV1/model_monitor_formula_and_function_data_jobs_query_definition.go

@@ -0,0 +1,200 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+
+package datadogV1
+
+import (
+	"fmt"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+)
+
+// MonitorFormulaAndFunctionDataJobsQueryDefinition A formula and functions data jobs query.
+type MonitorFormulaAndFunctionDataJobsQueryDefinition struct {
+	// The type of job being monitored. Valid values include:
+	// `databricks.job`, `spark.application`, `airflow.dag`,
+	// `dbt.job`, `dbt.model`, `dbt.test`, `glue.job`.
+	// Custom job types are supported with the `custom.ol.` prefix.
+	JobType string `json:"job_type"`
+	// Filter expression used to select the jobs to monitor.
+	JobsQuery string `json:"jobs_query"`
+	// Name of the query for use in formulas. Must be `run_query`.
+	Name string `json:"name"`
+	// Query dialect for data jobs queries. Currently only `metric` is supported.
+	QueryDialect string `json:"query_dialect"`
+	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
+	UnparsedObject       map[string]interface{} `json:"-"`
+	AdditionalProperties map[string]interface{} `json:"-"`
+}
+
+// NewMonitorFormulaAndFunctionDataJobsQueryDefinition instantiates a new MonitorFormulaAndFunctionDataJobsQueryDefinition object.
+// This constructor will assign default values to properties that have it defined,
+// and makes sure properties required by API are set, but the set of arguments
+// will change when the set of required properties is changed.
+func NewMonitorFormulaAndFunctionDataJobsQueryDefinition(jobType string, jobsQuery string, name string, queryDialect string) *MonitorFormulaAndFunctionDataJobsQueryDefinition {
+	this := MonitorFormulaAndFunctionDataJobsQueryDefinition{}
+	this.JobType = jobType
+	this.JobsQuery = jobsQuery
+	this.Name = name
+	this.QueryDialect = queryDialect
+	return &this
+}
+
+// NewMonitorFormulaAndFunctionDataJobsQueryDefinitionWithDefaults instantiates a new MonitorFormulaAndFunctionDataJobsQueryDefinition object.
+// This constructor will only assign default values to properties that have it defined,
+// but it doesn't guarantee that properties required by API are set.
+func NewMonitorFormulaAndFunctionDataJobsQueryDefinitionWithDefaults() *MonitorFormulaAndFunctionDataJobsQueryDefinition {
+	this := MonitorFormulaAndFunctionDataJobsQueryDefinition{}
+	return &this
+}
+
+// GetJobType returns the JobType field value.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) GetJobType() string {
+	if o == nil {
+		var ret string
+		return ret
+	}
+	return o.JobType
+}
+
+// GetJobTypeOk returns a tuple with the JobType field value
+// and a boolean to check if the value has been set.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) GetJobTypeOk() (*string, bool) {
+	if o == nil {
+		return nil, false
+	}
+	return &o.JobType, true
+}
+
+// SetJobType sets field value.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) SetJobType(v string) {
+	o.JobType = v
+}
+
+// GetJobsQuery returns the JobsQuery field value.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) GetJobsQuery() string {
+	if o == nil {
+		var ret string
+		return ret
+	}
+	return o.JobsQuery
+}
+
+// GetJobsQueryOk returns a tuple with the JobsQuery field value
+// and a boolean to check if the value has been set.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) GetJobsQueryOk() (*string, bool) {
+	if o == nil {
+		return nil, false
+	}
+	return &o.JobsQuery, true
+}
+
+// SetJobsQuery sets field value.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) SetJobsQuery(v string) {
+	o.JobsQuery = v
+}
+
+// GetName returns the Name field value.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) GetName() string {
+	if o == nil {
+		var ret string
+		return ret
+	}
+	return o.Name
+}
+
+// GetNameOk returns a tuple with the Name field value
+// and a boolean to check if the value has been set.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) GetNameOk() (*string, bool) {
+	if o == nil {
+		return nil, false
+	}
+	return &o.Name, true
+}
+
+// SetName sets field value.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) SetName(v string) {
+	o.Name = v
+}
+
+// GetQueryDialect returns the QueryDialect field value.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) GetQueryDialect() string {
+	if o == nil {
+		var ret string
+		return ret
+	}
+	return o.QueryDialect
+}
+
+// GetQueryDialectOk returns a tuple with the QueryDialect field value
+// and a boolean to check if the value has been set.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) GetQueryDialectOk() (*string, bool) {
+	if o == nil {
+		return nil, false
+	}
+	return &o.QueryDialect, true
+}
+
+// SetQueryDialect sets field value.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) SetQueryDialect(v string) {
+	o.QueryDialect = v
+}
+
+// MarshalJSON serializes the struct using spec logic.
+func (o MonitorFormulaAndFunctionDataJobsQueryDefinition) MarshalJSON() ([]byte, error) {
+	toSerialize := map[string]interface{}{}
+	if o.UnparsedObject != nil {
+		return datadog.Marshal(o.UnparsedObject)
+	}
+	toSerialize["job_type"] = o.JobType
+	toSerialize["jobs_query"] = o.JobsQuery
+	toSerialize["name"] = o.Name
+	toSerialize["query_dialect"] = o.QueryDialect
+
+	for key, value := range o.AdditionalProperties {
+		toSerialize[key] = value
+	}
+	return datadog.Marshal(toSerialize)
+}
+
+// UnmarshalJSON deserializes the given payload.
+func (o *MonitorFormulaAndFunctionDataJobsQueryDefinition) UnmarshalJSON(bytes []byte) (err error) {
+	all := struct {
+		JobType      *string `json:"job_type"`
+		JobsQuery    *string `json:"jobs_query"`
+		Name         *string `json:"name"`
+		QueryDialect *string `json:"query_dialect"`
+	}{}
+	if err = datadog.Unmarshal(bytes, &all); err != nil {
+		return datadog.Unmarshal(bytes, &o.UnparsedObject)
+	}
+	if all.JobType == nil {
+		return fmt.Errorf("required field job_type missing")
+	}
+	if all.JobsQuery == nil {
+		return fmt.Errorf("required field jobs_query missing")
+	}
+	if all.Name == nil {
+		return fmt.Errorf("required field name missing")
+	}
+	if all.QueryDialect == nil {
+		return fmt.Errorf("required field query_dialect missing")
+	}
+	additionalProperties := make(map[string]interface{})
+	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
+		datadog.DeleteKeys(additionalProperties, &[]string{"job_type", "jobs_query", "name", "query_dialect"})
+	} else {
+		return err
+	}
+	o.JobType = *all.JobType
+	o.JobsQuery = *all.JobsQuery
+	o.Name = *all.Name
+	o.QueryDialect = *all.QueryDialect
+
+	if len(additionalProperties) > 0 {
+		o.AdditionalProperties = additionalProperties
+	}
+
+	return nil
+}

api/datadogV1/model_monitor_formula_and_function_query_definition.go

@@ -13,6 +13,7 @@ type MonitorFormulaAndFunctionQueryDefinition struct {
 	MonitorFormulaAndFunctionEventQueryDefinition              *MonitorFormulaAndFunctionEventQueryDefinition
 	MonitorFormulaAndFunctionCostQueryDefinition               *MonitorFormulaAndFunctionCostQueryDefinition
 	MonitorFormulaAndFunctionDataQualityQueryDefinition        *MonitorFormulaAndFunctionDataQualityQueryDefinition
+	MonitorFormulaAndFunctionDataJobsQueryDefinition           *MonitorFormulaAndFunctionDataJobsQueryDefinition
 	MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition *MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition
 	MonitorFormulaAndFunctionAggregateFilteredQueryDefinition  *MonitorFormulaAndFunctionAggregateFilteredQueryDefinition
 
@@ -35,6 +36,11 @@ func MonitorFormulaAndFunctionDataQualityQueryDefinitionAsMonitorFormulaAndFunct
 	return MonitorFormulaAndFunctionQueryDefinition{MonitorFormulaAndFunctionDataQualityQueryDefinition: v}
 }
 
+// MonitorFormulaAndFunctionDataJobsQueryDefinitionAsMonitorFormulaAndFunctionQueryDefinition is a convenience function that returns MonitorFormulaAndFunctionDataJobsQueryDefinition wrapped in MonitorFormulaAndFunctionQueryDefinition.
+func MonitorFormulaAndFunctionDataJobsQueryDefinitionAsMonitorFormulaAndFunctionQueryDefinition(v *MonitorFormulaAndFunctionDataJobsQueryDefinition) MonitorFormulaAndFunctionQueryDefinition {
+	return MonitorFormulaAndFunctionQueryDefinition{MonitorFormulaAndFunctionDataJobsQueryDefinition: v}
+}
+
 // MonitorFormulaAndFunctionAggregateAugmentedQueryDefinitionAsMonitorFormulaAndFunctionQueryDefinition is a convenience function that returns MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition wrapped in MonitorFormulaAndFunctionQueryDefinition.
 func MonitorFormulaAndFunctionAggregateAugmentedQueryDefinitionAsMonitorFormulaAndFunctionQueryDefinition(v *MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition) MonitorFormulaAndFunctionQueryDefinition {
 	return MonitorFormulaAndFunctionQueryDefinition{MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition: v}
@@ -100,6 +106,23 @@ func (obj *MonitorFormulaAndFunctionQueryDefinition) UnmarshalJSON(data []byte)
 		obj.MonitorFormulaAndFunctionDataQualityQueryDefinition = nil
 	}
 
+	// try to unmarshal data into MonitorFormulaAndFunctionDataJobsQueryDefinition
+	err = datadog.Unmarshal(data, &obj.MonitorFormulaAndFunctionDataJobsQueryDefinition)
+	if err == nil {
+		if obj.MonitorFormulaAndFunctionDataJobsQueryDefinition != nil && obj.MonitorFormulaAndFunctionDataJobsQueryDefinition.UnparsedObject == nil {
+			jsonMonitorFormulaAndFunctionDataJobsQueryDefinition, _ := datadog.Marshal(obj.MonitorFormulaAndFunctionDataJobsQueryDefinition)
+			if string(jsonMonitorFormulaAndFunctionDataJobsQueryDefinition) == "{}" { // empty struct
+				obj.MonitorFormulaAndFunctionDataJobsQueryDefinition = nil
+			} else {
+				match++
+			}
+		} else {
+			obj.MonitorFormulaAndFunctionDataJobsQueryDefinition = nil
+		}
+	} else {
+		obj.MonitorFormulaAndFunctionDataJobsQueryDefinition = nil
+	}
+
 	// try to unmarshal data into MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition
 	err = datadog.Unmarshal(data, &obj.MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition)
 	if err == nil {
@@ -139,6 +162,7 @@ func (obj *MonitorFormulaAndFunctionQueryDefinition) UnmarshalJSON(data []byte)
 		obj.MonitorFormulaAndFunctionEventQueryDefinition = nil
 		obj.MonitorFormulaAndFunctionCostQueryDefinition = nil
 		obj.MonitorFormulaAndFunctionDataQualityQueryDefinition = nil
+		obj.MonitorFormulaAndFunctionDataJobsQueryDefinition = nil
 		obj.MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition = nil
 		obj.MonitorFormulaAndFunctionAggregateFilteredQueryDefinition = nil
 		return datadog.Unmarshal(data, &obj.UnparsedObject)
@@ -160,6 +184,10 @@ func (obj MonitorFormulaAndFunctionQueryDefinition) MarshalJSON() ([]byte, error
 		return datadog.Marshal(&obj.MonitorFormulaAndFunctionDataQualityQueryDefinition)
 	}
 
+	if obj.MonitorFormulaAndFunctionDataJobsQueryDefinition != nil {
+		return datadog.Marshal(&obj.MonitorFormulaAndFunctionDataJobsQueryDefinition)
+	}
+
 	if obj.MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition != nil {
 		return datadog.Marshal(&obj.MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition)
 	}
@@ -188,6 +216,10 @@ func (obj *MonitorFormulaAndFunctionQueryDefinition) GetActualInstance() interfa
 		return obj.MonitorFormulaAndFunctionDataQualityQueryDefinition
 	}
 
+	if obj.MonitorFormulaAndFunctionDataJobsQueryDefinition != nil {
+		return obj.MonitorFormulaAndFunctionDataJobsQueryDefinition
+	}
+
 	if obj.MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition != nil {
 		return obj.MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition
 	}

api/datadogV1/model_monitor_type.go

@@ -36,6 +36,7 @@ const (
 	MONITORTYPE_COST_ALERT                MonitorType = "cost alert"
 	MONITORTYPE_DATA_QUALITY_ALERT        MonitorType = "data-quality alert"
 	MONITORTYPE_NETWORK_PATH_ALERT        MonitorType = "network-path alert"
+	MONITORTYPE_DATA_JOBS_ALERT           MonitorType = "data-jobs alert"
 )
 
 var allowedMonitorTypeEnumValues = []MonitorType{
@@ -60,6 +61,7 @@ var allowedMonitorTypeEnumValues = []MonitorType{
 	MONITORTYPE_COST_ALERT,
 	MONITORTYPE_DATA_QUALITY_ALERT,
 	MONITORTYPE_NETWORK_PATH_ALERT,
+	MONITORTYPE_DATA_JOBS_ALERT,
 }
 
 // GetAllowedValues reeturns the list of possible values.