baselineable_metric_summary.go

// Copyright (c) 2016, 2018, 2024, Oracle and/or its affiliates.  All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.

// Stack Monitoring API
//
// Stack Monitoring API.
//

package stackmonitoring

import (
	"fmt"
	"github.com/oracle/oci-go-sdk/v65/common"
	"strings"
)

// BaselineableMetricSummary Summary for the baseline-able metric
type BaselineableMetricSummary struct {

	// OCID of the metric
	Id *string `mandatory:"true" json:"id"`

	// name of the metric
	Name *string `mandatory:"true" json:"name"`

	// metric column name
	Column *string `mandatory:"true" json:"column"`

	// namespace of the metric
	Namespace *string `mandatory:"true" json:"namespace"`

	// Resource group of the metric
	ResourceGroup *string `mandatory:"true" json:"resourceGroup"`

	// Is the metric created out of box, default false
	IsOutOfBox *bool `mandatory:"true" json:"isOutOfBox"`

	// The current lifecycle state of the metric extension
	LifecycleState BaselineableMetricLifeCycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// OCID of the tenancy
	TenancyId *string `mandatory:"false" json:"tenancyId"`

	// OCID of the compartment
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (m BaselineableMetricSummary) String() string {
	return common.PointerString(m)
}

// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m BaselineableMetricSummary) ValidateEnumValue() (bool, error) {
	errMessage := []string{}

	if _, ok := GetMappingBaselineableMetricLifeCycleStatesEnum(string(m.LifecycleState)); !ok && m.LifecycleState != "" {
		errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", m.LifecycleState, strings.Join(GetBaselineableMetricLifeCycleStatesEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}