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

// Digital Assistant Service Instance API
//
// API to create and maintain Oracle Digital Assistant service instances.
//

package oda

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

// OdaInstanceAttachment Description of an ODA instance attachment.
type OdaInstanceAttachment struct {

	// Unique immutable identifier that was assigned when the ODA instance attachment was created.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the ODA instance to which the attachment applies.
	InstanceId *string `mandatory:"true" json:"instanceId"`

	// The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which the ODA instance is or is being attached.
	AttachToId *string `mandatory:"true" json:"attachToId"`

	// The type of attachment defined as an enum.
	AttachmentType OdaInstanceAttachmentAttachmentTypeEnum `mandatory:"true" json:"attachmentType"`

	// The current state of the attachment.
	LifecycleState OdaInstanceAttachmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Attachment-specific metadata, defined by the target service.
	AttachmentMetadata *string `mandatory:"false" json:"attachmentMetadata"`

	// List of operation names that are restricted while this ODA instance is attached.
	RestrictedOperations []string `mandatory:"false" json:"restrictedOperations"`

	Owner *OdaInstanceOwner `mandatory:"false" json:"owner"`

	// The time the attachment was created. An RFC3339 formatted datetime string
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The time the attachment was last modified. An RFC3339 formatted datetime string
	TimeLastUpdate *common.SDKTime `mandatory:"false" json:"timeLastUpdate"`

	// Simple key-value pair that is applied without any predefined name, type, or scope.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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

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

// OdaInstanceAttachmentAttachmentTypeEnum Enum with underlying type: string
type OdaInstanceAttachmentAttachmentTypeEnum string

// Set of constants representing the allowable values for OdaInstanceAttachmentAttachmentTypeEnum
const (
	OdaInstanceAttachmentAttachmentTypeFusion OdaInstanceAttachmentAttachmentTypeEnum = "FUSION"
	OdaInstanceAttachmentAttachmentTypeMax    OdaInstanceAttachmentAttachmentTypeEnum = "MAX"
)

var mappingOdaInstanceAttachmentAttachmentTypeEnum = map[string]OdaInstanceAttachmentAttachmentTypeEnum{
	"FUSION": OdaInstanceAttachmentAttachmentTypeFusion,
	"MAX":    OdaInstanceAttachmentAttachmentTypeMax,
}

var mappingOdaInstanceAttachmentAttachmentTypeEnumLowerCase = map[string]OdaInstanceAttachmentAttachmentTypeEnum{
	"fusion": OdaInstanceAttachmentAttachmentTypeFusion,
	"max":    OdaInstanceAttachmentAttachmentTypeMax,
}

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

// GetOdaInstanceAttachmentAttachmentTypeEnumStringValues Enumerates the set of values in String for OdaInstanceAttachmentAttachmentTypeEnum
func GetOdaInstanceAttachmentAttachmentTypeEnumStringValues() []string {
	return []string{
		"FUSION",
		"MAX",
	}
}

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

// OdaInstanceAttachmentLifecycleStateEnum Enum with underlying type: string
type OdaInstanceAttachmentLifecycleStateEnum string

// Set of constants representing the allowable values for OdaInstanceAttachmentLifecycleStateEnum
const (
	OdaInstanceAttachmentLifecycleStateAttaching OdaInstanceAttachmentLifecycleStateEnum = "ATTACHING"
	OdaInstanceAttachmentLifecycleStateActive    OdaInstanceAttachmentLifecycleStateEnum = "ACTIVE"
	OdaInstanceAttachmentLifecycleStateDetaching OdaInstanceAttachmentLifecycleStateEnum = "DETACHING"
	OdaInstanceAttachmentLifecycleStateInactive  OdaInstanceAttachmentLifecycleStateEnum = "INACTIVE"
	OdaInstanceAttachmentLifecycleStateFailed    OdaInstanceAttachmentLifecycleStateEnum = "FAILED"
)

var mappingOdaInstanceAttachmentLifecycleStateEnum = map[string]OdaInstanceAttachmentLifecycleStateEnum{
	"ATTACHING": OdaInstanceAttachmentLifecycleStateAttaching,
	"ACTIVE":    OdaInstanceAttachmentLifecycleStateActive,
	"DETACHING": OdaInstanceAttachmentLifecycleStateDetaching,
	"INACTIVE":  OdaInstanceAttachmentLifecycleStateInactive,
	"FAILED":    OdaInstanceAttachmentLifecycleStateFailed,
}

var mappingOdaInstanceAttachmentLifecycleStateEnumLowerCase = map[string]OdaInstanceAttachmentLifecycleStateEnum{
	"attaching": OdaInstanceAttachmentLifecycleStateAttaching,
	"active":    OdaInstanceAttachmentLifecycleStateActive,
	"detaching": OdaInstanceAttachmentLifecycleStateDetaching,
	"inactive":  OdaInstanceAttachmentLifecycleStateInactive,
	"failed":    OdaInstanceAttachmentLifecycleStateFailed,
}

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

// GetOdaInstanceAttachmentLifecycleStateEnumStringValues Enumerates the set of values in String for OdaInstanceAttachmentLifecycleStateEnum
func GetOdaInstanceAttachmentLifecycleStateEnumStringValues() []string {
	return []string{
		"ATTACHING",
		"ACTIVE",
		"DETACHING",
		"INACTIVE",
		"FAILED",
	}
}

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