com.google.api.services.cloudidentity.v1

Class CloudIdentity.Devices.DeviceUsers.List

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.cloudidentity.v1.CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudIdentity.Devices.DeviceUsers

public class CloudIdentity.Devices.DeviceUsers.List
extends CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(String parent) Lists/Searches DeviceUsers.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getCustomer() Optional.
String	getFilter() Optional.
String	getOrderBy() Optional.
Integer	getPageSize() Optional.
String	getPageToken() Optional.
String	getParent() Required.
CloudIdentity.Devices.DeviceUsers.List	set(String parameterName, Object value)
CloudIdentity.Devices.DeviceUsers.List	set$Xgafv(String $Xgafv) V1 error format.
CloudIdentity.Devices.DeviceUsers.List	setAccessToken(String accessToken) OAuth access token.
CloudIdentity.Devices.DeviceUsers.List	setAlt(String alt) Data format for response.
CloudIdentity.Devices.DeviceUsers.List	setCallback(String callback) JSONP
CloudIdentity.Devices.DeviceUsers.List	setCustomer(String customer) Optional.
CloudIdentity.Devices.DeviceUsers.List	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudIdentity.Devices.DeviceUsers.List	setFilter(String filter) Optional.
CloudIdentity.Devices.DeviceUsers.List	setKey(String key) API key.
CloudIdentity.Devices.DeviceUsers.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudIdentity.Devices.DeviceUsers.List	setOrderBy(String orderBy) Optional.
CloudIdentity.Devices.DeviceUsers.List	setPageSize(Integer pageSize) Optional.
CloudIdentity.Devices.DeviceUsers.List	setPageToken(String pageToken) Optional.
CloudIdentity.Devices.DeviceUsers.List	setParent(String parent) Required.
CloudIdentity.Devices.DeviceUsers.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudIdentity.Devices.DeviceUsers.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudIdentity.Devices.DeviceUsers.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudIdentity.Devices.DeviceUsers.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.cloudidentity.v1.CloudIdentityRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

List

protected List(String parent)

Lists/Searches DeviceUsers. Create a request for the method "deviceUsers.list". This request holds the parameters needed by the the cloudidentity server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

CloudIdentity.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

parent - Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device}

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

Throws:

IOException

set$Xgafv

public CloudIdentity.Devices.DeviceUsers.List set$Xgafv(String $Xgafv)

Description copied from class: CloudIdentityRequest

V1 error format.

Overrides:

set$Xgafv in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

setAccessToken

public CloudIdentity.Devices.DeviceUsers.List setAccessToken(String accessToken)

Description copied from class: CloudIdentityRequest

OAuth access token.

Overrides:

setAccessToken in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

setAlt

public CloudIdentity.Devices.DeviceUsers.List setAlt(String alt)

Description copied from class: CloudIdentityRequest

Data format for response.

Overrides:

setAlt in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

setCallback

public CloudIdentity.Devices.DeviceUsers.List setCallback(String callback)

Description copied from class: CloudIdentityRequest

JSONP

Overrides:

setCallback in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

setFields

public CloudIdentity.Devices.DeviceUsers.List setFields(String fields)

Description copied from class: CloudIdentityRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

setKey

public CloudIdentity.Devices.DeviceUsers.List setKey(String key)

Description copied from class: CloudIdentityRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

setOauthToken

public CloudIdentity.Devices.DeviceUsers.List setOauthToken(String oauthToken)

Description copied from class: CloudIdentityRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

setPrettyPrint

public CloudIdentity.Devices.DeviceUsers.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudIdentityRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

setQuotaUser

public CloudIdentity.Devices.DeviceUsers.List setQuotaUser(String quotaUser)

Description copied from class: CloudIdentityRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

setUploadType

public CloudIdentity.Devices.DeviceUsers.List setUploadType(String uploadType)

Description copied from class: CloudIdentityRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

setUploadProtocol

public CloudIdentity.Devices.DeviceUsers.List setUploadProtocol(String uploadProtocol)

Description copied from class: CloudIdentityRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>

getParent

public String getParent()

Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device}

setParent

public CloudIdentity.Devices.DeviceUsers.List setParent(String parent)

Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device}

getCustomer

public String getCustomer()

Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer}`, where customer is the customer to whom the device belongs.

setCustomer

public CloudIdentity.Devices.DeviceUsers.List setCustomer(String customer)

Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer}`, where customer is the customer to whom the device belongs.

getFilter

public String getFilter()

Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to [Mobile device search fields](https://developers.google.com/admin-sdk/directory/v1/search- operators). Multiple search fields are separated by the space character.

setFilter

public CloudIdentity.Devices.DeviceUsers.List setFilter(String filter)

Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to [Mobile device search fields](https://developers.google.com/admin- sdk/directory/v1/search-operators). Multiple search fields are separated by the space character.

getOrderBy

public String getOrderBy()

Optional. Order specification for devices in the response.

setOrderBy

public CloudIdentity.Devices.DeviceUsers.List setOrderBy(String orderBy)

Optional. Order specification for devices in the response.

getPageSize

public Integer getPageSize()

Optional. The maximum number of DeviceUsers to return. If unspecified, at most 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.

setPageSize

public CloudIdentity.Devices.DeviceUsers.List setPageSize(Integer pageSize)

Optional. The maximum number of DeviceUsers to return. If unspecified, at most 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.

getPageToken

public String getPageToken()

Optional. A page token, received from a previous `ListDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBooks` must match the call that provided the page token.

setPageToken

public CloudIdentity.Devices.DeviceUsers.List setPageToken(String pageToken)

Optional. A page token, received from a previous `ListDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBooks` must match the call that provided the page token.

set

public CloudIdentity.Devices.DeviceUsers.List set(String parameterName,
                                                  Object value)

Overrides:

set in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse>