com.google.api.services.directory

Class Directory.Orgunits.Get

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<OrgUnit>

com.google.api.services.directory.Directory.Orgunits.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Directory.Orgunits

public class Directory.Orgunits.Get
extends DirectoryRequest<OrgUnit>

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>

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Get(String customerId, String orgUnitPath) Retrieves an organizational unit.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
Boolean	getAllowPlus() Parses org unit path without url decode to allow for plus in ou name
String	getCustomerId() The unique ID for the customer's Google Workspace account.
String	getOrgUnitPath() The full path of the organizational unit or its unique ID.
Directory.Orgunits.Get	set(String parameterName, Object value)
Directory.Orgunits.Get	set$Xgafv(String $Xgafv) V1 error format.
Directory.Orgunits.Get	setAccessToken(String accessToken) OAuth access token.
Directory.Orgunits.Get	setAllowPlus(Boolean allowPlus) Parses org unit path without url decode to allow for plus in ou name
Directory.Orgunits.Get	setAlt(String alt) Data format for response.
Directory.Orgunits.Get	setCallback(String callback) JSONP
Directory.Orgunits.Get	setCustomerId(String customerId) The unique ID for the customer's Google Workspace account.
Directory.Orgunits.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Directory.Orgunits.Get	setKey(String key) API key.
Directory.Orgunits.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Directory.Orgunits.Get	setOrgUnitPath(String orgUnitPath) The full path of the organizational unit or its unique ID.
Directory.Orgunits.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Directory.Orgunits.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Directory.Orgunits.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Directory.Orgunits.Get	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

Get

protected Get(String customerId,
              String orgUnitPath)

Retrieves an organizational unit. Create a request for the method "orgunits.get". 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).

orgUnitPath - The full path of the organizational unit or its unique ID.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<OrgUnit>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<OrgUnit>

Throws:

IOException

set$Xgafv

public Directory.Orgunits.Get set$Xgafv(String $Xgafv)

Description copied from class: DirectoryRequest

V1 error format.

Overrides:

set$Xgafv in class DirectoryRequest<OrgUnit>

setAccessToken

public Directory.Orgunits.Get setAccessToken(String accessToken)

Description copied from class: DirectoryRequest

OAuth access token.

Overrides:

setAccessToken in class DirectoryRequest<OrgUnit>

setAlt

public Directory.Orgunits.Get setAlt(String alt)

Description copied from class: DirectoryRequest

Data format for response.

Overrides:

setAlt in class DirectoryRequest<OrgUnit>

setCallback

public Directory.Orgunits.Get setCallback(String callback)

Description copied from class: DirectoryRequest

JSONP

Overrides:

setCallback in class DirectoryRequest<OrgUnit>

setFields

public Directory.Orgunits.Get setFields(String fields)

Description copied from class: DirectoryRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DirectoryRequest<OrgUnit>

setKey

public Directory.Orgunits.Get 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<OrgUnit>

setOauthToken

public Directory.Orgunits.Get setOauthToken(String oauthToken)

Description copied from class: DirectoryRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DirectoryRequest<OrgUnit>

setPrettyPrint

public Directory.Orgunits.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: DirectoryRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DirectoryRequest<OrgUnit>

setQuotaUser

public Directory.Orgunits.Get 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<OrgUnit>

setUploadType

public Directory.Orgunits.Get setUploadType(String uploadType)

Description copied from class: DirectoryRequest

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

Overrides:

setUploadType in class DirectoryRequest<OrgUnit>

setUploadProtocol

public Directory.Orgunits.Get setUploadProtocol(String uploadProtocol)

Description copied from class: DirectoryRequest

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

Overrides:

setUploadProtocol in class DirectoryRequest<OrgUnit>

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.Orgunits.Get 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).

getOrgUnitPath

public String getOrgUnitPath()

The full path of the organizational unit or its unique ID.

setOrgUnitPath

public Directory.Orgunits.Get setOrgUnitPath(String orgUnitPath)

The full path of the organizational unit or its unique ID.

getAllowPlus

public Boolean getAllowPlus()

Parses org unit path without url decode to allow for plus in ou name

setAllowPlus

public Directory.Orgunits.Get setAllowPlus(Boolean allowPlus)

Parses org unit path without url decode to allow for plus in ou name

set

public Directory.Orgunits.Get set(String parameterName,
                                  Object value)

Overrides:

set in class DirectoryRequest<OrgUnit>