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

// Target The information about the target operator. The target operator lets you specify the data entity to store the transformed data.
type Target 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"`

	// 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"`

	// Details about the operator.
	Description *string `mandatory:"false" json:"description"`

	// The version of the object that is used to track changes in the object instance.
	ObjectVersion *int `mandatory:"false" json:"objectVersion"`

	// An array of input ports.
	InputPorts []InputPort `mandatory:"false" json:"inputPorts"`

	// An array of output ports.
	OutputPorts []TypedObject `mandatory:"false" json:"outputPorts"`

	// 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"`

	// Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
	Identifier *string `mandatory:"false" json:"identifier"`

	// An array of parameters used in the data flow.
	Parameters []Parameter `mandatory:"false" json:"parameters"`

	OpConfigValues *ConfigValues `mandatory:"false" json:"opConfigValues"`

	Entity DataEntity `mandatory:"false" json:"entity"`

	// Specifies the read access.
	IsReadAccess *bool `mandatory:"false" json:"isReadAccess"`

	// Specifies the copy fields.
	IsCopyFields *bool `mandatory:"false" json:"isCopyFields"`

	// Specifies if this uses a predefined shape.
	IsPredefinedShape *bool `mandatory:"false" json:"isPredefinedShape"`

	// Specifies if entity name is the same as source.
	IsUseSameSourceName *bool `mandatory:"false" json:"isUseSameSourceName"`

	// Prefix for the entity Name.
	TargetEntityNamePrefix *string `mandatory:"false" json:"targetEntityNamePrefix"`

	// Suffix for the entity Name.
	TargetEntityNameSuffix *string `mandatory:"false" json:"targetEntityNameSuffix"`

	SchemaDriftConfig *SchemaDriftConfig `mandatory:"false" json:"schemaDriftConfig"`

	FixedDataShape *Shape `mandatory:"false" json:"fixedDataShape"`

	WriteOperationConfig *WriteOperationConfig `mandatory:"false" json:"writeOperationConfig"`

	// A numeric loading order number for the target.
	LoadOrder *int `mandatory:"false" json:"loadOrder"`

	// Specifies the data property.
	DataProperty TargetDataPropertyEnum `mandatory:"false" json:"dataProperty,omitempty"`
}

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

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

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

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

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

// GetObjectVersion returns ObjectVersion
func (m Target) GetObjectVersion() *int {
	return m.ObjectVersion
}

// GetInputPorts returns InputPorts
func (m Target) GetInputPorts() []InputPort {
	return m.InputPorts
}

// GetOutputPorts returns OutputPorts
func (m Target) GetOutputPorts() []TypedObject {
	return m.OutputPorts
}

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

// GetIdentifier returns Identifier
func (m Target) GetIdentifier() *string {
	return m.Identifier
}

// GetParameters returns Parameters
func (m Target) GetParameters() []Parameter {
	return m.Parameters
}

// GetOpConfigValues returns OpConfigValues
func (m Target) GetOpConfigValues() *ConfigValues {
	return m.OpConfigValues
}

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

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

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

	return json.Marshal(&s)
}

// UnmarshalJSON unmarshals from json
func (m *Target) UnmarshalJSON(data []byte) (e error) {
	model := struct {
		Key                    *string                `json:"key"`
		ModelVersion           *string                `json:"modelVersion"`
		ParentRef              *ParentReference       `json:"parentRef"`
		Name                   *string                `json:"name"`
		Description            *string                `json:"description"`
		ObjectVersion          *int                   `json:"objectVersion"`
		InputPorts             []InputPort            `json:"inputPorts"`
		OutputPorts            []typedobject          `json:"outputPorts"`
		ObjectStatus           *int                   `json:"objectStatus"`
		Identifier             *string                `json:"identifier"`
		Parameters             []Parameter            `json:"parameters"`
		OpConfigValues         *ConfigValues          `json:"opConfigValues"`
		Entity                 dataentity             `json:"entity"`
		IsReadAccess           *bool                  `json:"isReadAccess"`
		IsCopyFields           *bool                  `json:"isCopyFields"`
		IsPredefinedShape      *bool                  `json:"isPredefinedShape"`
		IsUseSameSourceName    *bool                  `json:"isUseSameSourceName"`
		TargetEntityNamePrefix *string                `json:"targetEntityNamePrefix"`
		TargetEntityNameSuffix *string                `json:"targetEntityNameSuffix"`
		DataProperty           TargetDataPropertyEnum `json:"dataProperty"`
		SchemaDriftConfig      *SchemaDriftConfig     `json:"schemaDriftConfig"`
		FixedDataShape         *Shape                 `json:"fixedDataShape"`
		WriteOperationConfig   *WriteOperationConfig  `json:"writeOperationConfig"`
		LoadOrder              *int                   `json:"loadOrder"`
	}{}

	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.Name = model.Name

	m.Description = model.Description

	m.ObjectVersion = model.ObjectVersion

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

	m.Identifier = model.Identifier

	m.Parameters = make([]Parameter, len(model.Parameters))
	copy(m.Parameters, model.Parameters)
	m.OpConfigValues = model.OpConfigValues

	nn, e = model.Entity.UnmarshalPolymorphicJSON(model.Entity.JsonData)
	if e != nil {
		return
	}
	if nn != nil {
		m.Entity = nn.(DataEntity)
	} else {
		m.Entity = nil
	}

	m.IsReadAccess = model.IsReadAccess

	m.IsCopyFields = model.IsCopyFields

	m.IsPredefinedShape = model.IsPredefinedShape

	m.IsUseSameSourceName = model.IsUseSameSourceName

	m.TargetEntityNamePrefix = model.TargetEntityNamePrefix

	m.TargetEntityNameSuffix = model.TargetEntityNameSuffix

	m.DataProperty = model.DataProperty

	m.SchemaDriftConfig = model.SchemaDriftConfig

	m.FixedDataShape = model.FixedDataShape

	m.WriteOperationConfig = model.WriteOperationConfig

	m.LoadOrder = model.LoadOrder

	return
}

// TargetDataPropertyEnum Enum with underlying type: string
type TargetDataPropertyEnum string

// Set of constants representing the allowable values for TargetDataPropertyEnum
const (
	TargetDataPropertyTruncate  TargetDataPropertyEnum = "TRUNCATE"
	TargetDataPropertyMerge     TargetDataPropertyEnum = "MERGE"
	TargetDataPropertyBackup    TargetDataPropertyEnum = "BACKUP"
	TargetDataPropertyOverwrite TargetDataPropertyEnum = "OVERWRITE"
	TargetDataPropertyAppend    TargetDataPropertyEnum = "APPEND"
	TargetDataPropertyIgnore    TargetDataPropertyEnum = "IGNORE"
)

var mappingTargetDataPropertyEnum = map[string]TargetDataPropertyEnum{
	"TRUNCATE":  TargetDataPropertyTruncate,
	"MERGE":     TargetDataPropertyMerge,
	"BACKUP":    TargetDataPropertyBackup,
	"OVERWRITE": TargetDataPropertyOverwrite,
	"APPEND":    TargetDataPropertyAppend,
	"IGNORE":    TargetDataPropertyIgnore,
}

var mappingTargetDataPropertyEnumLowerCase = map[string]TargetDataPropertyEnum{
	"truncate":  TargetDataPropertyTruncate,
	"merge":     TargetDataPropertyMerge,
	"backup":    TargetDataPropertyBackup,
	"overwrite": TargetDataPropertyOverwrite,
	"append":    TargetDataPropertyAppend,
	"ignore":    TargetDataPropertyIgnore,
}

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

// GetTargetDataPropertyEnumStringValues Enumerates the set of values in String for TargetDataPropertyEnum
func GetTargetDataPropertyEnumStringValues() []string {
	return []string{
		"TRUNCATE",
		"MERGE",
		"BACKUP",
		"OVERWRITE",
		"APPEND",
		"IGNORE",
	}
}

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