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

// Data Integration API
//
// Use the Data Integration API to organize your data integration projects, create data flows, pipelines and tasks, and then publish, schedule, and run tasks that extract, transform, and load data. For more information, see Data Integration (https://docs.oracle.com/iaas/data-integration/home.htm).
//

package dataintegration

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

// ConditionalOutputPort The conditional output port details, used in operators such as split.
type ConditionalOutputPort struct {

	// The key of the object.
	Key *string `mandatory:"false" json:"key"`

	// The model version of an object.
	ModelVersion *string `mandatory:"false" json:"modelVersion"`

	ParentRef *ParentReference `mandatory:"false" json:"parentRef"`

	ConfigValues *ConfigValues `mandatory:"false" json:"configValues"`

	// The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
	ObjectStatus *int `mandatory:"false" json:"objectStatus"`

	// Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
	Name *string `mandatory:"false" json:"name"`

	// Detailed description for the object.
	Description *string `mandatory:"false" json:"description"`

	// An array of fields.
	Fields []TypedObject `mandatory:"false" json:"fields"`

	SplitCondition *Expression `mandatory:"false" json:"splitCondition"`

	// The port details for the data asset.Type.
	PortType ConditionalOutputPortPortTypeEnum `mandatory:"false" json:"portType,omitempty"`
}

// GetKey returns Key
func (m ConditionalOutputPort) GetKey() *string {
	return m.Key
}

// GetModelVersion returns ModelVersion
func (m ConditionalOutputPort) GetModelVersion() *string {
	return m.ModelVersion
}

// GetParentRef returns ParentRef
func (m ConditionalOutputPort) GetParentRef() *ParentReference {
	return m.ParentRef
}

// GetConfigValues returns ConfigValues
func (m ConditionalOutputPort) GetConfigValues() *ConfigValues {
	return m.ConfigValues
}

// GetObjectStatus returns ObjectStatus
func (m ConditionalOutputPort) GetObjectStatus() *int {
	return m.ObjectStatus
}

// GetName returns Name
func (m ConditionalOutputPort) GetName() *string {
	return m.Name
}

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

func (m ConditionalOutputPort) 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 ConditionalOutputPort) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	if _, ok := GetMappingConditionalOutputPortPortTypeEnum(string(m.PortType)); !ok && m.PortType != "" {
		errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for PortType: %s. Supported values are: %s.", m.PortType, strings.Join(GetConditionalOutputPortPortTypeEnumStringValues(), ",")))
	}

	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// MarshalJSON marshals to json representation
func (m ConditionalOutputPort) MarshalJSON() (buff []byte, e error) {
	type MarshalTypeConditionalOutputPort ConditionalOutputPort
	s := struct {
		DiscriminatorParam string `json:"modelType"`
		MarshalTypeConditionalOutputPort
	}{
		"CONDITIONAL_OUTPUT_PORT",
		(MarshalTypeConditionalOutputPort)(m),
	}

	return json.Marshal(&s)
}

// UnmarshalJSON unmarshals from json
func (m *ConditionalOutputPort) UnmarshalJSON(data []byte) (e error) {
	model := struct {
		Key            *string                           `json:"key"`
		ModelVersion   *string                           `json:"modelVersion"`
		ParentRef      *ParentReference                  `json:"parentRef"`
		ConfigValues   *ConfigValues                     `json:"configValues"`
		ObjectStatus   *int                              `json:"objectStatus"`
		Name           *string                           `json:"name"`
		Description    *string                           `json:"description"`
		PortType       ConditionalOutputPortPortTypeEnum `json:"portType"`
		Fields         []typedobject                     `json:"fields"`
		SplitCondition *Expression                       `json:"splitCondition"`
	}{}

	e = json.Unmarshal(data, &model)
	if e != nil {
		return
	}
	var nn interface{}
	m.Key = model.Key

	m.ModelVersion = model.ModelVersion

	m.ParentRef = model.ParentRef

	m.ConfigValues = model.ConfigValues

	m.ObjectStatus = model.ObjectStatus

	m.Name = model.Name

	m.Description = model.Description

	m.PortType = model.PortType

	m.Fields = make([]TypedObject, len(model.Fields))
	for i, n := range model.Fields {
		nn, e = n.UnmarshalPolymorphicJSON(n.JsonData)
		if e != nil {
			return e
		}
		if nn != nil {
			m.Fields[i] = nn.(TypedObject)
		} else {
			m.Fields[i] = nil
		}
	}
	m.SplitCondition = model.SplitCondition

	return
}

// ConditionalOutputPortPortTypeEnum Enum with underlying type: string
type ConditionalOutputPortPortTypeEnum string

// Set of constants representing the allowable values for ConditionalOutputPortPortTypeEnum
const (
	ConditionalOutputPortPortTypeData    ConditionalOutputPortPortTypeEnum = "DATA"
	ConditionalOutputPortPortTypeControl ConditionalOutputPortPortTypeEnum = "CONTROL"
	ConditionalOutputPortPortTypeModel   ConditionalOutputPortPortTypeEnum = "MODEL"
)

var mappingConditionalOutputPortPortTypeEnum = map[string]ConditionalOutputPortPortTypeEnum{
	"DATA":    ConditionalOutputPortPortTypeData,
	"CONTROL": ConditionalOutputPortPortTypeControl,
	"MODEL":   ConditionalOutputPortPortTypeModel,
}

var mappingConditionalOutputPortPortTypeEnumLowerCase = map[string]ConditionalOutputPortPortTypeEnum{
	"data":    ConditionalOutputPortPortTypeData,
	"control": ConditionalOutputPortPortTypeControl,
	"model":   ConditionalOutputPortPortTypeModel,
}

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

// GetConditionalOutputPortPortTypeEnumStringValues Enumerates the set of values in String for ConditionalOutputPortPortTypeEnum
func GetConditionalOutputPortPortTypeEnumStringValues() []string {
	return []string{
		"DATA",
		"CONTROL",
		"MODEL",
	}
}

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