target.apidocs.com.google.api.services.cloudidentity.v1.CloudIdentity.Devices.DeviceUsers.Lookup.html Maven / Gradle / Ivy
The newest version!
CloudIdentity.Devices.DeviceUsers.Lookup (Cloud Identity API v1-rev20241010-2.0.0)
com.google.api.services.cloudidentity.v1
Class CloudIdentity.Devices.DeviceUsers.Lookup
- 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<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
-
- com.google.api.services.cloudidentity.v1.CloudIdentity.Devices.DeviceUsers.Lookup
-
- Enclosing class:
- CloudIdentity.Devices.DeviceUsers
public class CloudIdentity.Devices.DeviceUsers.Lookup
extends CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Lookup(String parent)
Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as
the properties provided in the request.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse
executeUsingHead()
String
getAndroidId()
Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android
/provider/Settings.Secure.html#ANDROID_ID).
Integer
getPageSize()
The maximum number of DeviceUsers to return.
String
getPageToken()
A page token, received from a previous `LookupDeviceUsers` call.
String
getParent()
Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user.
String
getRawResourceId()
Raw Resource Id used by Google Endpoint Verification.
String
getUserId()
The user whose DeviceUser's resource name will be fetched.
CloudIdentity.Devices.DeviceUsers.Lookup
set(String parameterName,
Object value)
CloudIdentity.Devices.DeviceUsers.Lookup
set$Xgafv(String $Xgafv)
V1 error format.
CloudIdentity.Devices.DeviceUsers.Lookup
setAccessToken(String accessToken)
OAuth access token.
CloudIdentity.Devices.DeviceUsers.Lookup
setAlt(String alt)
Data format for response.
CloudIdentity.Devices.DeviceUsers.Lookup
setAndroidId(String androidId)
Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/referen
ce/android/provider/Settings.Secure.html#ANDROID_ID).
CloudIdentity.Devices.DeviceUsers.Lookup
setCallback(String callback)
JSONP
CloudIdentity.Devices.DeviceUsers.Lookup
setFields(String fields)
Selector specifying which fields to include in a partial response.
CloudIdentity.Devices.DeviceUsers.Lookup
setKey(String key)
API key.
CloudIdentity.Devices.DeviceUsers.Lookup
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
CloudIdentity.Devices.DeviceUsers.Lookup
setPageSize(Integer pageSize)
The maximum number of DeviceUsers to return.
CloudIdentity.Devices.DeviceUsers.Lookup
setPageToken(String pageToken)
A page token, received from a previous `LookupDeviceUsers` call.
CloudIdentity.Devices.DeviceUsers.Lookup
setParent(String parent)
Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the
user.
CloudIdentity.Devices.DeviceUsers.Lookup
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
CloudIdentity.Devices.DeviceUsers.Lookup
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
CloudIdentity.Devices.DeviceUsers.Lookup
setRawResourceId(String rawResourceId)
Raw Resource Id used by Google Endpoint Verification.
CloudIdentity.Devices.DeviceUsers.Lookup
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
CloudIdentity.Devices.DeviceUsers.Lookup
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
CloudIdentity.Devices.DeviceUsers.Lookup
setUserId(String userId)
The user whose DeviceUser's resource name will be fetched.
-
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
-
Lookup
protected Lookup(String parent)
Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as
the properties provided in the request. This method must be called with end-user credentials
with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple
properties are provided, only DeviceUsers having all of these properties are considered as
matches - i.e. the query behaves like an AND. Different platforms require different amounts of
information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No
properties need to be passed, the caller's credentials are sufficient to identify the
corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop:
Specifying the 'raw_resource_id' field is required.
Create a request for the method "deviceUsers.lookup".
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
- Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user.
- 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<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
- Throws:
IOException
-
set$Xgafv
public CloudIdentity.Devices.DeviceUsers.Lookup set$Xgafv(String $Xgafv)
Description copied from class: CloudIdentityRequest
V1 error format.
- Overrides:
set$Xgafv
in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
-
setAccessToken
public CloudIdentity.Devices.DeviceUsers.Lookup setAccessToken(String accessToken)
Description copied from class: CloudIdentityRequest
OAuth access token.
-
setAlt
public CloudIdentity.Devices.DeviceUsers.Lookup setAlt(String alt)
Description copied from class: CloudIdentityRequest
Data format for response.
- Overrides:
setAlt
in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
-
setCallback
public CloudIdentity.Devices.DeviceUsers.Lookup setCallback(String callback)
Description copied from class: CloudIdentityRequest
JSONP
- Overrides:
setCallback
in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
-
setFields
public CloudIdentity.Devices.DeviceUsers.Lookup setFields(String fields)
Description copied from class: CloudIdentityRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
-
setKey
public CloudIdentity.Devices.DeviceUsers.Lookup 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<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
-
setOauthToken
public CloudIdentity.Devices.DeviceUsers.Lookup setOauthToken(String oauthToken)
Description copied from class: CloudIdentityRequest
OAuth 2.0 token for the current user.
-
setPrettyPrint
public CloudIdentity.Devices.DeviceUsers.Lookup setPrettyPrint(Boolean prettyPrint)
Description copied from class: CloudIdentityRequest
Returns response with indentations and line breaks.
-
setQuotaUser
public CloudIdentity.Devices.DeviceUsers.Lookup 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.
-
setUploadType
public CloudIdentity.Devices.DeviceUsers.Lookup setUploadType(String uploadType)
Description copied from class: CloudIdentityRequest
Legacy upload protocol for media (e.g. "media", "multipart").
-
setUploadProtocol
public CloudIdentity.Devices.DeviceUsers.Lookup setUploadProtocol(String uploadProtocol)
Description copied from class: CloudIdentityRequest
Upload protocol for media (e.g. "raw", "multipart").
-
getParent
public String getParent()
Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user.
-
setParent
public CloudIdentity.Devices.DeviceUsers.Lookup setParent(String parent)
Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the
user.
-
getAndroidId
public String getAndroidId()
Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android
/provider/Settings.Secure.html#ANDROID_ID).
-
setAndroidId
public CloudIdentity.Devices.DeviceUsers.Lookup setAndroidId(String androidId)
Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/referen
ce/android/provider/Settings.Secure.html#ANDROID_ID).
-
getPageSize
public Integer getPageSize()
The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be
returned. The maximum value is 20; values above 20 will be coerced to 20.
-
setPageSize
public CloudIdentity.Devices.DeviceUsers.Lookup setPageSize(Integer pageSize)
The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will
be returned. The maximum value is 20; values above 20 will be coerced to 20.
-
getPageToken
public String getPageToken()
A page token, received from a previous `LookupDeviceUsers` call. Provide this to retrieve the
subsequent page. When paginating, all other parameters provided to `LookupDeviceUsers` must match
the call that provided the page token.
-
setPageToken
public CloudIdentity.Devices.DeviceUsers.Lookup setPageToken(String pageToken)
A page token, received from a previous `LookupDeviceUsers` call. Provide this to retrieve
the subsequent page. When paginating, all other parameters provided to
`LookupDeviceUsers` must match the call that provided the page token.
-
getRawResourceId
public String getRawResourceId()
Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint
Verification, this id will be saved as the 'device_resource_id' field in the following platform
dependent files. * macOS: ~/.secureConnect/context_aware_config.json * Windows:
%USERPROFILE%\AppData\Local\Google\Endpoint Verification\accounts.json * Linux:
~/.secureConnect/context_aware_config.json
-
setRawResourceId
public CloudIdentity.Devices.DeviceUsers.Lookup setRawResourceId(String rawResourceId)
Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google
Endpoint Verification, this id will be saved as the 'device_resource_id' field in the
following platform dependent files. * macOS: ~/.secureConnect/context_aware_config.json *
Windows: %USERPROFILE%\AppData\Local\Google\Endpoint Verification\accounts.json * Linux:
~/.secureConnect/context_aware_config.json
-
getUserId
public String getUserId()
The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the
DeviceUser's resource name for the calling user.
-
setUserId
public CloudIdentity.Devices.DeviceUsers.Lookup setUserId(String userId)
The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch
the DeviceUser's resource name for the calling user.
-
set
public CloudIdentity.Devices.DeviceUsers.Lookup set(String parameterName,
Object value)
- Overrides:
set
in class CloudIdentityRequest<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy