Debian Codegraph @

docs/dyn/drive_v2.properties.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="drive_v2.html">Google 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="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(fileId, propertyKey, visibility=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes a property.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(fileId, propertyKey, visibility=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets a property by its key.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(fileId, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Adds a property to a file, or updates it if it already exists.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(fileId, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists a file's properties.</p>
92 <p class="toc_element">
93 <code><a href="#patch">patch(fileId, propertyKey, body=None, visibility=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Updates a property.</p>
95 <p class="toc_element">
96 <code><a href="#update">update(fileId, propertyKey, body=None, visibility=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates a property.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="delete">delete(fileId, propertyKey, visibility=None, x__xgafv=None)</code>
106 <pre>Deletes a property.
107
108 Args:
109 fileId: string, The ID of the file. (required)
110 propertyKey: string, The key of the property. (required)
111 visibility: string, The visibility of the property.
112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
116 </pre>
117 </div>
118
119 <div class="method">
120 <code class="details" id="get">get(fileId, propertyKey, visibility=None, x__xgafv=None)</code>
121 <pre>Gets a property by its key.
122
123 Args:
124 fileId: string, The ID of the file. (required)
125 propertyKey: string, The key of the property. (required)
126 visibility: string, The visibility of the property.
127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132 Returns:
133 An object of the form:
134
135 { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
136 &quot;etag&quot;: &quot;A String&quot;, # Output only. ETag of the property.
137 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
138 &quot;kind&quot;: &quot;drive#property&quot;, # Output only. This is always `drive#property`.
139 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The link back to this property.
140 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
141 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
142 }</pre>
143 </div>
144
145 <div class="method">
146 <code class="details" id="insert">insert(fileId, body=None, x__xgafv=None)</code>
147 <pre>Adds a property to a file, or updates it if it already exists.
148
149 Args:
150 fileId: string, The ID of the file. (required)
151 body: object, The request body.
152 The object takes the form of:
153
154 { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
155 &quot;etag&quot;: &quot;A String&quot;, # Output only. ETag of the property.
156 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
157 &quot;kind&quot;: &quot;drive#property&quot;, # Output only. This is always `drive#property`.
158 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The link back to this property.
159 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
160 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
161 }
162
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168 Returns:
169 An object of the form:
170
171 { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
172 &quot;etag&quot;: &quot;A String&quot;, # Output only. ETag of the property.
173 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
174 &quot;kind&quot;: &quot;drive#property&quot;, # Output only. This is always `drive#property`.
175 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The link back to this property.
176 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
177 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
178 }</pre>
179 </div>
180
181 <div class="method">
182 <code class="details" id="list">list(fileId, x__xgafv=None)</code>
183 <pre>Lists a file&#x27;s properties.
184
185 Args:
186 fileId: string, The ID of the file. (required)
187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
191
192 Returns:
193 An object of the form:
194
195 { # A collection of properties, key-value pairs that are either public or private to an application.
196 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the list.
197 &quot;items&quot;: [ # The list of properties.
198 { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
199 &quot;etag&quot;: &quot;A String&quot;, # Output only. ETag of the property.
200 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
201 &quot;kind&quot;: &quot;drive#property&quot;, # Output only. This is always `drive#property`.
202 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The link back to this property.
203 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
204 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
205 },
206 ],
207 &quot;kind&quot;: &quot;drive#propertyList&quot;, # This is always `drive#propertyList`.
208 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this list.
209 }</pre>
210 </div>
211
212 <div class="method">
213 <code class="details" id="patch">patch(fileId, propertyKey, body=None, visibility=None, x__xgafv=None)</code>
214 <pre>Updates a property.
215
216 Args:
217 fileId: string, The ID of the file. (required)
218 propertyKey: string, The key of the property. (required)
219 body: object, The request body.
220 The object takes the form of:
221
222 { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
223 &quot;etag&quot;: &quot;A String&quot;, # Output only. ETag of the property.
224 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
225 &quot;kind&quot;: &quot;drive#property&quot;, # Output only. This is always `drive#property`.
226 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The link back to this property.
227 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
228 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
229 }
230
231 visibility: string, The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
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 { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
241 &quot;etag&quot;: &quot;A String&quot;, # Output only. ETag of the property.
242 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
243 &quot;kind&quot;: &quot;drive#property&quot;, # Output only. This is always `drive#property`.
244 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The link back to this property.
245 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
246 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
247 }</pre>
248 </div>
249
250 <div class="method">
251 <code class="details" id="update">update(fileId, propertyKey, body=None, visibility=None, x__xgafv=None)</code>
252 <pre>Updates a property.
253
254 Args:
255 fileId: string, The ID of the file. (required)
256 propertyKey: string, The key of the property. (required)
257 body: object, The request body.
258 The object takes the form of:
259
260 { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
261 &quot;etag&quot;: &quot;A String&quot;, # Output only. ETag of the property.
262 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
263 &quot;kind&quot;: &quot;drive#property&quot;, # Output only. This is always `drive#property`.
264 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The link back to this property.
265 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
266 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
267 }
268
269 visibility: string, The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
270 x__xgafv: string, V1 error format.
271 Allowed values
272 1 - v1 error format
273 2 - v2 error format
274
275 Returns:
276 An object of the form:
277
278 { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
279 &quot;etag&quot;: &quot;A String&quot;, # Output only. ETag of the property.
280 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
281 &quot;kind&quot;: &quot;drive#property&quot;, # Output only. This is always `drive#property`.
282 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The link back to this property.
283 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
284 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
285 }</pre>
286 </div>
287
288 </body></html>