/
monitor.go
217 lines (164 loc) · 10 KB
/
monitor.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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
// 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.
// Application Performance Monitoring Synthetic Monitoring API
//
// Use the Application Performance Monitoring Synthetic Monitoring API to query synthetic scripts and monitors. For more information, see Application Performance Monitoring (https://docs.oracle.com/iaas/application-performance-monitoring/index.html).
//
package apmsynthetics
import (
"encoding/json"
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// Monitor The information about a monitor.
type Monitor struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the monitor.
Id *string `mandatory:"true" json:"id"`
// Unique name that can be edited. The name should not contain any confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Type of monitor.
MonitorType MonitorTypesEnum `mandatory:"true" json:"monitorType"`
// List of public and dedicated vantage points where the monitor is running.
VantagePoints []VantagePointInfo `mandatory:"true" json:"vantagePoints"`
// Number of vantage points where monitor is running.
VantagePointCount *int `mandatory:"true" json:"vantagePointCount"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the script.
// scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
ScriptId *string `mandatory:"true" json:"scriptId"`
// Name of the script.
ScriptName *string `mandatory:"true" json:"scriptName"`
// Enables or disables the monitor.
Status MonitorStatusEnum `mandatory:"true" json:"status"`
// Interval in seconds after the start time when the job should be repeated.
// Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
RepeatIntervalInSeconds *int `mandatory:"true" json:"repeatIntervalInSeconds"`
// If runOnce is enabled, then the monitor will run once.
IsRunOnce *bool `mandatory:"true" json:"isRunOnce"`
// Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors.
// If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors.
// Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors.
// Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
TimeoutInSeconds *int `mandatory:"true" json:"timeoutInSeconds"`
// If isRunNow is enabled, then the monitor will run immediately.
IsRunNow *bool `mandatory:"true" json:"isRunNow"`
// Scheduling policy to decide the distribution of monitor executions on vantage points.
SchedulingPolicy SchedulingPolicyEnum `mandatory:"true" json:"schedulingPolicy"`
// Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
BatchIntervalInSeconds *int `mandatory:"true" json:"batchIntervalInSeconds"`
// Specify the endpoint on which to run the monitor.
// For BROWSER, REST and NETWORK monitor types, target is mandatory.
// If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint.
// If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is.
// For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80
Target *string `mandatory:"false" json:"target"`
// List of script parameters. Example: `[{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]`
ScriptParameters []MonitorScriptParameterInfo `mandatory:"false" json:"scriptParameters"`
Configuration MonitorConfiguration `mandatory:"false" json:"configuration"`
AvailabilityConfiguration *AvailabilityConfiguration `mandatory:"false" json:"availabilityConfiguration"`
MaintenanceWindowSchedule *MaintenanceWindowSchedule `mandatory:"false" json:"maintenanceWindowSchedule"`
// The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2020-02-13T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Monitor) 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 Monitor) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingMonitorTypesEnum(string(m.MonitorType)); !ok && m.MonitorType != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for MonitorType: %s. Supported values are: %s.", m.MonitorType, strings.Join(GetMonitorTypesEnumStringValues(), ",")))
}
if _, ok := GetMappingMonitorStatusEnum(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(GetMonitorStatusEnumStringValues(), ",")))
}
if _, ok := GetMappingSchedulingPolicyEnum(string(m.SchedulingPolicy)); !ok && m.SchedulingPolicy != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for SchedulingPolicy: %s. Supported values are: %s.", m.SchedulingPolicy, strings.Join(GetSchedulingPolicyEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// UnmarshalJSON unmarshals from json
func (m *Monitor) UnmarshalJSON(data []byte) (e error) {
model := struct {
Target *string `json:"target"`
ScriptParameters []MonitorScriptParameterInfo `json:"scriptParameters"`
Configuration monitorconfiguration `json:"configuration"`
AvailabilityConfiguration *AvailabilityConfiguration `json:"availabilityConfiguration"`
MaintenanceWindowSchedule *MaintenanceWindowSchedule `json:"maintenanceWindowSchedule"`
TimeCreated *common.SDKTime `json:"timeCreated"`
TimeUpdated *common.SDKTime `json:"timeUpdated"`
FreeformTags map[string]string `json:"freeformTags"`
DefinedTags map[string]map[string]interface{} `json:"definedTags"`
Id *string `json:"id"`
DisplayName *string `json:"displayName"`
MonitorType MonitorTypesEnum `json:"monitorType"`
VantagePoints []VantagePointInfo `json:"vantagePoints"`
VantagePointCount *int `json:"vantagePointCount"`
ScriptId *string `json:"scriptId"`
ScriptName *string `json:"scriptName"`
Status MonitorStatusEnum `json:"status"`
RepeatIntervalInSeconds *int `json:"repeatIntervalInSeconds"`
IsRunOnce *bool `json:"isRunOnce"`
TimeoutInSeconds *int `json:"timeoutInSeconds"`
IsRunNow *bool `json:"isRunNow"`
SchedulingPolicy SchedulingPolicyEnum `json:"schedulingPolicy"`
BatchIntervalInSeconds *int `json:"batchIntervalInSeconds"`
}{}
e = json.Unmarshal(data, &model)
if e != nil {
return
}
var nn interface{}
m.Target = model.Target
m.ScriptParameters = make([]MonitorScriptParameterInfo, len(model.ScriptParameters))
copy(m.ScriptParameters, model.ScriptParameters)
nn, e = model.Configuration.UnmarshalPolymorphicJSON(model.Configuration.JsonData)
if e != nil {
return
}
if nn != nil {
m.Configuration = nn.(MonitorConfiguration)
} else {
m.Configuration = nil
}
m.AvailabilityConfiguration = model.AvailabilityConfiguration
m.MaintenanceWindowSchedule = model.MaintenanceWindowSchedule
m.TimeCreated = model.TimeCreated
m.TimeUpdated = model.TimeUpdated
m.FreeformTags = model.FreeformTags
m.DefinedTags = model.DefinedTags
m.Id = model.Id
m.DisplayName = model.DisplayName
m.MonitorType = model.MonitorType
m.VantagePoints = make([]VantagePointInfo, len(model.VantagePoints))
copy(m.VantagePoints, model.VantagePoints)
m.VantagePointCount = model.VantagePointCount
m.ScriptId = model.ScriptId
m.ScriptName = model.ScriptName
m.Status = model.Status
m.RepeatIntervalInSeconds = model.RepeatIntervalInSeconds
m.IsRunOnce = model.IsRunOnce
m.TimeoutInSeconds = model.TimeoutInSeconds
m.IsRunNow = model.IsRunNow
m.SchedulingPolicy = model.SchedulingPolicy
m.BatchIntervalInSeconds = model.BatchIntervalInSeconds
return
}