1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.customers.html">customers</a> . <a href="admin_directory_v1.customers.chrome.html">chrome</a> . <a href="admin_directory_v1.customers.chrome.printServers.html">printServers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchCreatePrintServers">batchCreatePrintServers(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates multiple print servers.</p>
<p class="toc_element">
<code><a href="#batchDeletePrintServers">batchDeletePrintServers(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes multiple print servers.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a print server.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a print server.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a print server's configuration.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists print server configurations.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a print server's configuration.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchCreatePrintServers">batchCreatePrintServers(parent, body=None, x__xgafv=None)</code>
<pre>Creates multiple print servers.
Args:
parent: string, Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required)
body: object, The request body.
The object takes the form of:
{ # Request to add multiple new print servers in a batch.
"requests": [ # Required. A list of `PrintServer` resources to be created (max `50` per batch).
{ # Request for adding a new print server.
"parent": "A String", # Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}`
"printServer": { # Configuration for a print server. # Required. A print server to create. If you want to place the print server under a specific organizational unit (OU), then populate the `org_unit_id`. Otherwise the print server is created under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units).
"createTime": "A String", # Output only. Time when the print server was created.
"description": "A String", # Editable. Description of the print server (as shown in the Admin console).
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
"id": "A String", # Immutable. ID of the print server. Leave empty when creating.
"name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
"orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).
"uri": "A String", # Editable. Print server URI.
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"failures": [ # A list of create failures. `PrintServer` IDs are not populated, as print servers were not created.
{ # Info about failures
"errorCode": "A String", # Canonical code for why the update failed to apply.
"errorMessage": "A String", # Failure reason message.
"printServer": { # Configuration for a print server. # Failed print server.
"createTime": "A String", # Output only. Time when the print server was created.
"description": "A String", # Editable. Description of the print server (as shown in the Admin console).
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
"id": "A String", # Immutable. ID of the print server. Leave empty when creating.
"name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
"orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).
"uri": "A String", # Editable. Print server URI.
},
"printServerId": "A String", # ID of a failed print server.
},
],
"printServers": [ # A list of successfully created print servers with their IDs populated.
{ # Configuration for a print server.
"createTime": "A String", # Output only. Time when the print server was created.
"description": "A String", # Editable. Description of the print server (as shown in the Admin console).
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
"id": "A String", # Immutable. ID of the print server. Leave empty when creating.
"name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
"orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).
"uri": "A String", # Editable. Print server URI.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="batchDeletePrintServers">batchDeletePrintServers(parent, body=None, x__xgafv=None)</code>
<pre>Deletes multiple print servers.
Args:
parent: string, Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{customer.id}` (required)
body: object, The request body.
The object takes the form of:
{ # Request to delete multiple existing print servers in a batch.
"printServerIds": [ # A list of print server IDs that should be deleted (max `100` per batch).
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"failedPrintServers": [ # A list of update failures.
{ # Info about failures
"errorCode": "A String", # Canonical code for why the update failed to apply.
"errorMessage": "A String", # Failure reason message.
"printServer": { # Configuration for a print server. # Failed print server.
"createTime": "A String", # Output only. Time when the print server was created.
"description": "A String", # Editable. Description of the print server (as shown in the Admin console).
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
"id": "A String", # Immutable. ID of the print server. Leave empty when creating.
"name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
"orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).
"uri": "A String", # Editable. Print server URI.
},
"printServerId": "A String", # ID of a failed print server.
},
],
"printServerIds": [ # A list of print server IDs that were successfully deleted.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a print server.
Args:
parent: string, Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required)
body: object, The request body.
The object takes the form of:
{ # Configuration for a print server.
"createTime": "A String", # Output only. Time when the print server was created.
"description": "A String", # Editable. Description of the print server (as shown in the Admin console).
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
"id": "A String", # Immutable. ID of the print server. Leave empty when creating.
"name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
"orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).
"uri": "A String", # Editable. Print server URI.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configuration for a print server.
"createTime": "A String", # Output only. Time when the print server was created.
"description": "A String", # Editable. Description of the print server (as shown in the Admin console).
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
"id": "A String", # Immutable. ID of the print server. Leave empty when creating.
"name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
"orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).
"uri": "A String", # Editable. Print server URI.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a print server.
Args:
name: string, Required. The name of the print server to be deleted. Format: `customers/{customer.id}/chrome/printServers/{print_server.id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Returns a print server's configuration.
Args:
name: string, Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configuration for a print server.
"createTime": "A String", # Output only. Time when the print server was created.
"description": "A String", # Editable. Description of the print server (as shown in the Admin console).
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
"id": "A String", # Immutable. ID of the print server. Leave empty when creating.
"name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
"orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).
"uri": "A String", # Editable. Print server URI.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists print server configurations.
Args:
parent: string, Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required)
filter: string, Search query in [Common Expression Language syntax](https://github.com/google/cel-spec). Supported filters are `display_name`, `description`, and `uri`. Example: `printServer.displayName=='marketing-queue'`.
orderBy: string, Sort order for results. Supported values are `display_name`, `description`, or `create_time`. Default order is ascending, but descending order can be returned by appending "desc" to the `order_by` field. For instance, `orderBy=='description desc'` returns the print servers sorted by description in descending order.
orgUnitId: string, If `org_unit_id` is present in the request, only print servers owned or inherited by the organizational unit (OU) are returned. If the `PrintServer` resource's `org_unit_id` matches the one in the request, the OU owns the server. If `org_unit_id` is not specified in the request, all print servers are returned or filtered against.
pageSize: integer, The maximum number of objects to return (default `100`, max `100`). The service might return fewer than this value.
pageToken: string, A generated token to paginate results (the `next_page_token` from a previous call).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token that can be sent as `page_token` in a request to retrieve the next page. If this field is omitted, there are no subsequent pages.
"printServers": [ # List of print servers.
{ # Configuration for a print server.
"createTime": "A String", # Output only. Time when the print server was created.
"description": "A String", # Editable. Description of the print server (as shown in the Admin console).
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
"id": "A String", # Immutable. ID of the print server. Leave empty when creating.
"name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
"orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).
"uri": "A String", # Editable. Print server URI.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a print server's configuration.
Args:
name: string, Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` (required)
body: object, The request body.
The object takes the form of:
{ # Configuration for a print server.
"createTime": "A String", # Output only. Time when the print server was created.
"description": "A String", # Editable. Description of the print server (as shown in the Admin console).
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
"id": "A String", # Immutable. ID of the print server. Leave empty when creating.
"name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
"orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).
"uri": "A String", # Editable. Print server URI.
}
updateMask: string, The list of fields to update. Some fields are read-only and cannot be updated. Values for unspecified fields are patched.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configuration for a print server.
"createTime": "A String", # Output only. Time when the print server was created.
"description": "A String", # Editable. Description of the print server (as shown in the Admin console).
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console).
"id": "A String", # Immutable. ID of the print server. Leave empty when creating.
"name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
"orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits).
"uri": "A String", # Editable. Print server URI.
}</pre>
</div>
</body></html>
|
