Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c9b6cec70b2162b98d836f8100bc039f19fe23cb / . / docs / dyn / drive_v2.properties.html
blob: a5f7e24e227741248dafc79fa39821c9c11bdd86 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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="drive_v2.html">Drive API</a> . <a href="drive_v2.properties.html">properties</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(fileId, propertyKey, visibility=None)</a></code></p>
79<p class="firstline">Deletes a property.</p>
80<p class="toc_element">
81 <code><a href="#get">get(fileId, propertyKey, visibility=None)</a></code></p>
82<p class="firstline">Gets a property by its key.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(fileId, body)</a></code></p>
85<p class="firstline">Adds a property to a file.</p>
86<p class="toc_element">
87 <code><a href="#list">list(fileId)</a></code></p>
88<p class="firstline">Lists a file's properties.</p>
89<p class="toc_element">
90 <code><a href="#patch">patch(fileId, propertyKey, body, visibility=None)</a></code></p>
91<p class="firstline">Updates a property. This method supports patch semantics.</p>
92<p class="toc_element">
93 <code><a href="#update">update(fileId, propertyKey, body, visibility=None)</a></code></p>
94<p class="firstline">Updates a property.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(fileId, propertyKey, visibility=None)</code>
98 <pre>Deletes a property.
99
100Args:
101 fileId: string, The ID of the file. (required)
102 propertyKey: string, The key of the property. (required)
103 visibility: string, The visibility of the property.
104</pre>
105</div>
106
107<div class="method">
108 <code class="details" id="get">get(fileId, propertyKey, visibility=None)</code>
109 <pre>Gets a property by its key.
110
111Args:
112 fileId: string, The ID of the file. (required)
113 propertyKey: string, The key of the property. (required)
114 visibility: string, The visibility of the property.
115
116Returns:
117 An object of the form:
118
119 { # A key-value pair that is either public or private to an application.
120 "kind": "drive#property", # This is always drive#property.
121 "value": "A String", # The value of this property.
122 "etag": "A String", # ETag of the property.
123 "visibility": "A String", # The visibility of this property.
124 "key": "A String", # The key of this property.
125 "selfLink": "A String", # The link back to this property.
126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="insert">insert(fileId, body)</code>
131 <pre>Adds a property to a file.
132
133Args:
134 fileId: string, The ID of the file. (required)
135 body: object, The request body. (required)
136 The object takes the form of:
137
138{ # A key-value pair that is either public or private to an application.
139 "kind": "drive#property", # This is always drive#property.
140 "value": "A String", # The value of this property.
141 "etag": "A String", # ETag of the property.
142 "visibility": "A String", # The visibility of this property.
143 "key": "A String", # The key of this property.
144 "selfLink": "A String", # The link back to this property.
145}
146
147
148Returns:
149 An object of the form:
150
151 { # A key-value pair that is either public or private to an application.
152 "kind": "drive#property", # This is always drive#property.
153 "value": "A String", # The value of this property.
154 "etag": "A String", # ETag of the property.
155 "visibility": "A String", # The visibility of this property.
156 "key": "A String", # The key of this property.
157 "selfLink": "A String", # The link back to this property.
158 }</pre>
159</div>
160
161<div class="method">
162 <code class="details" id="list">list(fileId)</code>
163 <pre>Lists a file's properties.
164
165Args:
166 fileId: string, The ID of the file. (required)
167
168Returns:
169 An object of the form:
170
171 { # A collection of properties, key-value pairs that are either public or private to an application.
172 "items": [ # The list of properties.
173 { # A key-value pair that is either public or private to an application.
174 "kind": "drive#property", # This is always drive#property.
175 "value": "A String", # The value of this property.
176 "etag": "A String", # ETag of the property.
177 "visibility": "A String", # The visibility of this property.
178 "key": "A String", # The key of this property.
179 "selfLink": "A String", # The link back to this property.
180 },
181 ],
182 "kind": "drive#propertyList", # This is always drive#propertyList.
183 "etag": "A String", # The ETag of the list.
184 "selfLink": "A String", # The link back to this list.
185 }</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="patch">patch(fileId, propertyKey, body, visibility=None)</code>
190 <pre>Updates a property. This method supports patch semantics.
191
192Args:
193 fileId: string, The ID of the file. (required)
194 propertyKey: string, The key of the property. (required)
195 body: object, The request body. (required)
196 The object takes the form of:
197
198{ # A key-value pair that is either public or private to an application.
199 "kind": "drive#property", # This is always drive#property.
200 "value": "A String", # The value of this property.
201 "etag": "A String", # ETag of the property.
202 "visibility": "A String", # The visibility of this property.
203 "key": "A String", # The key of this property.
204 "selfLink": "A String", # The link back to this property.
205}
206
207 visibility: string, The visibility of the property.
208
209Returns:
210 An object of the form:
211
212 { # A key-value pair that is either public or private to an application.
213 "kind": "drive#property", # This is always drive#property.
214 "value": "A String", # The value of this property.
215 "etag": "A String", # ETag of the property.
216 "visibility": "A String", # The visibility of this property.
217 "key": "A String", # The key of this property.
218 "selfLink": "A String", # The link back to this property.
219 }</pre>
220</div>
221
222<div class="method">
223 <code class="details" id="update">update(fileId, propertyKey, body, visibility=None)</code>
224 <pre>Updates a property.
225
226Args:
227 fileId: string, The ID of the file. (required)
228 propertyKey: string, The key of the property. (required)
229 body: object, The request body. (required)
230 The object takes the form of:
231
232{ # A key-value pair that is either public or private to an application.
233 "kind": "drive#property", # This is always drive#property.
234 "value": "A String", # The value of this property.
235 "etag": "A String", # ETag of the property.
236 "visibility": "A String", # The visibility of this property.
237 "key": "A String", # The key of this property.
238 "selfLink": "A String", # The link back to this property.
239}
240
241 visibility: string, The visibility of the property.
242
243Returns:
244 An object of the form:
245
246 { # A key-value pair that is either public or private to an application.
247 "kind": "drive#property", # This is always drive#property.
248 "value": "A String", # The value of this property.
249 "etag": "A String", # ETag of the property.
250 "visibility": "A String", # The visibility of this property.
251 "key": "A String", # The key of this property.
252 "selfLink": "A String", # The link back to this property.
253 }</pre>
254</div>
255
256</body></html>