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

// DevOps API
//
// Use the DevOps API to create DevOps projects, configure code repositories,  add artifacts to deploy, build and test software applications, configure  target deployment environments, and deploy software applications.  For more information, see DevOps (https://docs.oracle.com/iaas/Content/devops/using/home.htm).
//

package devops

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

// BuildPipelineStage A single node in a build pipeline. A stage takes a specific designated action.
// There are many types of stages such as 'BUILD' and 'DELIVER_ARTIFACT'.
type BuildPipelineStage interface {

	// Unique identifier that is immutable on creation.
	GetId() *string

	// The OCID of the DevOps project.
	GetProjectId() *string

	// The OCID of the build pipeline.
	GetBuildPipelineId() *string

	// The OCID of the compartment where the pipeline is created.
	GetCompartmentId() *string

	// Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
	GetDisplayName() *string

	// Optional description about the build stage.
	GetDescription() *string

	// The time the stage was created. Format defined by RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339).
	GetTimeCreated() *common.SDKTime

	// The time the stage was updated. Format defined by RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339).
	GetTimeUpdated() *common.SDKTime

	// The current state of the stage.
	GetLifecycleState() BuildPipelineStageLifecycleStateEnum

	// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
	GetLifecycleDetails() *string

	GetBuildPipelineStagePredecessorCollection() *BuildPipelineStagePredecessorCollection

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.  See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`
	GetFreeformTags() map[string]string

	// Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`
	GetDefinedTags() map[string]map[string]interface{}

	// Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	GetSystemTags() map[string]map[string]interface{}
}

type buildpipelinestage struct {
	JsonData                                []byte
	DisplayName                             *string                                  `mandatory:"false" json:"displayName"`
	Description                             *string                                  `mandatory:"false" json:"description"`
	TimeCreated                             *common.SDKTime                          `mandatory:"false" json:"timeCreated"`
	TimeUpdated                             *common.SDKTime                          `mandatory:"false" json:"timeUpdated"`
	LifecycleState                          BuildPipelineStageLifecycleStateEnum     `mandatory:"false" json:"lifecycleState,omitempty"`
	LifecycleDetails                        *string                                  `mandatory:"false" json:"lifecycleDetails"`
	BuildPipelineStagePredecessorCollection *BuildPipelineStagePredecessorCollection `mandatory:"false" json:"buildPipelineStagePredecessorCollection"`
	FreeformTags                            map[string]string                        `mandatory:"false" json:"freeformTags"`
	DefinedTags                             map[string]map[string]interface{}        `mandatory:"false" json:"definedTags"`
	SystemTags                              map[string]map[string]interface{}        `mandatory:"false" json:"systemTags"`
	Id                                      *string                                  `mandatory:"true" json:"id"`
	ProjectId                               *string                                  `mandatory:"true" json:"projectId"`
	BuildPipelineId                         *string                                  `mandatory:"true" json:"buildPipelineId"`
	CompartmentId                           *string                                  `mandatory:"true" json:"compartmentId"`
	BuildPipelineStageType                  string                                   `json:"buildPipelineStageType"`
}

// UnmarshalJSON unmarshals json
func (m *buildpipelinestage) UnmarshalJSON(data []byte) error {
	m.JsonData = data
	type Unmarshalerbuildpipelinestage buildpipelinestage
	s := struct {
		Model Unmarshalerbuildpipelinestage
	}{}
	err := json.Unmarshal(data, &s.Model)
	if err != nil {
		return err
	}
	m.Id = s.Model.Id
	m.ProjectId = s.Model.ProjectId
	m.BuildPipelineId = s.Model.BuildPipelineId
	m.CompartmentId = s.Model.CompartmentId
	m.DisplayName = s.Model.DisplayName
	m.Description = s.Model.Description
	m.TimeCreated = s.Model.TimeCreated
	m.TimeUpdated = s.Model.TimeUpdated
	m.LifecycleState = s.Model.LifecycleState
	m.LifecycleDetails = s.Model.LifecycleDetails
	m.BuildPipelineStagePredecessorCollection = s.Model.BuildPipelineStagePredecessorCollection
	m.FreeformTags = s.Model.FreeformTags
	m.DefinedTags = s.Model.DefinedTags
	m.SystemTags = s.Model.SystemTags
	m.BuildPipelineStageType = s.Model.BuildPipelineStageType

	return err
}

// UnmarshalPolymorphicJSON unmarshals polymorphic json
func (m *buildpipelinestage) UnmarshalPolymorphicJSON(data []byte) (interface{}, error) {

	if data == nil || string(data) == "null" {
		return nil, nil
	}

	var err error
	switch m.BuildPipelineStageType {
	case "DELIVER_ARTIFACT":
		mm := DeliverArtifactStage{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "WAIT":
		mm := WaitStage{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "TRIGGER_DEPLOYMENT_PIPELINE":
		mm := TriggerDeploymentStage{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "BUILD":
		mm := BuildStage{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	default:
		common.Logf("Received unsupported enum value for BuildPipelineStage: %s.", m.BuildPipelineStageType)
		return *m, nil
	}
}

// GetDisplayName returns DisplayName
func (m buildpipelinestage) GetDisplayName() *string {
	return m.DisplayName
}

// GetDescription returns Description
func (m buildpipelinestage) GetDescription() *string {
	return m.Description
}

// GetTimeCreated returns TimeCreated
func (m buildpipelinestage) GetTimeCreated() *common.SDKTime {
	return m.TimeCreated
}

// GetTimeUpdated returns TimeUpdated
func (m buildpipelinestage) GetTimeUpdated() *common.SDKTime {
	return m.TimeUpdated
}

// GetLifecycleState returns LifecycleState
func (m buildpipelinestage) GetLifecycleState() BuildPipelineStageLifecycleStateEnum {
	return m.LifecycleState
}

// GetLifecycleDetails returns LifecycleDetails
func (m buildpipelinestage) GetLifecycleDetails() *string {
	return m.LifecycleDetails
}

// GetBuildPipelineStagePredecessorCollection returns BuildPipelineStagePredecessorCollection
func (m buildpipelinestage) GetBuildPipelineStagePredecessorCollection() *BuildPipelineStagePredecessorCollection {
	return m.BuildPipelineStagePredecessorCollection
}

// GetFreeformTags returns FreeformTags
func (m buildpipelinestage) GetFreeformTags() map[string]string {
	return m.FreeformTags
}

// GetDefinedTags returns DefinedTags
func (m buildpipelinestage) GetDefinedTags() map[string]map[string]interface{} {
	return m.DefinedTags
}

// GetSystemTags returns SystemTags
func (m buildpipelinestage) GetSystemTags() map[string]map[string]interface{} {
	return m.SystemTags
}

// GetId returns Id
func (m buildpipelinestage) GetId() *string {
	return m.Id
}

// GetProjectId returns ProjectId
func (m buildpipelinestage) GetProjectId() *string {
	return m.ProjectId
}

// GetBuildPipelineId returns BuildPipelineId
func (m buildpipelinestage) GetBuildPipelineId() *string {
	return m.BuildPipelineId
}

// GetCompartmentId returns CompartmentId
func (m buildpipelinestage) GetCompartmentId() *string {
	return m.CompartmentId
}

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

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

// BuildPipelineStageLifecycleStateEnum Enum with underlying type: string
type BuildPipelineStageLifecycleStateEnum string

// Set of constants representing the allowable values for BuildPipelineStageLifecycleStateEnum
const (
	BuildPipelineStageLifecycleStateCreating BuildPipelineStageLifecycleStateEnum = "CREATING"
	BuildPipelineStageLifecycleStateUpdating BuildPipelineStageLifecycleStateEnum = "UPDATING"
	BuildPipelineStageLifecycleStateActive   BuildPipelineStageLifecycleStateEnum = "ACTIVE"
	BuildPipelineStageLifecycleStateDeleting BuildPipelineStageLifecycleStateEnum = "DELETING"
	BuildPipelineStageLifecycleStateDeleted  BuildPipelineStageLifecycleStateEnum = "DELETED"
	BuildPipelineStageLifecycleStateFailed   BuildPipelineStageLifecycleStateEnum = "FAILED"
)

var mappingBuildPipelineStageLifecycleStateEnum = map[string]BuildPipelineStageLifecycleStateEnum{
	"CREATING": BuildPipelineStageLifecycleStateCreating,
	"UPDATING": BuildPipelineStageLifecycleStateUpdating,
	"ACTIVE":   BuildPipelineStageLifecycleStateActive,
	"DELETING": BuildPipelineStageLifecycleStateDeleting,
	"DELETED":  BuildPipelineStageLifecycleStateDeleted,
	"FAILED":   BuildPipelineStageLifecycleStateFailed,
}

var mappingBuildPipelineStageLifecycleStateEnumLowerCase = map[string]BuildPipelineStageLifecycleStateEnum{
	"creating": BuildPipelineStageLifecycleStateCreating,
	"updating": BuildPipelineStageLifecycleStateUpdating,
	"active":   BuildPipelineStageLifecycleStateActive,
	"deleting": BuildPipelineStageLifecycleStateDeleting,
	"deleted":  BuildPipelineStageLifecycleStateDeleted,
	"failed":   BuildPipelineStageLifecycleStateFailed,
}

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

// GetBuildPipelineStageLifecycleStateEnumStringValues Enumerates the set of values in String for BuildPipelineStageLifecycleStateEnum
func GetBuildPipelineStageLifecycleStateEnumStringValues() []string {
	return []string{
		"CREATING",
		"UPDATING",
		"ACTIVE",
		"DELETING",
		"DELETED",
		"FAILED",
	}
}

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

// BuildPipelineStageBuildPipelineStageTypeEnum Enum with underlying type: string
type BuildPipelineStageBuildPipelineStageTypeEnum string

// Set of constants representing the allowable values for BuildPipelineStageBuildPipelineStageTypeEnum
const (
	BuildPipelineStageBuildPipelineStageTypeWait                      BuildPipelineStageBuildPipelineStageTypeEnum = "WAIT"
	BuildPipelineStageBuildPipelineStageTypeBuild                     BuildPipelineStageBuildPipelineStageTypeEnum = "BUILD"
	BuildPipelineStageBuildPipelineStageTypeDeliverArtifact           BuildPipelineStageBuildPipelineStageTypeEnum = "DELIVER_ARTIFACT"
	BuildPipelineStageBuildPipelineStageTypeTriggerDeploymentPipeline BuildPipelineStageBuildPipelineStageTypeEnum = "TRIGGER_DEPLOYMENT_PIPELINE"
)

var mappingBuildPipelineStageBuildPipelineStageTypeEnum = map[string]BuildPipelineStageBuildPipelineStageTypeEnum{
	"WAIT":                        BuildPipelineStageBuildPipelineStageTypeWait,
	"BUILD":                       BuildPipelineStageBuildPipelineStageTypeBuild,
	"DELIVER_ARTIFACT":            BuildPipelineStageBuildPipelineStageTypeDeliverArtifact,
	"TRIGGER_DEPLOYMENT_PIPELINE": BuildPipelineStageBuildPipelineStageTypeTriggerDeploymentPipeline,
}

var mappingBuildPipelineStageBuildPipelineStageTypeEnumLowerCase = map[string]BuildPipelineStageBuildPipelineStageTypeEnum{
	"wait":                        BuildPipelineStageBuildPipelineStageTypeWait,
	"build":                       BuildPipelineStageBuildPipelineStageTypeBuild,
	"deliver_artifact":            BuildPipelineStageBuildPipelineStageTypeDeliverArtifact,
	"trigger_deployment_pipeline": BuildPipelineStageBuildPipelineStageTypeTriggerDeploymentPipeline,
}

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

// GetBuildPipelineStageBuildPipelineStageTypeEnumStringValues Enumerates the set of values in String for BuildPipelineStageBuildPipelineStageTypeEnum
func GetBuildPipelineStageBuildPipelineStageTypeEnumStringValues() []string {
	return []string{
		"WAIT",
		"BUILD",
		"DELIVER_ARTIFACT",
		"TRIGGER_DEPLOYMENT_PIPELINE",
	}
}

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