resource.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"
)

// Resource Details of cloud guard resource
type Resource struct {

	// Ocid for CG resource
	Id *string `mandatory:"true" json:"id"`

	// resource type of the CG resource
	ResourceType *string `mandatory:"true" json:"resourceType"`

	// CompartmentId of CG Resource
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// TargetId of CG Resource
	TargetId *string `mandatory:"true" json:"targetId"`

	// region of CG Resource
	Region *string `mandatory:"true" json:"region"`

	// Name for the CG resource
	ResourceName *string `mandatory:"false" json:"resourceName"`

	// Target name for the CG Resource
	TargetName *string `mandatory:"false" json:"targetName"`

	// The Risk Level
	RiskLevel CveRiskLevelEnum `mandatory:"false" json:"riskLevel,omitempty"`

	// First monitored time
	TimeFirstMonitored *common.SDKTime `mandatory:"false" json:"timeFirstMonitored"`

	// Last monitored time
	TimeLastMonitored *common.SDKTime `mandatory:"false" json:"timeLastMonitored"`

	// Count of existing problems for a resource
	ProblemCount *int `mandatory:"false" json:"problemCount"`

	// Count of existing number of vulnerabilities in the resource
	VulnerabilityCount *int `mandatory:"false" json:"vulnerabilityCount"`

	// Number of open ports in a resource
	OpenPortsCount *int `mandatory:"false" json:"openPortsCount"`

	AdditionalDetails *ResourceAdditionalDetails `mandatory:"false" json:"additionalDetails"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	// Avoid entering confidential information.
	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"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// System tags can be viewed by users, but can only be created by the system.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

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

	if _, ok := GetMappingCveRiskLevelEnum(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(GetCveRiskLevelEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}