resource_profile.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.

// Cloud Guard and Security Zones API
//
// Use the Cloud Guard and Security Zones API to automate processes that you would otherwise perform through the Cloud Guard Console or the Security Zones Console. For more information on these services, see the Cloud Guard (https://docs.cloud.oracle.com/iaas/cloud-guard/home.htm) and Security Zones (https://docs.cloud.oracle.com/iaas/security-zone/home.htm) documentation.
// **Note:** For Cloud Guard, you can perform Create, Update, and Delete operations only from the reporting region of your Cloud Guard tenancy. You can perform Read operations from any region.
//

package cloudguard

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

// ResourceProfile Resource profile details.
type ResourceProfile struct {

	// Unique identifier for the resource profile
	Id *string `mandatory:"true" json:"id"`

	// Unique identifier for the resource associated with the resource profile
	ResourceId *string `mandatory:"true" json:"resourceId"`

	// Display name for the resource profile
	DisplayName *string `mandatory:"true" json:"displayName"`

	// Resource type for the resource profile
	Type *string `mandatory:"true" json:"type"`

	// Compartment OCID for the resource profile
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Risk score for the resource profile
	RiskScore *float64 `mandatory:"true" json:"riskScore"`

	// The date and time the resource profile was first detected. Format defined by RFC3339.
	TimeFirstDetected *common.SDKTime `mandatory:"true" json:"timeFirstDetected"`

	// The date and time the resource profile was last detected. Format defined by RFC3339.
	TimeLastDetected *common.SDKTime `mandatory:"true" json:"timeLastDetected"`

	// List of tactic summaries associated with the resource profile
	Tactics []TacticSummary `mandatory:"true" json:"tactics"`

	// Number of sightings associated with the resource profile
	SightingsCount *int `mandatory:"false" json:"sightingsCount"`

	// List of problems IDs associated with the resource profile
	ProblemIds []string `mandatory:"false" json:"problemIds"`

	// Unique target ID for the resource profile
	TargetId *string `mandatory:"false" json:"targetId"`

	// Risk level associated with resource profile
	RiskLevel RiskLevelEnum `mandatory:"false" json:"riskLevel,omitempty"`

	// Peak risk score for the resource profile
	PeakRiskScore *float64 `mandatory:"false" json:"peakRiskScore"`

	// The date and time for the peak risk score. Format defined by RFC3339.
	TimePeakScore *common.SDKTime `mandatory:"false" json:"timePeakScore"`

	// Locks associated with this resource.
	Locks []ResourceLock `mandatory:"false" json:"locks"`
}

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

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