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

// OS Management Hub API
//
// Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds.
// For more information, see Overview of OS Management Hub (https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm).
//

package osmanagementhub

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

// ManagementStation Provides information about the management station, including name, state, and configuration.
type ManagementStation struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management station.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the management station.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name for the management station.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// Hostname of the management station.
	Hostname *string `mandatory:"true" json:"hostname"`

	Proxy *ProxyConfiguration `mandatory:"true" json:"proxy"`

	Mirror *MirrorConfiguration `mandatory:"true" json:"mirror"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance that is acting as the management station.
	ManagedInstanceId *string `mandatory:"false" json:"managedInstanceId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job for the mirror sync.
	ScheduledJobId *string `mandatory:"false" json:"scheduledJobId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the registration profile used for the management station.
	ProfileId *string `mandatory:"false" json:"profileId"`

	// User-specified description for the management station.
	Description *string `mandatory:"false" json:"description"`

	// Current state of the mirror sync for the management station.
	OverallState OverallStateEnum `mandatory:"false" json:"overallState,omitempty"`

	// A decimal number representing the progress of the current mirror sync.
	OverallPercentage *int `mandatory:"false" json:"overallPercentage"`

	// A decimal number representing the amount of mirror capacity used by the sync.
	MirrorCapacity *int `mandatory:"false" json:"mirrorCapacity"`

	// The number of software sources that the station is mirroring.
	TotalMirrors *int `mandatory:"false" json:"totalMirrors"`

	MirrorSyncStatus *MirrorSyncStatus `mandatory:"false" json:"mirrorSyncStatus"`

	Health *StationHealth `mandatory:"false" json:"health"`

	// The current state of the management station.
	LifecycleState ManagementStationLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

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

	if _, ok := GetMappingOverallStateEnum(string(m.OverallState)); !ok && m.OverallState != "" {
		errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for OverallState: %s. Supported values are: %s.", m.OverallState, strings.Join(GetOverallStateEnumStringValues(), ",")))
	}
	if _, ok := GetMappingManagementStationLifecycleStateEnum(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(GetManagementStationLifecycleStateEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// ManagementStationLifecycleStateEnum Enum with underlying type: string
type ManagementStationLifecycleStateEnum string

// Set of constants representing the allowable values for ManagementStationLifecycleStateEnum
const (
	ManagementStationLifecycleStateCreating ManagementStationLifecycleStateEnum = "CREATING"
	ManagementStationLifecycleStateUpdating ManagementStationLifecycleStateEnum = "UPDATING"
	ManagementStationLifecycleStateActive   ManagementStationLifecycleStateEnum = "ACTIVE"
	ManagementStationLifecycleStateDeleting ManagementStationLifecycleStateEnum = "DELETING"
	ManagementStationLifecycleStateDeleted  ManagementStationLifecycleStateEnum = "DELETED"
	ManagementStationLifecycleStateFailed   ManagementStationLifecycleStateEnum = "FAILED"
)

var mappingManagementStationLifecycleStateEnum = map[string]ManagementStationLifecycleStateEnum{
	"CREATING": ManagementStationLifecycleStateCreating,
	"UPDATING": ManagementStationLifecycleStateUpdating,
	"ACTIVE":   ManagementStationLifecycleStateActive,
	"DELETING": ManagementStationLifecycleStateDeleting,
	"DELETED":  ManagementStationLifecycleStateDeleted,
	"FAILED":   ManagementStationLifecycleStateFailed,
}

var mappingManagementStationLifecycleStateEnumLowerCase = map[string]ManagementStationLifecycleStateEnum{
	"creating": ManagementStationLifecycleStateCreating,
	"updating": ManagementStationLifecycleStateUpdating,
	"active":   ManagementStationLifecycleStateActive,
	"deleting": ManagementStationLifecycleStateDeleting,
	"deleted":  ManagementStationLifecycleStateDeleted,
	"failed":   ManagementStationLifecycleStateFailed,
}

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

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

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