influxdb/status.go

package influxdb

import (
	"fmt"

	"github.com/influxdata/influxdb/v2/kit/platform/errors"
)

// Status defines if a resource is active or inactive.
type Status string

const (
	// Active status means that the resource can be used.
	Active Status = "active"
	// Inactive status means that the resource cannot be used.
	Inactive Status = "inactive"
)

// Valid determines if a Status value matches the enum.
func (s Status) Valid() error {
	switch s {
	case Active, Inactive:
		return nil
	default:
		return &errors.Error{
			Code: errors.EInvalid,
			Msg:  fmt.Sprintf("invalid status: must be %v or %v", Active, Inactive),
		}
	}
}

// Ptr returns the pointer of that status.
func (s Status) Ptr() *Status {
	return &s
}