print_servers

Creates, updates, deletes, gets or lists a print_servers resource.

Overview

Name	print_servers
Type	Resource
Id	googleadmin.directory.print_servers

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string	Immutable. ID of the print server. Leave empty when creating.
name	string	Identifier. Resource name of the print server. Leave empty when creating. Format: customers/{customer.id}/printServers/{print_server.id}
createTime	string (google-datetime)	Output only. Time when the print server was created.
description	string	Editable. Description of the print server (as shown in the Admin console).
displayName	string	Editable. Display name of the print server (as shown in the Admin console).
orgUnitId	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.
uri	string	Editable. Print server URI.

list

Successful response

Name	Datatype	Description
id	string	Immutable. ID of the print server. Leave empty when creating.
name	string	Identifier. Resource name of the print server. Leave empty when creating. Format: customers/{customer.id}/printServers/{print_server.id}
createTime	string (google-datetime)	Output only. Time when the print server was created.
description	string	Editable. Description of the print server (as shown in the Admin console).
displayName	string	Editable. Display name of the print server (as shown in the Admin console).
orgUnitId	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.
uri	string	Editable. Print server URI.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	customersId, printServersId		Returns a print server's configuration.
list	select	customersId	pageSize, pageToken, orgUnitId, filter, orderBy	Lists print server configurations.
create	insert	customersId		Creates a print server.
batch_create_print_servers	insert	customersId		Creates multiple print servers.
patch	update	customersId, printServersId	updateMask	Updates a print server's configuration.
delete	delete	customersId, printServersId		Deletes a print server.
batch_delete_print_servers	delete	customersId		Deletes multiple print servers.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
customersId	string
printServersId	string
filter	string
orderBy	string
orgUnitId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Returns a print server's configuration.

SELECT
id,
name,
createTime,
description,
displayName,
orgUnitId,
uri
FROM googleadmin.directory.print_servers
WHERE customersId = '{{ customersId }}' -- required
AND printServersId = '{{ printServersId }}' -- required;

list

Lists print server configurations.

SELECT
id,
name,
createTime,
description,
displayName,
orgUnitId,
uri
FROM googleadmin.directory.print_servers
WHERE customersId = '{{ customersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orgUnitId = '{{ orgUnitId }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a print server.

INSERT INTO googleadmin.directory.print_servers (
data__name,
data__id,
data__displayName,
data__description,
data__uri,
data__orgUnitId,
customersId
)
SELECT 
'{{ name }}',
'{{ id }}',
'{{ displayName }}',
'{{ description }}',
'{{ uri }}',
'{{ orgUnitId }}',
'{{ customersId }}'
RETURNING
id,
name,
createTime,
description,
displayName,
orgUnitId,
uri
;

batch_create_print_servers

Creates multiple print servers.

INSERT INTO googleadmin.directory.print_servers (
data__requests,
customersId
)
SELECT 
'{{ requests }}',
'{{ customersId }}'
RETURNING
failures,
printServers
;

Manifest

# Description fields are for documentation purposes
- name: print_servers
  props:
    - name: customersId
      value: string
      description: Required parameter for the print_servers resource.
    - name: name
      value: string
      description: >
        Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}`
        
    - name: id
      value: string
      description: >
        Immutable. ID of the print server. Leave empty when creating.
        
    - name: displayName
      value: string
      description: >
        Editable. Display name of the print server (as shown in the Admin console).
        
    - name: description
      value: string
      description: >
        Editable. Description of the print server (as shown in the Admin console).
        
    - name: uri
      value: string
      description: >
        Editable. Print server URI.
        
    - name: orgUnitId
      value: string
      description: >
        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).
        
    - name: requests
      value: array
      description: >
        Required. A list of `PrintServer` resources to be created (max `50` per batch).
        

UPDATE examples

patch

Updates a print server's configuration.

UPDATE googleadmin.directory.print_servers
SET 
data__name = '{{ name }}',
data__id = '{{ id }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__uri = '{{ uri }}',
data__orgUnitId = '{{ orgUnitId }}'
WHERE 
customersId = '{{ customersId }}' --required
AND printServersId = '{{ printServersId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
id,
name,
createTime,
description,
displayName,
orgUnitId,
uri;

DELETE examples

delete

Deletes a print server.

DELETE FROM googleadmin.directory.print_servers
WHERE customersId = '{{ customersId }}' --required
AND printServersId = '{{ printServersId }}' --required;

batch_delete_print_servers

Deletes multiple print servers.

DELETE FROM googleadmin.directory.print_servers
WHERE customersId = '{{ customersId }}' --required;