target.apidocs.com.google.api.services.cloudidentity.v1.CloudIdentity.Devices.html Maven / Gradle / Ivy

Go to download

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

The newest version!







CloudIdentity.Devices (Cloud Identity API v1-rev20241010-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.cloudidentity.v1
Class CloudIdentity.Devices



java.lang.Object


com.google.api.services.cloudidentity.v1.CloudIdentity.Devices







Enclosing class:
CloudIdentity




public class CloudIdentity.Devices
extends Object
The "devices" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
CloudIdentity.Devices.CancelWipe 


class 
CloudIdentity.Devices.Create 


class 
CloudIdentity.Devices.Delete 


class 
CloudIdentity.Devices.DeviceUsers
The "deviceUsers" collection of methods.



class 
CloudIdentity.Devices.Get 


class 
CloudIdentity.Devices.List 


class 
CloudIdentity.Devices.Wipe 









Constructor Summary

Constructors 

Constructor and Description


Devices() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CloudIdentity.Devices.CancelWipe
cancelWipe(String name,
          GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest content)
Cancels an unfinished device wipe.



CloudIdentity.Devices.Create
create(GoogleAppsCloudidentityDevicesV1Device content)
Creates a device.



CloudIdentity.Devices.Delete
delete(String name)
Deletes the specified device.



CloudIdentity.Devices.DeviceUsers
deviceUsers()
An accessor for creating requests from the DeviceUsers collection.



CloudIdentity.Devices.Get
get(String name)
Retrieves the specified device.



CloudIdentity.Devices.List
list()
Lists/Searches devices.



CloudIdentity.Devices.Wipe
wipe(String name,
    GoogleAppsCloudidentityDevicesV1WipeDeviceRequest content)
Wipes all data on the specified device.







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














Constructor Detail





Devices
public Devices()









Method Detail





cancelWipe
public CloudIdentity.Devices.CancelWipe cancelWipe(String name,
                                                   GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest content)
                                            throws IOException
Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap
 between the wipe operation returning success and the device being wiped. This operation is
 possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state
 when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe
 will fail if the wipe command has already been issued to the device.

 Create a request for the method "devices.cancelWipe".

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

Parameters:
name - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in
        format: `devices/{device}`, where device is the unique ID assigned to the Device.
content - the GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest
Returns:
the request
Throws:
IOException








create
public CloudIdentity.Devices.Create create(GoogleAppsCloudidentityDevicesV1Device content)
                                    throws IOException
Creates a device. Only company-owned device may be created. **Note**: This method is available
 only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus,
 Enterprise for Education, and Cloud Identity Premium

 Create a request for the method "devices.create".

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

Parameters:
content - the GoogleAppsCloudidentityDevicesV1Device
Returns:
the request
Throws:
IOException








delete
public CloudIdentity.Devices.Delete delete(String name)
                                    throws IOException
Deletes the specified device.

 Create a request for the method "devices.delete".

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

Parameters:
name - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in
        format: `devices/{device}`, where device is the unique ID assigned to the Device.
Returns:
the request
Throws:
IOException








get
public CloudIdentity.Devices.Get get(String name)
                              throws IOException
Retrieves the specified device.

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

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

Parameters:
name - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in the
        format: `devices/{device}`, where device is the unique ID assigned to the Device.
Returns:
the request
Throws:
IOException








list
public CloudIdentity.Devices.List list()
                                throws IOException
Lists/Searches devices.

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

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

Returns:
the request
Throws:
IOException








wipe
public CloudIdentity.Devices.Wipe wipe(String name,
                                       GoogleAppsCloudidentityDevicesV1WipeDeviceRequest content)
                                throws IOException
Wipes all data on the specified device.

 Create a request for the method "devices.wipe".

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

Parameters:
name - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in
        format: `devices/{device}/deviceUsers/{device_user}`, where device is the unique ID
        assigned to the Device, and device_user is the unique ID assigned to the User.
content - the GoogleAppsCloudidentityDevicesV1WipeDeviceRequest
Returns:
the request
Throws:
IOException








deviceUsers
public CloudIdentity.Devices.DeviceUsers deviceUsers()
An accessor for creating requests from the DeviceUsers collection.

 The typical use is:
     CloudIdentity cloudidentity = new CloudIdentity(...);
    CloudIdentity.DeviceUsers.List request = cloudidentity.deviceUsers().list(parameters ...)
 

Returns:
the resource collection














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–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`CloudIdentity.Devices.CancelWipe`
`class`	`CloudIdentity.Devices.Create`
`class`	`CloudIdentity.Devices.Delete`
`class`	`CloudIdentity.Devices.DeviceUsers` The "deviceUsers" collection of methods.
`class`	`CloudIdentity.Devices.Get`
`class`	`CloudIdentity.Devices.List`
`class`	`CloudIdentity.Devices.Wipe`

Modifier and Type	Method and Description
`CloudIdentity.Devices.CancelWipe`	`cancelWipe(String name, GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest content)` Cancels an unfinished device wipe.
`CloudIdentity.Devices.Create`	`create(GoogleAppsCloudidentityDevicesV1Device content)` Creates a device.
`CloudIdentity.Devices.Delete`	`delete(String name)` Deletes the specified device.
`CloudIdentity.Devices.DeviceUsers`	`deviceUsers()` An accessor for creating requests from the DeviceUsers collection.
`CloudIdentity.Devices.Get`	`get(String name)` Retrieves the specified device.
`CloudIdentity.Devices.List`	`list()` Lists/Searches devices.
`CloudIdentity.Devices.Wipe`	`wipe(String name, GoogleAppsCloudidentityDevicesV1WipeDeviceRequest content)` Wipes all data on the specified device.