target.apidocs.com.google.api.services.directory.Directory.Chromeosdevices.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-admin-directory Show documentation

There is a newer version: directory_v1-rev20240709-2.0.0

Show newest version







Directory.Chromeosdevices (Admin SDK API directory_v1-rev20220802-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.directory
Class Directory.Chromeosdevices



java.lang.Object


com.google.api.services.directory.Directory.Chromeosdevices







Enclosing class:
Directory




public class Directory.Chromeosdevices
extends Object
The "chromeosdevices" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Directory.Chromeosdevices.Action 


class 
Directory.Chromeosdevices.Get 


class 
Directory.Chromeosdevices.List 


class 
Directory.Chromeosdevices.MoveDevicesToOu 


class 
Directory.Chromeosdevices.Patch 


class 
Directory.Chromeosdevices.Update 









Constructor Summary

Constructors 

Constructor and Description


Chromeosdevices() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Directory.Chromeosdevices.Action
action(String customerId,
      String resourceId,
      ChromeOsDeviceAction content)
Takes an action that affects a Chrome OS Device.



Directory.Chromeosdevices.Get
get(String customerId,
   String deviceId)
Retrieves a Chrome OS device's properties.



Directory.Chromeosdevices.List
list(String customerId)
Retrieves a paginated list of Chrome OS devices within an account.



Directory.Chromeosdevices.MoveDevicesToOu
moveDevicesToOu(String customerId,
               String orgUnitPath,
               ChromeOsMoveDevicesToOu content)
Moves or inserts multiple Chrome OS devices to an organizational unit.



Directory.Chromeosdevices.Patch
patch(String customerId,
     String deviceId,
     ChromeOsDevice content)
Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`,
 `orgUnitPath`, or `annotatedAssetId`.



Directory.Chromeosdevices.Update
update(String customerId,
      String deviceId,
      ChromeOsDevice content)
Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`,
 `orgUnitPath`, or `annotatedAssetId`.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Chromeosdevices
public Chromeosdevices()









Method Detail





action
public Directory.Chromeosdevices.Action action(String customerId,
                                               String resourceId,
                                               ChromeOsDeviceAction content)
                                        throws IOException
Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-
 enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove
 device-level printers. After a device is deprovisioned, it must be wiped before it can be re-
 enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device
 will consume a device license. If you do not have sufficient licenses available when completing
 the re-enable action, you will receive an error. For more information about deprovisioning and
 disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633).

 Create a request for the method "chromeosdevices.action".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
customerId - The unique ID for the customer's Google Workspace account. As an account administrator, you can also
        use the `my_customer` alias to represent your account's `customerId`. The `customerId` is
        also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).
resourceId - The unique ID of the device. The `resourceId`s are returned in the response from the
        [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method.
content - the ChromeOsDeviceAction
Returns:
the request
Throws:
IOException








get
public Directory.Chromeosdevices.Get get(String customerId,
                                         String deviceId)
                                  throws IOException
Retrieves a Chrome OS device's properties.

 Create a request for the method "chromeosdevices.get".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
customerId - The unique ID for the customer's Google Workspace account. As an account administrator, you can also
        use the `my_customer` alias to represent your account's `customerId`. The `customerId` is
        also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).
deviceId - The unique ID of the device. The `deviceId`s are returned in the response from the
        [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method.
Returns:
the request
Throws:
IOException








list
public Directory.Chromeosdevices.List list(String customerId)
                                    throws IOException
Retrieves a paginated list of Chrome OS devices within an account.

 Create a request for the method "chromeosdevices.list".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
customerId - The unique ID for the customer's Google Workspace account. As an account administrator, you can also
        use the `my_customer` alias to represent your account's `customerId`. The `customerId` is
        also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).
Returns:
the request
Throws:
IOException








moveDevicesToOu
public Directory.Chromeosdevices.MoveDevicesToOu moveDevicesToOu(String customerId,
                                                                 String orgUnitPath,
                                                                 ChromeOsMoveDevicesToOu content)
                                                          throws IOException
Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50
 devices at once.

 Create a request for the method "chromeosdevices.moveDevicesToOu".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
customerId - Immutable ID of the Google Workspace account
orgUnitPath - Full path of the target organizational unit or its ID
content - the ChromeOsMoveDevicesToOu
Returns:
the request
Throws:
IOException








patch
public Directory.Chromeosdevices.Patch patch(String customerId,
                                             String deviceId,
                                             ChromeOsDevice content)
                                      throws IOException
Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`,
 `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](/admin-
 sdk/directory/v1/guides/performance#patch).

 Create a request for the method "chromeosdevices.patch".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
customerId - The unique ID for the customer's Google Workspace account. As an account administrator, you can also
        use the `my_customer` alias to represent your account's `customerId`. The `customerId` is
        also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).
deviceId - The unique ID of the device. The `deviceId`s are returned in the response from the
        [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) method.
content - the ChromeOsDevice
Returns:
the request
Throws:
IOException








update
public Directory.Chromeosdevices.Update update(String customerId,
                                               String deviceId,
                                               ChromeOsDevice content)
                                        throws IOException
Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`,
 `orgUnitPath`, or `annotatedAssetId`.

 Create a request for the method "chromeosdevices.update".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
customerId - The unique ID for the customer's Google Workspace account. As an account administrator, you can also
        use the `my_customer` alias to represent your account's `customerId`. The `customerId` is
        also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).
deviceId - The unique ID of the device. The `deviceId`s are returned in the response from the
        [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) method.
content - the ChromeOsDevice
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Directory.Chromeosdevices.Action`
`class`	`Directory.Chromeosdevices.Get`
`class`	`Directory.Chromeosdevices.List`
`class`	`Directory.Chromeosdevices.MoveDevicesToOu`
`class`	`Directory.Chromeosdevices.Patch`
`class`	`Directory.Chromeosdevices.Update`

Modifier and Type	Method and Description
`Directory.Chromeosdevices.Action`	`action(String customerId, String resourceId, ChromeOsDeviceAction content)` Takes an action that affects a Chrome OS Device.
`Directory.Chromeosdevices.Get`	`get(String customerId, String deviceId)` Retrieves a Chrome OS device's properties.
`Directory.Chromeosdevices.List`	`list(String customerId)` Retrieves a paginated list of Chrome OS devices within an account.
`Directory.Chromeosdevices.MoveDevicesToOu`	`moveDevicesToOu(String customerId, String orgUnitPath, ChromeOsMoveDevicesToOu content)` Moves or inserts multiple Chrome OS devices to an organizational unit.
`Directory.Chromeosdevices.Patch`	`patch(String customerId, String deviceId, ChromeOsDevice content)` Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.
`Directory.Chromeosdevices.Update`	`update(String customerId, String deviceId, ChromeOsDevice content)` Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.