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

// Connection The connection for a data asset.
type Connection interface {

	// Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create.
	GetKey() *string

	// The model version of an object.
	GetModelVersion() *string

	GetParentRef() *ParentReference

	// 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.
	GetName() *string

	// User-defined description for the connection.
	GetDescription() *string

	// The version of the object that is used to track changes in the object instance.
	GetObjectVersion() *int

	// The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
	GetObjectStatus() *int

	// Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
	GetIdentifier() *string

	GetPrimarySchema() *Schema

	// The properties for the connection.
	GetConnectionProperties() []ConnectionProperty

	// The default property for the connection.
	GetIsDefault() *bool

	GetMetadata() *ObjectMetadata

	// A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.
	GetKeyMap() map[string]string
}

type connection struct {
	JsonData             []byte
	Key                  *string              `mandatory:"false" json:"key"`
	ModelVersion         *string              `mandatory:"false" json:"modelVersion"`
	ParentRef            *ParentReference     `mandatory:"false" json:"parentRef"`
	Name                 *string              `mandatory:"false" json:"name"`
	Description          *string              `mandatory:"false" json:"description"`
	ObjectVersion        *int                 `mandatory:"false" json:"objectVersion"`
	ObjectStatus         *int                 `mandatory:"false" json:"objectStatus"`
	Identifier           *string              `mandatory:"false" json:"identifier"`
	PrimarySchema        *Schema              `mandatory:"false" json:"primarySchema"`
	ConnectionProperties []ConnectionProperty `mandatory:"false" json:"connectionProperties"`
	IsDefault            *bool                `mandatory:"false" json:"isDefault"`
	Metadata             *ObjectMetadata      `mandatory:"false" json:"metadata"`
	KeyMap               map[string]string    `mandatory:"false" json:"keyMap"`
	ModelType            string               `json:"modelType"`
}

// UnmarshalJSON unmarshals json
func (m *connection) UnmarshalJSON(data []byte) error {
	m.JsonData = data
	type Unmarshalerconnection connection
	s := struct {
		Model Unmarshalerconnection
	}{}
	err := json.Unmarshal(data, &s.Model)
	if err != nil {
		return err
	}
	m.Key = s.Model.Key
	m.ModelVersion = s.Model.ModelVersion
	m.ParentRef = s.Model.ParentRef
	m.Name = s.Model.Name
	m.Description = s.Model.Description
	m.ObjectVersion = s.Model.ObjectVersion
	m.ObjectStatus = s.Model.ObjectStatus
	m.Identifier = s.Model.Identifier
	m.PrimarySchema = s.Model.PrimarySchema
	m.ConnectionProperties = s.Model.ConnectionProperties
	m.IsDefault = s.Model.IsDefault
	m.Metadata = s.Model.Metadata
	m.KeyMap = s.Model.KeyMap
	m.ModelType = s.Model.ModelType

	return err
}

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

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

	var err error
	switch m.ModelType {
	case "AMAZON_S3_CONNECTION":
		mm := ConnectionFromAmazonS3{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "BIP_CONNECTION":
		mm := ConnectionFromBip{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "MYSQL_CONNECTION":
		mm := ConnectionFromMySql{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "OAUTH2_CONNECTION":
		mm := ConnectionFromOAuth2{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "GENERIC_JDBC_CONNECTION":
		mm := ConnectionFromJdbc{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "BICC_CONNECTION":
		mm := ConnectionFromBicc{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "MYSQL_HEATWAVE_CONNECTION":
		mm := ConnectionFromMySqlHeatWave{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "REST_BASIC_AUTH_CONNECTION":
		mm := ConnectionFromRestBasicAuth{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "ORACLE_OBJECT_STORAGE_CONNECTION":
		mm := ConnectionFromObjectStorage{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "ORACLE_ADWC_CONNECTION":
		mm := ConnectionFromAdwc{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "ORACLE_ATP_CONNECTION":
		mm := ConnectionFromAtp{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "ORACLEDB_CONNECTION":
		mm := ConnectionFromOracle{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "ORACLE_PEOPLESOFT_CONNECTION":
		mm := ConnectionFromOraclePeopleSoft{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "HDFS_CONNECTION":
		mm := ConnectionFromHdfs{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "ORACLE_EBS_CONNECTION":
		mm := ConnectionFromOracleEbs{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "ORACLE_SIEBEL_CONNECTION":
		mm := ConnectionFromOracleSiebel{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "REST_NO_AUTH_CONNECTION":
		mm := ConnectionFromRestNoAuth{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	case "LAKE_CONNECTION":
		mm := ConnectionFromLake{}
		err = json.Unmarshal(data, &mm)
		return mm, err
	default:
		common.Logf("Recieved unsupported enum value for Connection: %s.", m.ModelType)
		return *m, nil
	}
}

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

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

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

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

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

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

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

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

// GetPrimarySchema returns PrimarySchema
func (m connection) GetPrimarySchema() *Schema {
	return m.PrimarySchema
}

// GetConnectionProperties returns ConnectionProperties
func (m connection) GetConnectionProperties() []ConnectionProperty {
	return m.ConnectionProperties
}

// GetIsDefault returns IsDefault
func (m connection) GetIsDefault() *bool {
	return m.IsDefault
}

// GetMetadata returns Metadata
func (m connection) GetMetadata() *ObjectMetadata {
	return m.Metadata
}

// GetKeyMap returns KeyMap
func (m connection) GetKeyMap() map[string]string {
	return m.KeyMap
}

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

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

// ConnectionModelTypeEnum Enum with underlying type: string
type ConnectionModelTypeEnum string

// Set of constants representing the allowable values for ConnectionModelTypeEnum
const (
	ConnectionModelTypeOracleAdwcConnection          ConnectionModelTypeEnum = "ORACLE_ADWC_CONNECTION"
	ConnectionModelTypeOracleAtpConnection           ConnectionModelTypeEnum = "ORACLE_ATP_CONNECTION"
	ConnectionModelTypeOracleObjectStorageConnection ConnectionModelTypeEnum = "ORACLE_OBJECT_STORAGE_CONNECTION"
	ConnectionModelTypeOracledbConnection            ConnectionModelTypeEnum = "ORACLEDB_CONNECTION"
	ConnectionModelTypeMysqlConnection               ConnectionModelTypeEnum = "MYSQL_CONNECTION"
	ConnectionModelTypeGenericJdbcConnection         ConnectionModelTypeEnum = "GENERIC_JDBC_CONNECTION"
	ConnectionModelTypeBiccConnection                ConnectionModelTypeEnum = "BICC_CONNECTION"
	ConnectionModelTypeAmazonS3Connection            ConnectionModelTypeEnum = "AMAZON_S3_CONNECTION"
	ConnectionModelTypeBipConnection                 ConnectionModelTypeEnum = "BIP_CONNECTION"
	ConnectionModelTypeLakeConnection                ConnectionModelTypeEnum = "LAKE_CONNECTION"
	ConnectionModelTypeOraclePeoplesoftConnection    ConnectionModelTypeEnum = "ORACLE_PEOPLESOFT_CONNECTION"
	ConnectionModelTypeOracleEbsConnection           ConnectionModelTypeEnum = "ORACLE_EBS_CONNECTION"
	ConnectionModelTypeOracleSiebelConnection        ConnectionModelTypeEnum = "ORACLE_SIEBEL_CONNECTION"
	ConnectionModelTypeHdfsConnection                ConnectionModelTypeEnum = "HDFS_CONNECTION"
	ConnectionModelTypeMysqlHeatwaveConnection       ConnectionModelTypeEnum = "MYSQL_HEATWAVE_CONNECTION"
	ConnectionModelTypeRestNoAuthConnection          ConnectionModelTypeEnum = "REST_NO_AUTH_CONNECTION"
	ConnectionModelTypeRestBasicAuthConnection       ConnectionModelTypeEnum = "REST_BASIC_AUTH_CONNECTION"
	ConnectionModelTypeOauth2Connection              ConnectionModelTypeEnum = "OAUTH2_CONNECTION"
)

var mappingConnectionModelTypeEnum = map[string]ConnectionModelTypeEnum{
	"ORACLE_ADWC_CONNECTION":           ConnectionModelTypeOracleAdwcConnection,
	"ORACLE_ATP_CONNECTION":            ConnectionModelTypeOracleAtpConnection,
	"ORACLE_OBJECT_STORAGE_CONNECTION": ConnectionModelTypeOracleObjectStorageConnection,
	"ORACLEDB_CONNECTION":              ConnectionModelTypeOracledbConnection,
	"MYSQL_CONNECTION":                 ConnectionModelTypeMysqlConnection,
	"GENERIC_JDBC_CONNECTION":          ConnectionModelTypeGenericJdbcConnection,
	"BICC_CONNECTION":                  ConnectionModelTypeBiccConnection,
	"AMAZON_S3_CONNECTION":             ConnectionModelTypeAmazonS3Connection,
	"BIP_CONNECTION":                   ConnectionModelTypeBipConnection,
	"LAKE_CONNECTION":                  ConnectionModelTypeLakeConnection,
	"ORACLE_PEOPLESOFT_CONNECTION":     ConnectionModelTypeOraclePeoplesoftConnection,
	"ORACLE_EBS_CONNECTION":            ConnectionModelTypeOracleEbsConnection,
	"ORACLE_SIEBEL_CONNECTION":         ConnectionModelTypeOracleSiebelConnection,
	"HDFS_CONNECTION":                  ConnectionModelTypeHdfsConnection,
	"MYSQL_HEATWAVE_CONNECTION":        ConnectionModelTypeMysqlHeatwaveConnection,
	"REST_NO_AUTH_CONNECTION":          ConnectionModelTypeRestNoAuthConnection,
	"REST_BASIC_AUTH_CONNECTION":       ConnectionModelTypeRestBasicAuthConnection,
	"OAUTH2_CONNECTION":                ConnectionModelTypeOauth2Connection,
}

var mappingConnectionModelTypeEnumLowerCase = map[string]ConnectionModelTypeEnum{
	"oracle_adwc_connection":           ConnectionModelTypeOracleAdwcConnection,
	"oracle_atp_connection":            ConnectionModelTypeOracleAtpConnection,
	"oracle_object_storage_connection": ConnectionModelTypeOracleObjectStorageConnection,
	"oracledb_connection":              ConnectionModelTypeOracledbConnection,
	"mysql_connection":                 ConnectionModelTypeMysqlConnection,
	"generic_jdbc_connection":          ConnectionModelTypeGenericJdbcConnection,
	"bicc_connection":                  ConnectionModelTypeBiccConnection,
	"amazon_s3_connection":             ConnectionModelTypeAmazonS3Connection,
	"bip_connection":                   ConnectionModelTypeBipConnection,
	"lake_connection":                  ConnectionModelTypeLakeConnection,
	"oracle_peoplesoft_connection":     ConnectionModelTypeOraclePeoplesoftConnection,
	"oracle_ebs_connection":            ConnectionModelTypeOracleEbsConnection,
	"oracle_siebel_connection":         ConnectionModelTypeOracleSiebelConnection,
	"hdfs_connection":                  ConnectionModelTypeHdfsConnection,
	"mysql_heatwave_connection":        ConnectionModelTypeMysqlHeatwaveConnection,
	"rest_no_auth_connection":          ConnectionModelTypeRestNoAuthConnection,
	"rest_basic_auth_connection":       ConnectionModelTypeRestBasicAuthConnection,
	"oauth2_connection":                ConnectionModelTypeOauth2Connection,
}

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

// GetConnectionModelTypeEnumStringValues Enumerates the set of values in String for ConnectionModelTypeEnum
func GetConnectionModelTypeEnumStringValues() []string {
	return []string{
		"ORACLE_ADWC_CONNECTION",
		"ORACLE_ATP_CONNECTION",
		"ORACLE_OBJECT_STORAGE_CONNECTION",
		"ORACLEDB_CONNECTION",
		"MYSQL_CONNECTION",
		"GENERIC_JDBC_CONNECTION",
		"BICC_CONNECTION",
		"AMAZON_S3_CONNECTION",
		"BIP_CONNECTION",
		"LAKE_CONNECTION",
		"ORACLE_PEOPLESOFT_CONNECTION",
		"ORACLE_EBS_CONNECTION",
		"ORACLE_SIEBEL_CONNECTION",
		"HDFS_CONNECTION",
		"MYSQL_HEATWAVE_CONNECTION",
		"REST_NO_AUTH_CONNECTION",
		"REST_BASIC_AUTH_CONNECTION",
		"OAUTH2_CONNECTION",
	}
}

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