model_heat_map_widget_definition_type.go

// 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"
)

// HeatMapWidgetDefinitionType Type of the heat map widget.
type HeatMapWidgetDefinitionType string

// List of HeatMapWidgetDefinitionType.
const (
	HEATMAPWIDGETDEFINITIONTYPE_HEATMAP HeatMapWidgetDefinitionType = "heatmap"
)

var allowedHeatMapWidgetDefinitionTypeEnumValues = []HeatMapWidgetDefinitionType{
	HEATMAPWIDGETDEFINITIONTYPE_HEATMAP,
}

// GetAllowedValues reeturns the list of possible values.
func (v *HeatMapWidgetDefinitionType) GetAllowedValues() []HeatMapWidgetDefinitionType {
	return allowedHeatMapWidgetDefinitionTypeEnumValues
}

// UnmarshalJSON deserializes the given payload.
func (v *HeatMapWidgetDefinitionType) UnmarshalJSON(src []byte) error {
	var value string
	err := datadog.Unmarshal(src, &value)
	if err != nil {
		return err
	}
	*v = HeatMapWidgetDefinitionType(value)
	return nil
}

// NewHeatMapWidgetDefinitionTypeFromValue returns a pointer to a valid HeatMapWidgetDefinitionType
// for the value passed as argument, or an error if the value passed is not allowed by the enum.
func NewHeatMapWidgetDefinitionTypeFromValue(v string) (*HeatMapWidgetDefinitionType, error) {
	ev := HeatMapWidgetDefinitionType(v)
	if ev.IsValid() {
		return &ev, nil
	}
	return nil, fmt.Errorf("invalid value '%v' for HeatMapWidgetDefinitionType: valid values are %v", v, allowedHeatMapWidgetDefinitionTypeEnumValues)
}

// IsValid return true if the value is valid for the enum, false otherwise.
func (v HeatMapWidgetDefinitionType) IsValid() bool {
	for _, existing := range allowedHeatMapWidgetDefinitionTypeEnumValues {
		if existing == v {
			return true
		}
	}
	return false
}

// Ptr returns reference to HeatMapWidgetDefinitionType value.
func (v HeatMapWidgetDefinitionType) Ptr() *HeatMapWidgetDefinitionType {
	return &v
}