/
query_properties.go
205 lines (168 loc) · 8.32 KB
/
query_properties.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
// 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.
// Usage API
//
// Use the Usage API to view your Oracle Cloud usage and costs. The API allows you to request data that meets the specified filter criteria, and to group that data by the chosen dimension. The Usage API is used by the Cost Analysis and Carbon Emissions Analysis tools in the Console. See Cost Analysis Overview (https://docs.cloud.oracle.com/Content/Billing/Concepts/costanalysisoverview.htm) and Using the Usage API (https://docs.cloud.oracle.com/Content/Billing/Concepts/costanalysisoverview.htm#cost_analysis_using_the_api) for more information.
//
package usageapi
import (
"encoding/json"
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// QueryProperties The query properties.
type QueryProperties struct {
// The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation.
// Allowed values are:
// DAILY
// MONTHLY
Granularity QueryPropertiesGranularityEnum `mandatory:"true" json:"granularity"`
DateRange DateRange `mandatory:"true" json:"dateRange"`
// Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
GroupBy []string `mandatory:"false" json:"groupBy"`
// GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [ { "namespace": "oracle", "key": "createdBy" ]
GroupByTag []Tag `mandatory:"false" json:"groupByTag"`
Filter *Filter `mandatory:"false" json:"filter"`
// The depth level of the compartment.
CompartmentDepth *float32 `mandatory:"false" json:"compartmentDepth"`
// The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data.
// Allowed values are:
// USAGE
// COST
// USAGE_AND_COST
QueryType QueryPropertiesQueryTypeEnum `mandatory:"false" json:"queryType,omitempty"`
// Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up.
IsAggregateByTime *bool `mandatory:"false" json:"isAggregateByTime"`
}
func (m QueryProperties) 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 QueryProperties) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingQueryPropertiesGranularityEnum(string(m.Granularity)); !ok && m.Granularity != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Granularity: %s. Supported values are: %s.", m.Granularity, strings.Join(GetQueryPropertiesGranularityEnumStringValues(), ",")))
}
if _, ok := GetMappingQueryPropertiesQueryTypeEnum(string(m.QueryType)); !ok && m.QueryType != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for QueryType: %s. Supported values are: %s.", m.QueryType, strings.Join(GetQueryPropertiesQueryTypeEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// UnmarshalJSON unmarshals from json
func (m *QueryProperties) UnmarshalJSON(data []byte) (e error) {
model := struct {
GroupBy []string `json:"groupBy"`
GroupByTag []Tag `json:"groupByTag"`
Filter *Filter `json:"filter"`
CompartmentDepth *float32 `json:"compartmentDepth"`
QueryType QueryPropertiesQueryTypeEnum `json:"queryType"`
IsAggregateByTime *bool `json:"isAggregateByTime"`
Granularity QueryPropertiesGranularityEnum `json:"granularity"`
DateRange daterange `json:"dateRange"`
}{}
e = json.Unmarshal(data, &model)
if e != nil {
return
}
var nn interface{}
m.GroupBy = make([]string, len(model.GroupBy))
copy(m.GroupBy, model.GroupBy)
m.GroupByTag = make([]Tag, len(model.GroupByTag))
copy(m.GroupByTag, model.GroupByTag)
m.Filter = model.Filter
m.CompartmentDepth = model.CompartmentDepth
m.QueryType = model.QueryType
m.IsAggregateByTime = model.IsAggregateByTime
m.Granularity = model.Granularity
nn, e = model.DateRange.UnmarshalPolymorphicJSON(model.DateRange.JsonData)
if e != nil {
return
}
if nn != nil {
m.DateRange = nn.(DateRange)
} else {
m.DateRange = nil
}
return
}
// QueryPropertiesGranularityEnum Enum with underlying type: string
type QueryPropertiesGranularityEnum string
// Set of constants representing the allowable values for QueryPropertiesGranularityEnum
const (
QueryPropertiesGranularityDaily QueryPropertiesGranularityEnum = "DAILY"
QueryPropertiesGranularityMonthly QueryPropertiesGranularityEnum = "MONTHLY"
)
var mappingQueryPropertiesGranularityEnum = map[string]QueryPropertiesGranularityEnum{
"DAILY": QueryPropertiesGranularityDaily,
"MONTHLY": QueryPropertiesGranularityMonthly,
}
var mappingQueryPropertiesGranularityEnumLowerCase = map[string]QueryPropertiesGranularityEnum{
"daily": QueryPropertiesGranularityDaily,
"monthly": QueryPropertiesGranularityMonthly,
}
// GetQueryPropertiesGranularityEnumValues Enumerates the set of values for QueryPropertiesGranularityEnum
func GetQueryPropertiesGranularityEnumValues() []QueryPropertiesGranularityEnum {
values := make([]QueryPropertiesGranularityEnum, 0)
for _, v := range mappingQueryPropertiesGranularityEnum {
values = append(values, v)
}
return values
}
// GetQueryPropertiesGranularityEnumStringValues Enumerates the set of values in String for QueryPropertiesGranularityEnum
func GetQueryPropertiesGranularityEnumStringValues() []string {
return []string{
"DAILY",
"MONTHLY",
}
}
// GetMappingQueryPropertiesGranularityEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingQueryPropertiesGranularityEnum(val string) (QueryPropertiesGranularityEnum, bool) {
enum, ok := mappingQueryPropertiesGranularityEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// QueryPropertiesQueryTypeEnum Enum with underlying type: string
type QueryPropertiesQueryTypeEnum string
// Set of constants representing the allowable values for QueryPropertiesQueryTypeEnum
const (
QueryPropertiesQueryTypeUsage QueryPropertiesQueryTypeEnum = "USAGE"
QueryPropertiesQueryTypeCost QueryPropertiesQueryTypeEnum = "COST"
QueryPropertiesQueryTypeUsageAndCost QueryPropertiesQueryTypeEnum = "USAGE_AND_COST"
)
var mappingQueryPropertiesQueryTypeEnum = map[string]QueryPropertiesQueryTypeEnum{
"USAGE": QueryPropertiesQueryTypeUsage,
"COST": QueryPropertiesQueryTypeCost,
"USAGE_AND_COST": QueryPropertiesQueryTypeUsageAndCost,
}
var mappingQueryPropertiesQueryTypeEnumLowerCase = map[string]QueryPropertiesQueryTypeEnum{
"usage": QueryPropertiesQueryTypeUsage,
"cost": QueryPropertiesQueryTypeCost,
"usage_and_cost": QueryPropertiesQueryTypeUsageAndCost,
}
// GetQueryPropertiesQueryTypeEnumValues Enumerates the set of values for QueryPropertiesQueryTypeEnum
func GetQueryPropertiesQueryTypeEnumValues() []QueryPropertiesQueryTypeEnum {
values := make([]QueryPropertiesQueryTypeEnum, 0)
for _, v := range mappingQueryPropertiesQueryTypeEnum {
values = append(values, v)
}
return values
}
// GetQueryPropertiesQueryTypeEnumStringValues Enumerates the set of values in String for QueryPropertiesQueryTypeEnum
func GetQueryPropertiesQueryTypeEnumStringValues() []string {
return []string{
"USAGE",
"COST",
"USAGE_AND_COST",
}
}
// GetMappingQueryPropertiesQueryTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingQueryPropertiesQueryTypeEnum(val string) (QueryPropertiesQueryTypeEnum, bool) {
enum, ok := mappingQueryPropertiesQueryTypeEnumLowerCase[strings.ToLower(val)]
return enum, ok
}