// Copyright (c) 2016, 2018, 2025, 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.

// Database Management API
//
// Use the Database Management API to monitor and manage resources such as
// Oracle Databases, MySQL Databases, and External Database Systems.
// For more information, see Database Management (https://docs.oracle.com/iaas/database-management/home.htm).
//

package databasemanagement

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

// OptimizerStatisticsCollectionAggregationSummary The summary of the Optimizer Statistics Collection, which includes the aggregated number of tasks grouped by status.
type OptimizerStatisticsCollectionAggregationSummary struct {

	// Indicates the start of the hour as the statistics are aggregated per hour.
	TimeStart *common.SDKTime `mandatory:"true" json:"timeStart"`

	// The optimizer statistics tasks grouped by type.
	GroupBy OptimizerStatisticsGroupByTypesEnum `mandatory:"false" json:"groupBy,omitempty"`

	// Indicates the end of the hour as the statistics are aggregated per hour.
	TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`

	// The number of tasks or objects for which statistics are yet to be gathered.
	Pending *int `mandatory:"false" json:"pending"`

	// The number of tasks or objects for which statistics gathering is in progress.
	InProgress *int `mandatory:"false" json:"inProgress"`

	// The number of tasks or objects for which statistics gathering is completed.
	Completed *int `mandatory:"false" json:"completed"`

	// The number of tasks or objects for which statistics gathering failed.
	Failed *int `mandatory:"false" json:"failed"`

	// The number of tasks or objects for which statistics gathering was skipped.
	Skipped *int `mandatory:"false" json:"skipped"`

	// The number of tasks or objects for which statistics gathering timed out.
	TimedOut *int `mandatory:"false" json:"timedOut"`

	// The number of tasks or objects for which the status of statistics gathering is unknown.
	Unknown *int `mandatory:"false" json:"unknown"`

	// The total number of tasks or objects for which statistics collection is finished. This number is the
	// sum of all the tasks or objects with various statuses: pending, inProgress, completed, failed, skipped,
	// timedOut, and unknown.
	Total *int `mandatory:"false" json:"total"`
}

func (m OptimizerStatisticsCollectionAggregationSummary) 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 OptimizerStatisticsCollectionAggregationSummary) ValidateEnumValue() (bool, error) {
	errMessage := []string{}

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