OrgUnit (Admin SDK API directory_v1-rev20210622-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.directory.model.OrgUnit

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class OrgUnit
extends GenericJson
```
Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Admin SDK API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors
Constructor and Description

OrgUnit()

Constructors
Constructor and Description
`OrgUnit()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OrgUnit`	`clone()`
`Boolean`	`getBlockInheritance()` Determines if a sub-organizational unit can inherit the settings of the parent organization.
`String`	`getDescription()` Description of the organizational unit.
`String`	`getEtag()` ETag of the resource.
`String`	`getKind()` The type of the API resource.
`String`	`getName()` The organizational unit's path name.
`String`	`getOrgUnitId()` The unique ID of the organizational unit.
`String`	`getOrgUnitPath()` The full path to the organizational unit.
`String`	`getParentOrgUnitId()` The unique ID of the parent organizational unit.
`String`	`getParentOrgUnitPath()` The organizational unit's parent path.
`OrgUnit`	`set(String fieldName, Object value)`
`OrgUnit`	`setBlockInheritance(Boolean blockInheritance)` Determines if a sub-organizational unit can inherit the settings of the parent organization.
`OrgUnit`	`setDescription(String description)` Description of the organizational unit.
`OrgUnit`	`setEtag(String etag)` ETag of the resource.
`OrgUnit`	`setKind(String kind)` The type of the API resource.
`OrgUnit`	`setName(String name)` The organizational unit's path name.
`OrgUnit`	`setOrgUnitId(String orgUnitId)` The unique ID of the organizational unit.
`OrgUnit`	`setOrgUnitPath(String orgUnitPath)` The full path to the organizational unit.
`OrgUnit`	`setParentOrgUnitId(String parentOrgUnitId)` The unique ID of the parent organizational unit.
`OrgUnit`	`setParentOrgUnitPath(String parentOrgUnitPath)` The organizational unit's parent path.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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
  - OrgUnit
```
public OrgUnit()
```
- Method Detail
  - getBlockInheritance
```
public Boolean getBlockInheritance()
```
    Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).
    
    Returns:
    
    value or null for none
  - setBlockInheritance
```
public OrgUnit setBlockInheritance(Boolean blockInheritance)
```
    Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).
    
    Parameters:
    
    blockInheritance - blockInheritance or null for none
  - getDescription
```
public String getDescription()
```
    Description of the organizational unit.
    
    Returns:
    
    value or null for none
  - setDescription
```
public OrgUnit setDescription(String description)
```
    Description of the organizational unit.
    
    Parameters:
    
    description - description or null for none
  - getEtag
```
public String getEtag()
```
    ETag of the resource.
    
    Returns:
    
    value or null for none
  - setEtag
```
public OrgUnit setEtag(String etag)
```
    ETag of the resource.
    
    Parameters:
    
    etag - etag or null for none
  - getKind
```
public String getKind()
```
    The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
    
    Returns:
    
    value or null for none
  - setKind
```
public OrgUnit setKind(String kind)
```
    The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
    
    Parameters:
    
    kind - kind or null for none
  - getName
```
public String getName()
```
    The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
    
    Returns:
    
    value or null for none
  - setName
```
public OrgUnit setName(String name)
```
    The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
    
    Parameters:
    
    name - name or null for none
  - getOrgUnitId
```
public String getOrgUnitId()
```
    The unique ID of the organizational unit.
    
    Returns:
    
    value or null for none
  - setOrgUnitId
```
public OrgUnit setOrgUnitId(String orgUnitId)
```
    The unique ID of the organizational unit.
    
    Parameters:
    
    orgUnitId - orgUnitId or null for none
  - getOrgUnitPath
```
public String getOrgUnitPath()
```
    The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin- sdk/directory/v1/guides/manage-users.html#update_user).
    
    Returns:
    
    value or null for none
  - setOrgUnitPath
```
public OrgUnit setOrgUnitPath(String orgUnitPath)
```
    The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin- sdk/directory/v1/guides/manage-users.html#update_user).
    
    Parameters:
    
    orgUnitPath - orgUnitPath or null for none
  - getParentOrgUnitId
```
public String getParentOrgUnitId()
```
    The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
    
    Returns:
    
    value or null for none
  - setParentOrgUnitId
```
public OrgUnit setParentOrgUnitId(String parentOrgUnitId)
```
    The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
    
    Parameters:
    
    parentOrgUnitId - parentOrgUnitId or null for none
  - getParentOrgUnitPath
```
public String getParentOrgUnitPath()
```
    The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
    
    Returns:
    
    value or null for none
  - setParentOrgUnitPath
```
public OrgUnit setParentOrgUnitPath(String parentOrgUnitPath)
```
    The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
    
    Parameters:
    
    parentOrgUnitPath - parentOrgUnitPath or null for none
  - set
```
public OrgUnit set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public OrgUnit clone()
```
    Overrides:
    
    clone in class GenericJson

Class OrgUnit

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

OrgUnit

Method Detail

getBlockInheritance

setBlockInheritance

getDescription

setDescription

getEtag

setEtag

getKind

setKind

getName

setName

getOrgUnitId

setOrgUnitId

getOrgUnitPath

setOrgUnitPath

getParentOrgUnitId

setParentOrgUnitId

getParentOrgUnitPath

setParentOrgUnitPath

set

clone