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

// SyntheticsCheckType Type of assertion to apply in an API test.
type SyntheticsCheckType string

// List of SyntheticsCheckType.
const (
	SYNTHETICSCHECKTYPE_EQUALS          SyntheticsCheckType = "equals"
	SYNTHETICSCHECKTYPE_NOT_EQUALS      SyntheticsCheckType = "notEquals"
	SYNTHETICSCHECKTYPE_CONTAINS        SyntheticsCheckType = "contains"
	SYNTHETICSCHECKTYPE_NOT_CONTAINS    SyntheticsCheckType = "notContains"
	SYNTHETICSCHECKTYPE_STARTS_WITH     SyntheticsCheckType = "startsWith"
	SYNTHETICSCHECKTYPE_NOT_STARTS_WITH SyntheticsCheckType = "notStartsWith"
	SYNTHETICSCHECKTYPE_GREATER         SyntheticsCheckType = "greater"
	SYNTHETICSCHECKTYPE_LOWER           SyntheticsCheckType = "lower"
	SYNTHETICSCHECKTYPE_GREATER_EQUALS  SyntheticsCheckType = "greaterEquals"
	SYNTHETICSCHECKTYPE_LOWER_EQUALS    SyntheticsCheckType = "lowerEquals"
	SYNTHETICSCHECKTYPE_MATCH_REGEX     SyntheticsCheckType = "matchRegex"
	SYNTHETICSCHECKTYPE_BETWEEN         SyntheticsCheckType = "between"
	SYNTHETICSCHECKTYPE_IS_EMPTY        SyntheticsCheckType = "isEmpty"
	SYNTHETICSCHECKTYPE_NOT_IS_EMPTY    SyntheticsCheckType = "notIsEmpty"
)

var allowedSyntheticsCheckTypeEnumValues = []SyntheticsCheckType{
	SYNTHETICSCHECKTYPE_EQUALS,
	SYNTHETICSCHECKTYPE_NOT_EQUALS,
	SYNTHETICSCHECKTYPE_CONTAINS,
	SYNTHETICSCHECKTYPE_NOT_CONTAINS,
	SYNTHETICSCHECKTYPE_STARTS_WITH,
	SYNTHETICSCHECKTYPE_NOT_STARTS_WITH,
	SYNTHETICSCHECKTYPE_GREATER,
	SYNTHETICSCHECKTYPE_LOWER,
	SYNTHETICSCHECKTYPE_GREATER_EQUALS,
	SYNTHETICSCHECKTYPE_LOWER_EQUALS,
	SYNTHETICSCHECKTYPE_MATCH_REGEX,
	SYNTHETICSCHECKTYPE_BETWEEN,
	SYNTHETICSCHECKTYPE_IS_EMPTY,
	SYNTHETICSCHECKTYPE_NOT_IS_EMPTY,
}

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

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

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

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

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