Debian Codegraph @

docs/dyn/compute_alpha.reliabilityRisks.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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.reliabilityRisks.html">reliabilityRisks</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(project, reliabilityRisk, x__xgafv=None)</a></code></p>
82 <p class="firstline">Returns the specified ReliabilityRisk resource.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves the list of reliabilityRisks available in the specified 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(project, reliabilityRisk, x__xgafv=None)</code>
97 <pre>Returns the specified ReliabilityRisk resource.
98
99 Args:
100 project: string, Project ID for this request. (required)
101 reliabilityRisk: string, Name of the ReliabilityRisk resource to return. (required)
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107 Returns:
108 An object of the form:
109
110 { # Represents a ReliabilityRisk resource.
111 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
112 # text format.
113 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided when the
114 # resource is created.
115 &quot;details&quot;: { # Details about a risk. # [Output Only] Details of the reliability risk resource
116 &quot;duration&quot;: &quot;A String&quot;, # The duration of the risk since it was detected.
117 &quot;globalDnsInsight&quot;: {
118 &quot;projectDefaultIsGlobalDns&quot;: True or False, # Whether the project default DNS setting is global or not.
119 &quot;queryObservationWindow&quot;: &quot;A String&quot;, # The observation window for the query counts.
120 &quot;riskyQueryCount&quot;: &quot;A String&quot;, # The number of queries that are risky. This will always be less than
121 # total_query_count.
122 &quot;totalQueryCount&quot;: &quot;A String&quot;, # The total number of queries in the observation window.
123 },
124 &quot;lastUpdateTimestamp&quot;: &quot;A String&quot;, # The last time the risk was updated.
125 &quot;severity&quot;: &quot;A String&quot;, # The severity of the risk.
126 &quot;type&quot;: &quot;A String&quot;, # The type of risk.
127 },
128 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
129 # defined by the server.
130 &quot;kind&quot;: &quot;compute#reliabilityRisk&quot;, # Output only. [Output Only] Type of resource. Always compute#reliabilityRisk
131 # for reliability risks.
132 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. The name must be 1-63 characters long and
133 # comply withRFC1035.
134 &quot;recommendation&quot;: { # Recommendation with reference url. # The recommendations to mitigate the risk.
135 &quot;content&quot;: &quot;A String&quot;, # Mitigation guide for the risk.
136 &quot;referenceUrl&quot;: &quot;A String&quot;, # URL referencing a more detailed mitigation guide.
137 },
138 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
139 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
140 }</pre>
141 </div>
142
143 <div class="method">
144 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
145 <pre>Retrieves the list of reliabilityRisks available in the specified project.
146
147 Args:
148 project: string, Project ID for this request. (required)
149 filter: string, A filter expression that filters resources listed in the response. Most
150 Compute resources support two types of filter expressions:
151 expressions that support regular expressions and expressions that follow
152 API improvement proposal AIP-160.
153 These two types of filter expressions cannot be mixed in one request.
154
155 If you want to use AIP-160, your expression must specify the field name, an
156 operator, and the value that you want to use for filtering. The value
157 must be a string, a number, or a boolean. The operator
158 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
159
160 For example, if you are filtering Compute Engine instances, you can
161 exclude instances named `example-instance` by specifying
162 `name != example-instance`.
163
164 The `:*` comparison can be used to test whether a key has been defined.
165 For example, to find all objects with `owner` label use:
166 ```
167 labels.owner:*
168 ```
169
170 You can also filter nested fields. For example, you could specify
171 `scheduling.automaticRestart = false` to include instances only
172 if they are not scheduled for automatic restarts. You can use filtering
173 on nested fields to filter based onresource labels.
174
175 To filter on multiple expressions, provide each separate expression within
176 parentheses. For example:
177 ```
178 (scheduling.automaticRestart = true)
179 (cpuPlatform = &quot;Intel Skylake&quot;)
180 ```
181 By default, each expression is an `AND` expression. However, you
182 can include `AND` and `OR` expressions explicitly.
183 For example:
184 ```
185 (cpuPlatform = &quot;Intel Skylake&quot;) OR
186 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
187 (scheduling.automaticRestart = true)
188 ```
189
190 If you want to use a regular expression, use the `eq` (equal) or `ne`
191 (not equal) operator against a single un-parenthesized expression with or
192 without quotes or against multiple parenthesized expressions. Examples:
193
194 `fieldname eq unquoted literal`
195 `fieldname eq &#x27;single quoted literal&#x27;`
196 `fieldname eq &quot;double quoted literal&quot;`
197 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
198
199 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
200 The literal value must match the entire field.
201
202 For example, to filter for instances that do not end with name &quot;instance&quot;,
203 you would use `name ne .*instance`.
204
205 You cannot combine constraints on multiple fields using regular
206 expressions.
207 maxResults: integer, The maximum number of results per page that should be returned.
208 If the number of available results is larger than `maxResults`,
209 Compute Engine returns a `nextPageToken` that can be used to get
210 the next page of results in subsequent list requests. Acceptable values are
211 `0` to `500`, inclusive. (Default: `500`)
212 orderBy: string, Sorts list results by a certain order. By default, results
213 are returned in alphanumerical order based on the resource name.
214
215 You can also sort results in descending order based on the creation
216 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
217 results based on the `creationTimestamp` field in
218 reverse chronological order (newest result first). Use this to sort
219 resources like operations so that the newest operation is returned first.
220
221 Currently, only sorting by `name` or
222 `creationTimestamp desc` is supported.
223 pageToken: string, Specifies a page token to use. Set `pageToken` to the
224 `nextPageToken` returned by a previous list request to get
225 the next page of results.
226 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
227 of failure. The default value is false.
228
229 For example, when partial success behavior is enabled, aggregatedList for a
230 single zone scope either returns all resources in the zone or no resources,
231 with an error code.
232 x__xgafv: string, V1 error format.
233 Allowed values
234 1 - v1 error format
235 2 - v2 error format
236
237 Returns:
238 An object of the form:
239
240 {
241 &quot;etag&quot;: &quot;A String&quot;,
242 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
243 &quot;items&quot;: [ # A list of ReliabilityRisk resources.
244 { # Represents a ReliabilityRisk resource.
245 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
246 # text format.
247 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided when the
248 # resource is created.
249 &quot;details&quot;: { # Details about a risk. # [Output Only] Details of the reliability risk resource
250 &quot;duration&quot;: &quot;A String&quot;, # The duration of the risk since it was detected.
251 &quot;globalDnsInsight&quot;: {
252 &quot;projectDefaultIsGlobalDns&quot;: True or False, # Whether the project default DNS setting is global or not.
253 &quot;queryObservationWindow&quot;: &quot;A String&quot;, # The observation window for the query counts.
254 &quot;riskyQueryCount&quot;: &quot;A String&quot;, # The number of queries that are risky. This will always be less than
255 # total_query_count.
256 &quot;totalQueryCount&quot;: &quot;A String&quot;, # The total number of queries in the observation window.
257 },
258 &quot;lastUpdateTimestamp&quot;: &quot;A String&quot;, # The last time the risk was updated.
259 &quot;severity&quot;: &quot;A String&quot;, # The severity of the risk.
260 &quot;type&quot;: &quot;A String&quot;, # The type of risk.
261 },
262 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
263 # defined by the server.
264 &quot;kind&quot;: &quot;compute#reliabilityRisk&quot;, # Output only. [Output Only] Type of resource. Always compute#reliabilityRisk
265 # for reliability risks.
266 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. The name must be 1-63 characters long and
267 # comply withRFC1035.
268 &quot;recommendation&quot;: { # Recommendation with reference url. # The recommendations to mitigate the risk.
269 &quot;content&quot;: &quot;A String&quot;, # Mitigation guide for the risk.
270 &quot;referenceUrl&quot;: &quot;A String&quot;, # URL referencing a more detailed mitigation guide.
271 },
272 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
273 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
274 },
275 ],
276 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
277 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
278 # the query parameter pageToken in the next list request.
279 # Subsequent list requests will have their own nextPageToken to
280 # continue paging through the results.
281 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
282 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
283 # end_interface: MixerListResponseWithEtagBuilder
284 &quot;A String&quot;,
285 ],
286 &quot;warning&quot;: { # [Output Only] Informational warning message.
287 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
288 # Engine returns NO_RESULTS_ON_PAGE if there
289 # are no results in the response.
290 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
291 # value format. For example:
292 #
293 # &quot;data&quot;: [
294 # {
295 # &quot;key&quot;: &quot;scope&quot;,
296 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
297 # }
298 {
299 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
300 # returned. For example, for warnings where there are no results in a list
301 # request for a particular zone, this key might be scope and
302 # the key value might be the zone name. Other examples might be a key
303 # indicating a deprecated resource and a suggested replacement, or a
304 # warning about invalid network settings (for example, if an instance
305 # attempts to perform IP forwarding but is not enabled for IP forwarding).
306 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
307 },
308 ],
309 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
310 },
311 }</pre>
312 </div>
313
314 <div class="method">
315 <code class="details" id="list_next">list_next()</code>
316 <pre>Retrieves the next page of results.
317
318 Args:
319 previous_request: The request for the previous page. (required)
320 previous_response: The response from the request for the previous page. (required)
321
322 Returns:
323 A request object that you can call &#x27;execute()&#x27; on to request the next
324 page. Returns None if there are no more items in the collection.
325 </pre>
326 </div>
327
328 </body></html>