-
Notifications
You must be signed in to change notification settings - Fork 80
/
v1_dashboard.go
163 lines (130 loc) · 6.41 KB
/
v1_dashboard.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
// Copyright (c) 2016, 2018, 2023, 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.
// Dashboards API
//
// Use the Oracle Cloud Infrastructure Dashboards service API to manage dashboards in the Console.
// Dashboards provide an organized and customizable view of resources and their metrics in the Console.
// For more information, see Dashboards (https://docs.cloud.oracle.com/Content/Dashboards/home.htm).
// **Important:** Resources for the Dashboards service are created in the tenacy's home region.
// Although it is possible to create dashboard and dashboard group resources in regions other than the home region,
// you won't be able to view those resources in the Console.
// Therefore, creating resources outside of the home region is not recommended.
//
package dashboardservice
import (
"encoding/json"
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// V1Dashboard A version 1 dashboard.
// The interpretation of the `config` and `widgets` fields depends on the runtime behavior of the Oracle Cloud Infrastructure Console.
// The sum of the `config` and `widget` fields JSON text representation cannot exceed 200 KB.
type V1Dashboard struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group that the dashboard belongs to.
DashboardGroupId *string `mandatory:"true" json:"dashboardGroupId"`
// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
DisplayName *string `mandatory:"true" json:"displayName"`
// A short description of the dashboard. It can be changed. Avoid entering confidential information.
// The following special characters are not allowed: <>()=/'"&\
Description *string `mandatory:"true" json:"description"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the dashboard. A dashboard is always in the same compartment as its dashboard group.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the dashboard was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the dashboard was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" 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:"true" 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:"true" json:"definedTags"`
// The visualization building blocks of the dashboard.
Widgets []interface{} `mandatory:"true" json:"widgets"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The dashboard configuration. For example, the layout and widget placement.
Config *interface{} `mandatory:"false" json:"config"`
// The current state of the dashboard.
LifecycleState DashboardLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
//GetId returns Id
func (m V1Dashboard) GetId() *string {
return m.Id
}
//GetDashboardGroupId returns DashboardGroupId
func (m V1Dashboard) GetDashboardGroupId() *string {
return m.DashboardGroupId
}
//GetDisplayName returns DisplayName
func (m V1Dashboard) GetDisplayName() *string {
return m.DisplayName
}
//GetDescription returns Description
func (m V1Dashboard) GetDescription() *string {
return m.Description
}
//GetCompartmentId returns CompartmentId
func (m V1Dashboard) GetCompartmentId() *string {
return m.CompartmentId
}
//GetTimeCreated returns TimeCreated
func (m V1Dashboard) GetTimeCreated() *common.SDKTime {
return m.TimeCreated
}
//GetTimeUpdated returns TimeUpdated
func (m V1Dashboard) GetTimeUpdated() *common.SDKTime {
return m.TimeUpdated
}
//GetLifecycleState returns LifecycleState
func (m V1Dashboard) GetLifecycleState() DashboardLifecycleStateEnum {
return m.LifecycleState
}
//GetFreeformTags returns FreeformTags
func (m V1Dashboard) GetFreeformTags() map[string]string {
return m.FreeformTags
}
//GetDefinedTags returns DefinedTags
func (m V1Dashboard) GetDefinedTags() map[string]map[string]interface{} {
return m.DefinedTags
}
//GetSystemTags returns SystemTags
func (m V1Dashboard) GetSystemTags() map[string]map[string]interface{} {
return m.SystemTags
}
func (m V1Dashboard) 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 V1Dashboard) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingDashboardLifecycleStateEnum(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(GetDashboardLifecycleStateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// MarshalJSON marshals to json representation
func (m V1Dashboard) MarshalJSON() (buff []byte, e error) {
type MarshalTypeV1Dashboard V1Dashboard
s := struct {
DiscriminatorParam string `json:"schemaVersion"`
MarshalTypeV1Dashboard
}{
"V1",
(MarshalTypeV1Dashboard)(m),
}
return json.Marshal(&s)
}