Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / proximitybeacon_v1beta1.beacons.diagnostics.html
blob: 474ebda5fb6ba1a0ff8592d2e0dd48a2b7f7bc21 [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>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">List the diagnostics for a single beacon. You can also list diagnostics for</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>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]86 <pre>List the diagnostics for a single beacon. You can also list diagnostics for
87all the beacons owned by your Google Developers Console project by using
88the beacon name `beacons/-`.
89
90Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)
91from a signed-in user with **viewer**, **Is owner** or **Can edit**
92permissions in the Google Developers Console project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]93
94Args:
95 beaconName: string, Beacon that the diagnostics are for. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]96 pageSize: integer, Specifies the maximum number of results to return. Defaults to
9710. Maximum 1000. Optional.
98 projectId: string, Requests only diagnostic records for the given project id. If not set,
99then the project making the request will be used for looking up
100diagnostic records. Optional.
101 alertFilter: string, Requests only beacons that have the given alert. For example, to find
102beacons that have low batteries use `alert_filter=LOW_BATTERY`.
103 pageToken: string, Requests results that occur after the `page_token`, obtained from the
104response to a previous request. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]105 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]109
110Returns:
111 An object of the form:
112
113 { # Response that contains the requested diagnostics.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]114 "nextPageToken": "A String", # Token that can be used for pagination. Returned only if the
115 # request matches more beacons than can be returned in this response.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]116 "diagnostics": [ # The diagnostics matching the given request.
117 { # Diagnostics for a single beacon.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]118 "estimatedLowBatteryDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and # The date when the battery is expected to be low. If the value is missing
119 # then there is no estimate for when the battery will be low.
120 # This value is only an estimate, not an exact date.
121 # time zone are either specified elsewhere or are not significant. The date
122 # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
123 # represent a year and month where the day is not significant, e.g. credit card
124 # expiration date. The year may be 0 to represent a month and day independent
125 # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
126 # and `google.protobuf.Timestamp`.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]127 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
128 # a year.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]129 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
130 # if specifying a year/month where the day is not significant.
131 "month": 42, # Month of year. Must be from 1 to 12.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]132 },
133 "alerts": [ # An unordered list of Alerts that the beacon has.
134 "A String",
135 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]136 "beaconName": "A String", # Resource name of the beacon. For Eddystone-EID beacons, this may
137 # be the beacon's current EID, or the beacon's "stable" Eddystone-UID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]138 },
139 ],
140 }</pre>
141</div>
142
143<div class="method">
144 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
145 <pre>Retrieves the next page of results.
146
147Args:
148 previous_request: The request for the previous page. (required)
149 previous_response: The response from the request for the previous page. (required)
150
151Returns:
152 A request object that you can call 'execute()' on to request the next
153 page. Returns None if there are no more items in the collection.
154 </pre>
155</div>
156
157</body></html>