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

// Application Dependency Management API
//
// Use the Application Dependency Management API to create knowledge bases and vulnerability audits.  For more information, see ADM (https://docs.cloud.oracle.com/Content/application-dependency-management/home.htm).
//

package adm

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

// RemediationRun A remediation run represents an execution of a Remediation Recipe to detect and fix vulnerabilities based on current state of the
// Vulnerabilities curated in the Knowledge Base.
// A Run can be triggered manually or when a new CVE is discovered.
type RemediationRun struct {

	// The Oracle Cloud Identifier (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the remediation run.
	Id *string `mandatory:"true" json:"id"`

	// The Oracle Cloud Identifier (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the Remediation Recipe.
	RemediationRecipeId *string `mandatory:"true" json:"remediationRecipeId"`

	// The source that triggered the Remediation Recipe.
	RemediationRunSource RemediationRunRemediationRunSourceEnum `mandatory:"true" json:"remediationRunSource"`

	// The creation date and time of the remediation run (formatted according to RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339)).
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The date and time the remediation run was last updated (formatted according to RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339)).
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// The compartment Oracle Cloud Identifier (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the remediation run.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The current lifecycle state of the remediation run.
	LifecycleState RemediationRunLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// 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:"true" 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:"true" json:"definedTags"`

	// The name of the remediation run.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The list of remediation run stage summaries.
	Stages []StageSummary `mandatory:"false" json:"stages"`

	// The date and time of the start of the remediation run (formatted according to RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339)).
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time of the finish of the remediation run (formatted according to RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339)).
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// The type of the current stage of the remediation run.
	CurrentStageType RemediationRunStageTypeEnum `mandatory:"false" json:"currentStageType,omitempty"`

	// 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 RemediationRun) 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 RemediationRun) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	if _, ok := GetMappingRemediationRunRemediationRunSourceEnum(string(m.RemediationRunSource)); !ok && m.RemediationRunSource != "" {
		errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for RemediationRunSource: %s. Supported values are: %s.", m.RemediationRunSource, strings.Join(GetRemediationRunRemediationRunSourceEnumStringValues(), ",")))
	}
	if _, ok := GetMappingRemediationRunLifecycleStateEnum(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(GetRemediationRunLifecycleStateEnumStringValues(), ",")))
	}

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

// RemediationRunRemediationRunSourceEnum Enum with underlying type: string
type RemediationRunRemediationRunSourceEnum string

// Set of constants representing the allowable values for RemediationRunRemediationRunSourceEnum
const (
	RemediationRunRemediationRunSourceManual        RemediationRunRemediationRunSourceEnum = "MANUAL"
	RemediationRunRemediationRunSourceKnowledgeBase RemediationRunRemediationRunSourceEnum = "KNOWLEDGE_BASE"
)

var mappingRemediationRunRemediationRunSourceEnum = map[string]RemediationRunRemediationRunSourceEnum{
	"MANUAL":         RemediationRunRemediationRunSourceManual,
	"KNOWLEDGE_BASE": RemediationRunRemediationRunSourceKnowledgeBase,
}

var mappingRemediationRunRemediationRunSourceEnumLowerCase = map[string]RemediationRunRemediationRunSourceEnum{
	"manual":         RemediationRunRemediationRunSourceManual,
	"knowledge_base": RemediationRunRemediationRunSourceKnowledgeBase,
}

// GetRemediationRunRemediationRunSourceEnumValues Enumerates the set of values for RemediationRunRemediationRunSourceEnum
func GetRemediationRunRemediationRunSourceEnumValues() []RemediationRunRemediationRunSourceEnum {
	values := make([]RemediationRunRemediationRunSourceEnum, 0)
	for _, v := range mappingRemediationRunRemediationRunSourceEnum {
		values = append(values, v)
	}
	return values
}

// GetRemediationRunRemediationRunSourceEnumStringValues Enumerates the set of values in String for RemediationRunRemediationRunSourceEnum
func GetRemediationRunRemediationRunSourceEnumStringValues() []string {
	return []string{
		"MANUAL",
		"KNOWLEDGE_BASE",
	}
}

// GetMappingRemediationRunRemediationRunSourceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingRemediationRunRemediationRunSourceEnum(val string) (RemediationRunRemediationRunSourceEnum, bool) {
	enum, ok := mappingRemediationRunRemediationRunSourceEnumLowerCase[strings.ToLower(val)]
	return enum, ok
}

// RemediationRunLifecycleStateEnum Enum with underlying type: string
type RemediationRunLifecycleStateEnum string

// Set of constants representing the allowable values for RemediationRunLifecycleStateEnum
const (
	RemediationRunLifecycleStateAccepted   RemediationRunLifecycleStateEnum = "ACCEPTED"
	RemediationRunLifecycleStateCanceled   RemediationRunLifecycleStateEnum = "CANCELED"
	RemediationRunLifecycleStateCanceling  RemediationRunLifecycleStateEnum = "CANCELING"
	RemediationRunLifecycleStateFailed     RemediationRunLifecycleStateEnum = "FAILED"
	RemediationRunLifecycleStateInProgress RemediationRunLifecycleStateEnum = "IN_PROGRESS"
	RemediationRunLifecycleStateSucceeded  RemediationRunLifecycleStateEnum = "SUCCEEDED"
	RemediationRunLifecycleStateDeleting   RemediationRunLifecycleStateEnum = "DELETING"
	RemediationRunLifecycleStateDeleted    RemediationRunLifecycleStateEnum = "DELETED"
)

var mappingRemediationRunLifecycleStateEnum = map[string]RemediationRunLifecycleStateEnum{
	"ACCEPTED":    RemediationRunLifecycleStateAccepted,
	"CANCELED":    RemediationRunLifecycleStateCanceled,
	"CANCELING":   RemediationRunLifecycleStateCanceling,
	"FAILED":      RemediationRunLifecycleStateFailed,
	"IN_PROGRESS": RemediationRunLifecycleStateInProgress,
	"SUCCEEDED":   RemediationRunLifecycleStateSucceeded,
	"DELETING":    RemediationRunLifecycleStateDeleting,
	"DELETED":     RemediationRunLifecycleStateDeleted,
}

var mappingRemediationRunLifecycleStateEnumLowerCase = map[string]RemediationRunLifecycleStateEnum{
	"accepted":    RemediationRunLifecycleStateAccepted,
	"canceled":    RemediationRunLifecycleStateCanceled,
	"canceling":   RemediationRunLifecycleStateCanceling,
	"failed":      RemediationRunLifecycleStateFailed,
	"in_progress": RemediationRunLifecycleStateInProgress,
	"succeeded":   RemediationRunLifecycleStateSucceeded,
	"deleting":    RemediationRunLifecycleStateDeleting,
	"deleted":     RemediationRunLifecycleStateDeleted,
}

// GetRemediationRunLifecycleStateEnumValues Enumerates the set of values for RemediationRunLifecycleStateEnum
func GetRemediationRunLifecycleStateEnumValues() []RemediationRunLifecycleStateEnum {
	values := make([]RemediationRunLifecycleStateEnum, 0)
	for _, v := range mappingRemediationRunLifecycleStateEnum {
		values = append(values, v)
	}
	return values
}

// GetRemediationRunLifecycleStateEnumStringValues Enumerates the set of values in String for RemediationRunLifecycleStateEnum
func GetRemediationRunLifecycleStateEnumStringValues() []string {
	return []string{
		"ACCEPTED",
		"CANCELED",
		"CANCELING",
		"FAILED",
		"IN_PROGRESS",
		"SUCCEEDED",
		"DELETING",
		"DELETED",
	}
}

// GetMappingRemediationRunLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingRemediationRunLifecycleStateEnum(val string) (RemediationRunLifecycleStateEnum, bool) {
	enum, ok := mappingRemediationRunLifecycleStateEnumLowerCase[strings.ToLower(val)]
	return enum, ok
}