target.apidocs.com.google.api.services.directory.Directory.Chromeosdevices.List.html Maven / Gradle / Ivy
Directory.Chromeosdevices.List (Admin SDK API directory_v1-rev20220125-1.32.1)
com.google.api.services.directory
Class Directory.Chromeosdevices.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.directory.DirectoryRequest<ChromeOsDevices>
-
- com.google.api.services.directory.Directory.Chromeosdevices.List
-
- Enclosing class:
- Directory.Chromeosdevices
public class Directory.Chromeosdevices.List
extends DirectoryRequest<ChromeOsDevices>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Field Summary
-
Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
USER_AGENT_SUFFIX
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
List(String customerId)
Retrieves a paginated list of Chrome OS devices within an account.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
HttpRequest
buildHttpRequestUsingHead()
HttpResponse
executeUsingHead()
String
getCustomerId()
The unique ID for the customer's Google Workspace account.
Boolean
getIncludeChildOrgunits()
Return devices from all child orgunits, as well as the specified org unit.
Integer
getMaxResults()
Maximum number of results to return.
String
getOrderBy()
Device property to use for sorting results.
String
getOrgUnitPath()
The full path of the organizational unit (minus the leading `/`) or its unique ID.
String
getPageToken()
The `pageToken` query parameter is used to request the next page of query results.
String
getProjection()
Restrict information returned to a set of selected fields.
String
getQuery()
Search string in the format given at https://developers.google.com/admin-sdk/directory/v1/list-
query-operators
String
getSortOrder()
Whether to return results in ascending or descending order.
Directory.Chromeosdevices.List
set(String parameterName,
Object value)
Directory.Chromeosdevices.List
set$Xgafv(String $Xgafv)
V1 error format.
Directory.Chromeosdevices.List
setAccessToken(String accessToken)
OAuth access token.
Directory.Chromeosdevices.List
setAlt(String alt)
Data format for response.
Directory.Chromeosdevices.List
setCallback(String callback)
JSONP
Directory.Chromeosdevices.List
setCustomerId(String customerId)
The unique ID for the customer's Google Workspace account.
Directory.Chromeosdevices.List
setFields(String fields)
Selector specifying which fields to include in a partial response.
Directory.Chromeosdevices.List
setIncludeChildOrgunits(Boolean includeChildOrgunits)
Return devices from all child orgunits, as well as the specified org unit.
Directory.Chromeosdevices.List
setKey(String key)
API key.
Directory.Chromeosdevices.List
setMaxResults(Integer maxResults)
Maximum number of results to return.
Directory.Chromeosdevices.List
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Directory.Chromeosdevices.List
setOrderBy(String orderBy)
Device property to use for sorting results.
Directory.Chromeosdevices.List
setOrgUnitPath(String orgUnitPath)
The full path of the organizational unit (minus the leading `/`) or its unique ID.
Directory.Chromeosdevices.List
setPageToken(String pageToken)
The `pageToken` query parameter is used to request the next page of query results.
Directory.Chromeosdevices.List
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Directory.Chromeosdevices.List
setProjection(String projection)
Restrict information returned to a set of selected fields.
Directory.Chromeosdevices.List
setQuery(String query)
Search string in the format given at https://developers.google.com/admin-sdk/directory/v1
/list-query-operators
Directory.Chromeosdevices.List
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Directory.Chromeosdevices.List
setSortOrder(String sortOrder)
Whether to return results in ascending or descending order.
Directory.Chromeosdevices.List
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Directory.Chromeosdevices.List
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
-
Methods inherited from class com.google.api.services.directory.DirectoryRequest
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 customerId)
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 the admin server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation. Directory.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must be
called to initialize this instance immediately after invoking the constructor.
- 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).
- Since:
- 1.13
-
Method Detail
-
executeUsingHead
public HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead
in class AbstractGoogleClientRequest<ChromeOsDevices>
- Throws:
IOException
-
buildHttpRequestUsingHead
public HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class AbstractGoogleClientRequest<ChromeOsDevices>
- Throws:
IOException
-
set$Xgafv
public Directory.Chromeosdevices.List set$Xgafv(String $Xgafv)
Description copied from class: DirectoryRequest
V1 error format.
- Overrides:
set$Xgafv
in class DirectoryRequest<ChromeOsDevices>
-
setAccessToken
public Directory.Chromeosdevices.List setAccessToken(String accessToken)
Description copied from class: DirectoryRequest
OAuth access token.
- Overrides:
setAccessToken
in class DirectoryRequest<ChromeOsDevices>
-
setAlt
public Directory.Chromeosdevices.List setAlt(String alt)
Description copied from class: DirectoryRequest
Data format for response.
- Overrides:
setAlt
in class DirectoryRequest<ChromeOsDevices>
-
setCallback
public Directory.Chromeosdevices.List setCallback(String callback)
Description copied from class: DirectoryRequest
JSONP
- Overrides:
setCallback
in class DirectoryRequest<ChromeOsDevices>
-
setFields
public Directory.Chromeosdevices.List setFields(String fields)
Description copied from class: DirectoryRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class DirectoryRequest<ChromeOsDevices>
-
setKey
public Directory.Chromeosdevices.List setKey(String key)
Description copied from class: DirectoryRequest
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 DirectoryRequest<ChromeOsDevices>
-
setOauthToken
public Directory.Chromeosdevices.List setOauthToken(String oauthToken)
Description copied from class: DirectoryRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class DirectoryRequest<ChromeOsDevices>
-
setPrettyPrint
public Directory.Chromeosdevices.List setPrettyPrint(Boolean prettyPrint)
Description copied from class: DirectoryRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class DirectoryRequest<ChromeOsDevices>
-
setQuotaUser
public Directory.Chromeosdevices.List setQuotaUser(String quotaUser)
Description copied from class: DirectoryRequest
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 DirectoryRequest<ChromeOsDevices>
-
setUploadType
public Directory.Chromeosdevices.List setUploadType(String uploadType)
Description copied from class: DirectoryRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class DirectoryRequest<ChromeOsDevices>
-
setUploadProtocol
public Directory.Chromeosdevices.List setUploadProtocol(String uploadProtocol)
Description copied from class: DirectoryRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class DirectoryRequest<ChromeOsDevices>
-
getCustomerId
public String getCustomerId()
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).
-
setCustomerId
public Directory.Chromeosdevices.List setCustomerId(String 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).
-
getIncludeChildOrgunits
public Boolean getIncludeChildOrgunits()
Return devices from all child orgunits, as well as the specified org unit. If this is set to true
'orgUnitPath' must be provided.
-
setIncludeChildOrgunits
public Directory.Chromeosdevices.List setIncludeChildOrgunits(Boolean includeChildOrgunits)
Return devices from all child orgunits, as well as the specified org unit. If this is set
to true 'orgUnitPath' must be provided.
-
getMaxResults
public Integer getMaxResults()
Maximum number of results to return. [default: 100] [minimum: 1]
-
setMaxResults
public Directory.Chromeosdevices.List setMaxResults(Integer maxResults)
Maximum number of results to return.
-
getOrderBy
public String getOrderBy()
Device property to use for sorting results.
-
setOrderBy
public Directory.Chromeosdevices.List setOrderBy(String orderBy)
Device property to use for sorting results.
-
getOrgUnitPath
public String getOrgUnitPath()
The full path of the organizational unit (minus the leading `/`) or its unique ID.
-
setOrgUnitPath
public Directory.Chromeosdevices.List setOrgUnitPath(String orgUnitPath)
The full path of the organizational unit (minus the leading `/`) or its unique ID.
-
getPageToken
public String getPageToken()
The `pageToken` query parameter is used to request the next page of query results. The follow-on
request's `pageToken` query parameter is the `nextPageToken` from your previous response.
-
setPageToken
public Directory.Chromeosdevices.List setPageToken(String pageToken)
The `pageToken` query parameter is used to request the next page of query results. The
follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous
response.
-
getProjection
public String getProjection()
Restrict information returned to a set of selected fields.
-
setProjection
public Directory.Chromeosdevices.List setProjection(String projection)
Restrict information returned to a set of selected fields.
-
getQuery
public String getQuery()
Search string in the format given at https://developers.google.com/admin-sdk/directory/v1/list-
query-operators
-
setQuery
public Directory.Chromeosdevices.List setQuery(String query)
Search string in the format given at https://developers.google.com/admin-sdk/directory/v1
/list-query-operators
-
getSortOrder
public String getSortOrder()
Whether to return results in ascending or descending order. Must be used with the `orderBy`
parameter.
-
setSortOrder
public Directory.Chromeosdevices.List setSortOrder(String sortOrder)
Whether to return results in ascending or descending order. Must be used with the `orderBy`
parameter.
-
set
public Directory.Chromeosdevices.List set(String parameterName,
Object value)
- Overrides:
set
in class DirectoryRequest<ChromeOsDevices>
Copyright © 2011–2022 Google. All rights reserved.