Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / proximitybeacon_v1beta1.beacons.attachments.html
blob: 68146e7472ee93d099263c0a7a79e48fbb93393d [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.attachments.html">attachments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]78 <code><a href="#batchDelete">batchDelete(beaconName, namespacedType=None, projectId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Deletes multiple attachments on a given beacon. This operation is</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]80<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]81 <code><a href="#create">create(beaconName, body, projectId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">Associates the given data with the specified beacon. Attachment data must</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#delete">delete(attachmentName, projectId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]85<p class="firstline">Deletes the specified attachment for the given beacon. Each attachment has</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]86<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]87 <code><a href="#list">list(beaconName, namespacedType=None, projectId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88<p class="firstline">Returns the attachments for the specified beacon that match the specified</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]91 <code class="details" id="batchDelete">batchDelete(beaconName, namespacedType=None, projectId=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]92 <pre>Deletes multiple attachments on a given beacon. This operation is
93permanent and cannot be undone.
94
95You can optionally specify `namespacedType` to choose which attachments
96should be deleted. If you do not specify `namespacedType`, all your
97attachments on the given beacon will be deleted. You also may explicitly
98specify `*/*` to delete all.
99
100Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)
101from a signed-in user with **Is owner** or **Can edit** permissions in the
102Google Developers Console project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]103
104Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]105 beaconName: string, The beacon whose attachments should be deleted. A beacon name has the
106format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast
107by the beacon and N is a code for the beacon's type. Possible values are
108`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`
109for AltBeacon. For Eddystone-EID beacons, you may use either the
110current EID or the beacon's "stable" UID.
111Required. (required)
112 namespacedType: string, Specifies the namespace and type of attachments to delete in
113`namespace/type` format. Accepts `*/*` to specify
114"all types in all namespaces".
115Optional.
116 projectId: string, The project id to delete beacon attachments under. This field can be
117used when "*" is specified to mean all attachment namespaces. Projects
118may have multiple attachments with multiple namespaces. If "*" is
119specified and the projectId string is empty, then the project
120making the request is used.
121Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]122 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]126
127Returns:
128 An object of the form:
129
130 { # Response for a request to delete attachments.
131 "numDeleted": 42, # The number of attachments that were deleted.
132 }</pre>
133</div>
134
135<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]136 <code class="details" id="create">create(beaconName, body, projectId=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]137 <pre>Associates the given data with the specified beacon. Attachment data must
138contain two parts:
139<ul>
140<li>A namespaced type.</li>
141<li>The actual attachment data itself.</li>
142</ul>
143The namespaced type consists of two parts, the namespace and the type.
144The namespace must be one of the values returned by the `namespaces`
145endpoint, while the type can be a string of any characters except for the
146forward slash (`/`) up to 100 characters in length.
147
148Attachment data can be up to 1024 bytes long.
149
150Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)
151from a signed-in user with **Is owner** or **Can edit** permissions in the
152Google Developers Console project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]153
154Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]155 beaconName: string, Beacon on which the attachment should be created. A beacon name has the
156format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast
157by the beacon and N is a code for the beacon's type. Possible values are
158`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`
159for AltBeacon. For Eddystone-EID beacons, you may use either the
160current EID or the beacon's "stable" UID.
161Required. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]162 body: object, The request body. (required)
163 The object takes the form of:
164
165{ # Project-specific data associated with a beacon.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]166 "data": "A String", # An opaque data container for client-provided data. Must be
167 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP
168 # requests, and will be so encoded (with padding) in responses.
169 # Required.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]170 "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
171 # UNIX epoch.
172 "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
173 # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
174 # Leave this empty on creation.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]175 "namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to
176 # interpret the `data` field. Format is <var>namespace/type</var>. Namespace
177 # provides type separation between clients. Type describes the type of
178 # `data`, for use by the client when parsing the `data` field.
179 # Required.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]180 }
181
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]182 projectId: string, The project id of the project the attachment will belong to. If
183the project id is not specified then the project making the request
184is used.
185Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]186 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]190
191Returns:
192 An object of the form:
193
194 { # Project-specific data associated with a beacon.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]195 "data": "A String", # An opaque data container for client-provided data. Must be
196 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP
197 # requests, and will be so encoded (with padding) in responses.
198 # Required.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]199 "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
200 # UNIX epoch.
201 "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
202 # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
203 # Leave this empty on creation.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]204 "namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to
205 # interpret the `data` field. Format is <var>namespace/type</var>. Namespace
206 # provides type separation between clients. Type describes the type of
207 # `data`, for use by the client when parsing the `data` field.
208 # Required.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]209 }</pre>
210</div>
211
212<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]213 <code class="details" id="delete">delete(attachmentName, projectId=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]214 <pre>Deletes the specified attachment for the given beacon. Each attachment has
215a unique attachment name (`attachmentName`) which is returned when you
216fetch the attachment data via this API. You specify this with the delete
217request to control which attachment is removed. This operation cannot be
218undone.
219
220Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)
221from a signed-in user with **Is owner** or **Can edit** permissions in the
222Google Developers Console project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]223
224Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]225 attachmentName: string, The attachment name (`attachmentName`) of
226the attachment to remove. For example:
227`beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For
228Eddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the
229beacon's current EID, or its "stable" Eddystone-UID.
230Required. (required)
231 projectId: string, The project id of the attachment to delete. If not provided, the project
232that is making the request is used.
233Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]234 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]235 Allowed values
236 1 - v1 error format
237 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]238
239Returns:
240 An object of the form:
241
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]242 { # A generic empty message that you can re-use to avoid defining duplicated
243 # empty messages in your APIs. A typical example is to use it as the request
244 # or the response type of an API method. For instance:
245 #
246 # service Foo {
247 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
248 # }
249 #
250 # The JSON representation for `Empty` is empty JSON object `{}`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]251 }</pre>
252</div>
253
254<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]255 <code class="details" id="list">list(beaconName, namespacedType=None, projectId=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]256 <pre>Returns the attachments for the specified beacon that match the specified
257namespaced-type pattern.
258
259To control which namespaced types are returned, you add the
260`namespacedType` query parameter to the request. You must either use
261`*/*`, to return all attachments, or the namespace must be one of
262the ones returned from the `namespaces` endpoint.
263
264Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)
265from a signed-in user with **viewer**, **Is owner** or **Can edit**
266permissions in the Google Developers Console project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]267
268Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]269 beaconName: string, Beacon whose attachments should be fetched. A beacon name has the
270format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast
271by the beacon and N is a code for the beacon's type. Possible values are
272`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`
273for AltBeacon. For Eddystone-EID beacons, you may use either the
274current EID or the beacon's "stable" UID.
275Required. (required)
276 namespacedType: string, Specifies the namespace and type of attachment to include in response in
277<var>namespace/type</var> format. Accepts `*/*` to specify
278"all types in all namespaces".
279 projectId: string, The project id to list beacon attachments under. This field can be
280used when "*" is specified to mean all attachment namespaces. Projects
281may have multiple attachments with multiple namespaces. If "*" is
282specified and the projectId string is empty, then the project
283making the request is used.
284Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]285 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]286 Allowed values
287 1 - v1 error format
288 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]289
290Returns:
291 An object of the form:
292
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]293 { # Response to `ListBeaconAttachments` that contains the requested attachments.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]294 "attachments": [ # The attachments that corresponded to the request params.
295 { # Project-specific data associated with a beacon.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]296 "data": "A String", # An opaque data container for client-provided data. Must be
297 # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP
298 # requests, and will be so encoded (with padding) in responses.
299 # Required.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]300 "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
301 # UNIX epoch.
302 "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
303 # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
304 # Leave this empty on creation.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]305 "namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to
306 # interpret the `data` field. Format is <var>namespace/type</var>. Namespace
307 # provides type separation between clients. Type describes the type of
308 # `data`, for use by the client when parsing the `data` field.
309 # Required.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]310 },
311 ],
312 }</pre>
313</div>
314
315</body></html>