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

// Identity and Access Management Service API
//
// Use the Identity and Access Management Service API to manage users, groups, identity domains, compartments, policies, tagging, and limits. For information about managing users, groups, compartments, and policies, see Identity and Access Management (without identity domains) (https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about tagging and service limits, see Tagging (https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/taggingoverview.htm) and Service Limits (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/servicelimits.htm). For information about creating, modifying, and deleting identity domains, see Identity and Access Management (with identity domains) (https://docs.cloud.oracle.com/iaas/Content/Identity/home.htm).
//

package identity

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

// DbCredential Database credentials are needed for onboarding cloud database to identity.
// The DB credentials are used for DB authentication with the service.
type DbCredential struct {

	// The OCID of the DB credential.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the user the DB credential belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// Date and time the `DbCredential` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Date and time when this credential will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`

	// The credential's current state. After creating a DB credential, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState DbCredentialLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The detailed status of INACTIVE lifecycleState.
	LifecycleDetails *int64 `mandatory:"false" json:"lifecycleDetails"`
}

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

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

// DbCredentialLifecycleStateEnum Enum with underlying type: string
type DbCredentialLifecycleStateEnum string

// Set of constants representing the allowable values for DbCredentialLifecycleStateEnum
const (
	DbCredentialLifecycleStateCreating DbCredentialLifecycleStateEnum = "CREATING"
	DbCredentialLifecycleStateActive   DbCredentialLifecycleStateEnum = "ACTIVE"
	DbCredentialLifecycleStateDeleting DbCredentialLifecycleStateEnum = "DELETING"
	DbCredentialLifecycleStateDeleted  DbCredentialLifecycleStateEnum = "DELETED"
)

var mappingDbCredentialLifecycleStateEnum = map[string]DbCredentialLifecycleStateEnum{
	"CREATING": DbCredentialLifecycleStateCreating,
	"ACTIVE":   DbCredentialLifecycleStateActive,
	"DELETING": DbCredentialLifecycleStateDeleting,
	"DELETED":  DbCredentialLifecycleStateDeleted,
}

var mappingDbCredentialLifecycleStateEnumLowerCase = map[string]DbCredentialLifecycleStateEnum{
	"creating": DbCredentialLifecycleStateCreating,
	"active":   DbCredentialLifecycleStateActive,
	"deleting": DbCredentialLifecycleStateDeleting,
	"deleted":  DbCredentialLifecycleStateDeleted,
}

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

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

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