Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / proximitybeacon_v1beta1.beacons.diagnostics.html
blob: f8863395d4c242c3355b51d7534ae22d51d3cde4 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="proximitybeacon_v1beta1.html">Google Proximity Beacon API</a> . <a href="proximitybeacon_v1beta1.beacons.html">beacons</a> . <a href="proximitybeacon_v1beta1.beacons.diagnostics.html">diagnostics</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]78 <code><a href="#list">list(beaconName, pageSize=None, projectId=None, alertFilter=None, pageToken=None, x__xgafv=None)</a></code></p>
79<p class="firstline">List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon name `beacons/-`. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]85 <code class="details" id="list">list(beaconName, pageSize=None, projectId=None, alertFilter=None, pageToken=None, x__xgafv=None)</code>
86 <pre>List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon name `beacons/-`. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]87
88Args:
89 beaconName: string, Beacon that the diagnostics are for. (required)
90 pageSize: integer, Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]91 projectId: string, Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up diagnostic records. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]92 alertFilter: string, Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`.
93 pageToken: string, Requests results that occur after the `page_token`, obtained from the response to a previous request. Optional.
94 x__xgafv: string, V1 error format.
95
96Returns:
97 An object of the form:
98
99 { # Response that contains the requested diagnostics.
100 "nextPageToken": "A String", # Token that can be used for pagination. Returned only if the request matches more beacons than can be returned in this response.
101 "diagnostics": [ # The diagnostics matching the given request.
102 { # Diagnostics for a single beacon.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]103 "estimatedLowBatteryDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date when the battery is expected to be low. If the value is missing then there is no estimate for when the battery will be low. This value is only an estimate, not an exact date.
104 "month": 42, # Month of year. Must be from 1 to 12.
105 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
106 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]107 },
108 "alerts": [ # An unordered list of Alerts that the beacon has.
109 "A String",
110 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]111 "beaconName": "A String", # Resource name of the beacon. For Eddystone-EID beacons, this may be the beacon's current EID, or the beacon's "stable" Eddystone-UID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]112 },
113 ],
114 }</pre>
115</div>
116
117<div class="method">
118 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
119 <pre>Retrieves the next page of results.
120
121Args:
122 previous_request: The request for the previous page. (required)
123 previous_response: The response from the request for the previous page. (required)
124
125Returns:
126 A request object that you can call 'execute()' on to request the next
127 page. Returns None if there are no more items in the collection.
128 </pre>
129</div>
130
131</body></html>