Debian Codegraph @

docs/dyn/admin_directory_v1.resources.features.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="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.resources.html">resources</a> . <a href="admin_directory_v1.resources.features.html">features</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(customer, featureKey, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes a feature.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(customer, featureKey, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a feature.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(customer, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Inserts a feature.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(customer, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves a list of features for an account.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(customer, featureKey, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Patches a feature.</p>
98 <p class="toc_element">
99 <code><a href="#rename">rename(customer, oldName, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Renames a feature.</p>
101 <p class="toc_element">
102 <code><a href="#update">update(customer, featureKey, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Updates a feature.</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108 </div>
109
110 <div class="method">
111 <code class="details" id="delete">delete(customer, featureKey, x__xgafv=None)</code>
112 <pre>Deletes a feature.
113
114 Args:
115 customer: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s customer ID. (required)
116 featureKey: string, The unique ID of the feature to delete. (required)
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121 </pre>
122 </div>
123
124 <div class="method">
125 <code class="details" id="get">get(customer, featureKey, x__xgafv=None)</code>
126 <pre>Retrieves a feature.
127
128 Args:
129 customer: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s customer ID. (required)
130 featureKey: string, The unique ID of the feature to retrieve. (required)
131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
135
136 Returns:
137 An object of the form:
138
139 { # JSON template for Feature object in Directory API.
140 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
141 &quot;kind&quot;: &quot;admin#directory#resources#features#Feature&quot;, # Kind of resource this is.
142 &quot;name&quot;: &quot;A String&quot;, # The name of the feature.
143 }</pre>
144 </div>
145
146 <div class="method">
147 <code class="details" id="insert">insert(customer, body=None, x__xgafv=None)</code>
148 <pre>Inserts a feature.
149
150 Args:
151 customer: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s customer ID. (required)
152 body: object, The request body.
153 The object takes the form of:
154
155 { # JSON template for Feature object in Directory API.
156 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
157 &quot;kind&quot;: &quot;admin#directory#resources#features#Feature&quot;, # Kind of resource this is.
158 &quot;name&quot;: &quot;A String&quot;, # The name of the feature.
159 }
160
161 x__xgafv: string, V1 error format.
162 Allowed values
163 1 - v1 error format
164 2 - v2 error format
165
166 Returns:
167 An object of the form:
168
169 { # JSON template for Feature object in Directory API.
170 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
171 &quot;kind&quot;: &quot;admin#directory#resources#features#Feature&quot;, # Kind of resource this is.
172 &quot;name&quot;: &quot;A String&quot;, # The name of the feature.
173 }</pre>
174 </div>
175
176 <div class="method">
177 <code class="details" id="list">list(customer, maxResults=None, pageToken=None, x__xgafv=None)</code>
178 <pre>Retrieves a list of features for an account.
179
180 Args:
181 customer: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s customer ID. (required)
182 maxResults: integer, Maximum number of results to return.
183 pageToken: string, Token to specify the next page in the list.
184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
188
189 Returns:
190 An object of the form:
191
192 { # Public API: Resources.features
193 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
194 &quot;features&quot;: [ # The Features in this page of results.
195 { # JSON template for Feature object in Directory API.
196 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
197 &quot;kind&quot;: &quot;admin#directory#resources#features#Feature&quot;, # Kind of resource this is.
198 &quot;name&quot;: &quot;A String&quot;, # The name of the feature.
199 },
200 ],
201 &quot;kind&quot;: &quot;admin#directory#resources#features#featuresList&quot;, # Kind of resource this is.
202 &quot;nextPageToken&quot;: &quot;A String&quot;, # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
203 }</pre>
204 </div>
205
206 <div class="method">
207 <code class="details" id="list_next">list_next()</code>
208 <pre>Retrieves the next page of results.
209
210 Args:
211 previous_request: The request for the previous page. (required)
212 previous_response: The response from the request for the previous page. (required)
213
214 Returns:
215 A request object that you can call &#x27;execute()&#x27; on to request the next
216 page. Returns None if there are no more items in the collection.
217 </pre>
218 </div>
219
220 <div class="method">
221 <code class="details" id="patch">patch(customer, featureKey, body=None, x__xgafv=None)</code>
222 <pre>Patches a feature.
223
224 Args:
225 customer: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s customer ID. (required)
226 featureKey: string, The unique ID of the feature to update. (required)
227 body: object, The request body.
228 The object takes the form of:
229
230 { # JSON template for Feature object in Directory API.
231 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
232 &quot;kind&quot;: &quot;admin#directory#resources#features#Feature&quot;, # Kind of resource this is.
233 &quot;name&quot;: &quot;A String&quot;, # The name of the feature.
234 }
235
236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
240
241 Returns:
242 An object of the form:
243
244 { # JSON template for Feature object in Directory API.
245 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
246 &quot;kind&quot;: &quot;admin#directory#resources#features#Feature&quot;, # Kind of resource this is.
247 &quot;name&quot;: &quot;A String&quot;, # The name of the feature.
248 }</pre>
249 </div>
250
251 <div class="method">
252 <code class="details" id="rename">rename(customer, oldName, body=None, x__xgafv=None)</code>
253 <pre>Renames a feature.
254
255 Args:
256 customer: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s customer ID. (required)
257 oldName: string, The unique ID of the feature to rename. (required)
258 body: object, The request body.
259 The object takes the form of:
260
261 {
262 &quot;newName&quot;: &quot;A String&quot;, # New name of the feature.
263 }
264
265 x__xgafv: string, V1 error format.
266 Allowed values
267 1 - v1 error format
268 2 - v2 error format
269 </pre>
270 </div>
271
272 <div class="method">
273 <code class="details" id="update">update(customer, featureKey, body=None, x__xgafv=None)</code>
274 <pre>Updates a feature.
275
276 Args:
277 customer: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s customer ID. (required)
278 featureKey: string, The unique ID of the feature to update. (required)
279 body: object, The request body.
280 The object takes the form of:
281
282 { # JSON template for Feature object in Directory API.
283 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
284 &quot;kind&quot;: &quot;admin#directory#resources#features#Feature&quot;, # Kind of resource this is.
285 &quot;name&quot;: &quot;A String&quot;, # The name of the feature.
286 }
287
288 x__xgafv: string, V1 error format.
289 Allowed values
290 1 - v1 error format
291 2 - v2 error format
292
293 Returns:
294 An object of the form:
295
296 { # JSON template for Feature object in Directory API.
297 &quot;etags&quot;: &quot;A String&quot;, # ETag of the resource.
298 &quot;kind&quot;: &quot;admin#directory#resources#features#Feature&quot;, # Kind of resource this is.
299 &quot;name&quot;: &quot;A String&quot;, # The name of the feature.
300 }</pre>
301 </div>
302
303 </body></html>