-
Notifications
You must be signed in to change notification settings - Fork 79
/
load_balancer.go
190 lines (153 loc) · 9.32 KB
/
load_balancer.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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
// 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"
)
// LoadBalancer The properties that define a load balancer. For more information, see
// Managing a Load Balancer (https://docs.cloud.oracle.com/Content/Balance/Tasks/managingloadbalancer.htm).
// To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
// talk to an administrator. If you're an administrator who needs to write policies to give users access, see
// Getting Started with Policies (https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
// For information about endpoints and signing API requests, see
// About the API (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see
// SDKS and Other Tools (https://docs.cloud.oracle.com/Content/API/Concepts/sdks.htm).
type LoadBalancer struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Example: `example_load_balancer`
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the load balancer.
LifecycleState LoadBalancerLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the load balancer was created, in the format defined by RFC3339.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A template that determines the total pre-provisioned bandwidth (ingress plus egress).
// To get a list of available shapes, use the ListShapes
// operation.
// Example: `100Mbps`
ShapeName *string `mandatory:"true" json:"shapeName"`
// An array of IP addresses.
IpAddresses []IpAddress `mandatory:"false" json:"ipAddresses"`
ShapeDetails *ShapeDetails `mandatory:"false" json:"shapeDetails"`
// Whether the load balancer has a VCN-local (private) IP address.
// If "true", the service assigns a private IP address to the load balancer.
// If "false", the service assigns a public IP address to the load balancer.
// A public load balancer is accessible from the internet, depending on your VCN's
// security list rules (https://docs.cloud.oracle.com/Content/Network/Concepts/securitylists.htm). For more information about public and
// private load balancers, see How Load Balancing Works (https://docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works).
// Example: `true`
IsPrivate *bool `mandatory:"false" json:"isPrivate"`
// Whether or not the load balancer has delete protection enabled.
// If "true", the loadbalancer will be protected against deletion if configured to accept traffic.
// If "false", the loadbalancer will not be protected against deletion.
// Delete protection is not be enabled unless this field is set to "true".
// Example: `true`
IsDeleteProtectionEnabled *bool `mandatory:"false" json:"isDeleteProtectionEnabled"`
// An array of subnet OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
SubnetIds []string `mandatory:"false" json:"subnetIds"`
// An array of NSG OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with the load
// balancer.
// During the load balancer's creation, the service adds the new load balancer to the specified NSGs.
// The benefits of associating the load balancer with NSGs include:
// * NSGs define network security rules to govern ingress and egress traffic for the load balancer.
// * The network security rules of other resources can reference the NSGs associated with the load balancer
// to ensure access.
// Example: ["ocid1.nsg.oc1.phx.unique_ID"]
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
Listeners map[string]Listener `mandatory:"false" json:"listeners"`
Hostnames map[string]Hostname `mandatory:"false" json:"hostnames"`
SslCipherSuites map[string]SslCipherSuite `mandatory:"false" json:"sslCipherSuites"`
Certificates map[string]Certificate `mandatory:"false" json:"certificates"`
BackendSets map[string]BackendSet `mandatory:"false" json:"backendSets"`
PathRouteSets map[string]PathRouteSet `mandatory:"false" json:"pathRouteSets"`
// 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/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/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.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
// System tags can be viewed by users, but can only be created by the system.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
RuleSets map[string]RuleSet `mandatory:"false" json:"ruleSets"`
RoutingPolicies map[string]RoutingPolicy `mandatory:"false" json:"routingPolicies"`
}
func (m LoadBalancer) 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 LoadBalancer) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingLoadBalancerLifecycleStateEnum(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(GetLoadBalancerLifecycleStateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// LoadBalancerLifecycleStateEnum Enum with underlying type: string
type LoadBalancerLifecycleStateEnum string
// Set of constants representing the allowable values for LoadBalancerLifecycleStateEnum
const (
LoadBalancerLifecycleStateCreating LoadBalancerLifecycleStateEnum = "CREATING"
LoadBalancerLifecycleStateFailed LoadBalancerLifecycleStateEnum = "FAILED"
LoadBalancerLifecycleStateActive LoadBalancerLifecycleStateEnum = "ACTIVE"
LoadBalancerLifecycleStateDeleting LoadBalancerLifecycleStateEnum = "DELETING"
LoadBalancerLifecycleStateDeleted LoadBalancerLifecycleStateEnum = "DELETED"
)
var mappingLoadBalancerLifecycleStateEnum = map[string]LoadBalancerLifecycleStateEnum{
"CREATING": LoadBalancerLifecycleStateCreating,
"FAILED": LoadBalancerLifecycleStateFailed,
"ACTIVE": LoadBalancerLifecycleStateActive,
"DELETING": LoadBalancerLifecycleStateDeleting,
"DELETED": LoadBalancerLifecycleStateDeleted,
}
var mappingLoadBalancerLifecycleStateEnumLowerCase = map[string]LoadBalancerLifecycleStateEnum{
"creating": LoadBalancerLifecycleStateCreating,
"failed": LoadBalancerLifecycleStateFailed,
"active": LoadBalancerLifecycleStateActive,
"deleting": LoadBalancerLifecycleStateDeleting,
"deleted": LoadBalancerLifecycleStateDeleted,
}
// GetLoadBalancerLifecycleStateEnumValues Enumerates the set of values for LoadBalancerLifecycleStateEnum
func GetLoadBalancerLifecycleStateEnumValues() []LoadBalancerLifecycleStateEnum {
values := make([]LoadBalancerLifecycleStateEnum, 0)
for _, v := range mappingLoadBalancerLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetLoadBalancerLifecycleStateEnumStringValues Enumerates the set of values in String for LoadBalancerLifecycleStateEnum
func GetLoadBalancerLifecycleStateEnumStringValues() []string {
return []string{
"CREATING",
"FAILED",
"ACTIVE",
"DELETING",
"DELETED",
}
}
// GetMappingLoadBalancerLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingLoadBalancerLifecycleStateEnum(val string) (LoadBalancerLifecycleStateEnum, bool) {
enum, ok := mappingLoadBalancerLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}