/
backend_set_health.go
120 lines (101 loc) · 5.13 KB
/
backend_set_health.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// 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.
// Load Balancing API
//
// API for the Load Balancing service. Use this API to manage load balancers, backend sets, and related items. For more
// information, see Overview of Load Balancing (https://docs.cloud.oracle.com/iaas/Content/Balance/Concepts/balanceoverview.htm).
//
package loadbalancer
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// BackendSetHealth The health status details for a backend set.
// This object does not explicitly enumerate backend servers with a status of `OK`. However, they are included in the
// `totalBackendCount` sum.
type BackendSetHealth struct {
// Overall health status of the backend set.
// * **OK:** All backend servers in the backend set return a status of `OK`.
// * **WARNING:** Half or more of the backend set's backend servers return a status of `OK` and at least one backend
// server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`.
// * **CRITICAL:** Fewer than half of the backend set's backend servers return a status of `OK`.
// * **UNKNOWN:** More than half of the backend set's backend servers return a status of `UNKNOWN`, the system was
// unable to retrieve metrics, or the backend set does not have a listener attached.
Status BackendSetHealthStatusEnum `mandatory:"true" json:"status"`
// A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by
// IP address and port.
// Example: `10.0.0.3:8080`
WarningStateBackendNames []string `mandatory:"true" json:"warningStateBackendNames"`
// A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by
// IP address and port.
// Example: `10.0.0.4:8080`
CriticalStateBackendNames []string `mandatory:"true" json:"criticalStateBackendNames"`
// A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by
// IP address and port.
// Example: `10.0.0.5:8080`
UnknownStateBackendNames []string `mandatory:"true" json:"unknownStateBackendNames"`
// The total number of backend servers in this backend set.
// Example: `7`
TotalBackendCount *int `mandatory:"true" json:"totalBackendCount"`
}
func (m BackendSetHealth) 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 BackendSetHealth) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingBackendSetHealthStatusEnum(string(m.Status)); !ok && m.Status != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Status: %s. Supported values are: %s.", m.Status, strings.Join(GetBackendSetHealthStatusEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// BackendSetHealthStatusEnum Enum with underlying type: string
type BackendSetHealthStatusEnum string
// Set of constants representing the allowable values for BackendSetHealthStatusEnum
const (
BackendSetHealthStatusOk BackendSetHealthStatusEnum = "OK"
BackendSetHealthStatusWarning BackendSetHealthStatusEnum = "WARNING"
BackendSetHealthStatusCritical BackendSetHealthStatusEnum = "CRITICAL"
BackendSetHealthStatusUnknown BackendSetHealthStatusEnum = "UNKNOWN"
)
var mappingBackendSetHealthStatusEnum = map[string]BackendSetHealthStatusEnum{
"OK": BackendSetHealthStatusOk,
"WARNING": BackendSetHealthStatusWarning,
"CRITICAL": BackendSetHealthStatusCritical,
"UNKNOWN": BackendSetHealthStatusUnknown,
}
var mappingBackendSetHealthStatusEnumLowerCase = map[string]BackendSetHealthStatusEnum{
"ok": BackendSetHealthStatusOk,
"warning": BackendSetHealthStatusWarning,
"critical": BackendSetHealthStatusCritical,
"unknown": BackendSetHealthStatusUnknown,
}
// GetBackendSetHealthStatusEnumValues Enumerates the set of values for BackendSetHealthStatusEnum
func GetBackendSetHealthStatusEnumValues() []BackendSetHealthStatusEnum {
values := make([]BackendSetHealthStatusEnum, 0)
for _, v := range mappingBackendSetHealthStatusEnum {
values = append(values, v)
}
return values
}
// GetBackendSetHealthStatusEnumStringValues Enumerates the set of values in String for BackendSetHealthStatusEnum
func GetBackendSetHealthStatusEnumStringValues() []string {
return []string{
"OK",
"WARNING",
"CRITICAL",
"UNKNOWN",
}
}
// GetMappingBackendSetHealthStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingBackendSetHealthStatusEnum(val string) (BackendSetHealthStatusEnum, bool) {
enum, ok := mappingBackendSetHealthStatusEnumLowerCase[strings.ToLower(val)]
return enum, ok
}