Debian Codegraph @

docs/dyn/cloudbilling_v1beta.projects.anomalies.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="cloudbilling_v1beta.html">Cloud Billing API</a> . <a href="cloudbilling_v1beta.projects.html">projects</a> . <a href="cloudbilling_v1beta.projects.anomalies.html">anomalies</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82 <p class="firstline">Gets an anomaly for a billing account or a project.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Lists anomalies for a billing account or a project.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(name, x__xgafv=None)</code>
97 <pre>Gets an anomaly for a billing account or a project.
98
99 Args:
100 name: string, Required. Format for project: projects/{project}/anomalies/{anomalies}. Format for billing account: billingAccounts/{billing_account}/anomalies/{anomalies}. (required)
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106 Returns:
107 An object of the form:
108
109 { # Encapsulates an anomaly.
110 &quot;detectionTime&quot;: &quot;A String&quot;, # Time that the anomaly was detected. Will be set to 00:00 google time of the detected date.
111 &quot;deviation&quot;: { # Encapsulates the deviation information. # Deviation information of the anomaly.
112 &quot;actualSpend&quot;: { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
113 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
114 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
115 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
116 },
117 &quot;deviationAmount&quot;: { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend&#x27;s upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
118 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
119 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
120 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
121 },
122 &quot;deviationPercentage&quot;: 3.14, # The percentage of devition amount from expected spend&#x27;s upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
123 &quot;expectedSpend&quot;: { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
124 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
125 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
126 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
127 },
128 },
129 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name for the anomaly.
130 &quot;resourceDisplayName&quot;: &quot;A String&quot;, # The display name of the resource that the anomaly occurred in/belongs to.
131 &quot;rootCauses&quot;: [ # A list of causes which contribute to the anomaly.
132 { # Encapsulates the information of the reason which caused the anomaly.
133 &quot;causeType&quot;: &quot;A String&quot;, # The cause type.
134 &quot;deviation&quot;: { # Encapsulates the deviation information. # The deviation information for the cause.
135 &quot;actualSpend&quot;: { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
136 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
137 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
138 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
139 },
140 &quot;deviationAmount&quot;: { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend&#x27;s upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
141 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
142 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
143 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
144 },
145 &quot;deviationPercentage&quot;: 3.14, # The percentage of devition amount from expected spend&#x27;s upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
146 &quot;expectedSpend&quot;: { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
147 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
148 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
149 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
150 },
151 },
152 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the cause.
153 &quot;resource&quot;: &quot;A String&quot;, # The resource name of the cause. project: projects/{project}. service: services/{service}. sku: services/{service}/skus/{sku}.
154 &quot;subCauses&quot;: [ # The sub causes.
155 # Object with schema name: GoogleCloudBillingAnomaliesV1betaCause
156 ],
157 },
158 ],
159 &quot;scope&quot;: &quot;A String&quot;, # Indicate the scope of the anomaly.
160 &quot;severity&quot;: &quot;A String&quot;, # Severity of the anomaly. Unspecified if severity is not met/assigned.
161 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent anomaly&#x27;s last updated time.
162 }</pre>
163 </div>
164
165 <div class="method">
166 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
167 <pre>Lists anomalies for a billing account or a project.
168
169 Args:
170 parent: string, Required. The project to list Anomaly for the project. Format for project: projects/{project}. Format for billing account: billingAccounts/{billing_account}. (required)
171 filter: string, Optional. Options for how to filter the anomalies. Currently, only filter on `start_time` and `end_time` is supported. Only =, AND operators are supported. If start_time and/or end_time empty, we only retrieve the most recent 30 days&#x27; anomalies. Examples: - start_time = &quot;20231201&quot; AND end_time = &quot;20240120&quot; .
172 pageSize: integer, Optional. Maximum number of anomalies to return. Results may return fewer than this value. Default value is 50 and maximum value is 1000.
173 pageToken: string, Optional. Page token received from a previous ListAnomalies call to retrieve the next page of results. If this field is empty, the first page is returned.
174 x__xgafv: string, V1 error format.
175 Allowed values
176 1 - v1 error format
177 2 - v2 error format
178
179 Returns:
180 An object of the form:
181
182 { # Response message for ListAnomalies.
183 &quot;anomalies&quot;: [ # The returned anomalies.
184 { # Encapsulates an anomaly.
185 &quot;detectionTime&quot;: &quot;A String&quot;, # Time that the anomaly was detected. Will be set to 00:00 google time of the detected date.
186 &quot;deviation&quot;: { # Encapsulates the deviation information. # Deviation information of the anomaly.
187 &quot;actualSpend&quot;: { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
188 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
189 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
190 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
191 },
192 &quot;deviationAmount&quot;: { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend&#x27;s upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
193 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
194 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
195 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
196 },
197 &quot;deviationPercentage&quot;: 3.14, # The percentage of devition amount from expected spend&#x27;s upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
198 &quot;expectedSpend&quot;: { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
199 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
200 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
201 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
202 },
203 },
204 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name for the anomaly.
205 &quot;resourceDisplayName&quot;: &quot;A String&quot;, # The display name of the resource that the anomaly occurred in/belongs to.
206 &quot;rootCauses&quot;: [ # A list of causes which contribute to the anomaly.
207 { # Encapsulates the information of the reason which caused the anomaly.
208 &quot;causeType&quot;: &quot;A String&quot;, # The cause type.
209 &quot;deviation&quot;: { # Encapsulates the deviation information. # The deviation information for the cause.
210 &quot;actualSpend&quot;: { # Represents an amount of money with its currency type. # The actual spend for the anomaly.
211 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
212 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
213 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
214 },
215 &quot;deviationAmount&quot;: { # Represents an amount of money with its currency type. # The difference between the actual spend and expected spend&#x27;s upper bound. Calculation formula: deviation_amount = actual_spend - expected_spend.
216 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
217 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
218 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
219 },
220 &quot;deviationPercentage&quot;: 3.14, # The percentage of devition amount from expected spend&#x27;s upper bound. Calculation formula: deviation_percentage = divation_amount / expected_spend * 100.
221 &quot;expectedSpend&quot;: { # Represents an amount of money with its currency type. # The expected spend for the anomaly.
222 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
223 &quot;nanos&quot;: 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
224 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
225 },
226 },
227 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the cause.
228 &quot;resource&quot;: &quot;A String&quot;, # The resource name of the cause. project: projects/{project}. service: services/{service}. sku: services/{service}/skus/{sku}.
229 &quot;subCauses&quot;: [ # The sub causes.
230 # Object with schema name: GoogleCloudBillingAnomaliesV1betaCause
231 ],
232 },
233 ],
234 &quot;scope&quot;: &quot;A String&quot;, # Indicate the scope of the anomaly.
235 &quot;severity&quot;: &quot;A String&quot;, # Severity of the anomaly. Unspecified if severity is not met/assigned.
236 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent anomaly&#x27;s last updated time.
237 },
238 ],
239 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token that can be sent as `page_token` in the subsequent request to retrieve the next page. If this field is empty, there are no subsequent pages.
240 }</pre>
241 </div>
242
243 <div class="method">
244 <code class="details" id="list_next">list_next()</code>
245 <pre>Retrieves the next page of results.
246
247 Args:
248 previous_request: The request for the previous page. (required)
249 previous_response: The response from the request for the previous page. (required)
250
251 Returns:
252 A request object that you can call &#x27;execute()&#x27; on to request the next
253 page. Returns None if there are no more items in the collection.
254 </pre>
255 </div>
256
257 </body></html>