target.apidocs.com.google.api.services.directory.Directory.Orgunits.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-admin-directory Show documentation

There is a newer version: directory_v1-rev20240709-2.0.0

Show newest version







Directory.Orgunits (Admin SDK API directory_v1-rev20220125-1.32.1)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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



java.lang.Object


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







Enclosing class:
Directory




public class Directory.Orgunits
extends Object
The "orgunits" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Directory.Orgunits.Delete 


class 
Directory.Orgunits.Get 


class 
Directory.Orgunits.Insert 


class 
Directory.Orgunits.List 


class 
Directory.Orgunits.Patch 


class 
Directory.Orgunits.Update 









Constructor Summary

Constructors 

Constructor and Description


Orgunits() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Directory.Orgunits.Delete
delete(String customerId,
      String orgUnitPath)
Removes an organizational unit.



Directory.Orgunits.Get
get(String customerId,
   String orgUnitPath)
Retrieves an organizational unit.



Directory.Orgunits.Insert
insert(String customerId,
      OrgUnit content)
Adds an organizational unit.



Directory.Orgunits.List
list(String customerId)
Retrieves a list of all organizational units for an account.



Directory.Orgunits.Patch
patch(String customerId,
     String orgUnitPath,
     OrgUnit content)
Updates an organizational unit.



Directory.Orgunits.Update
update(String customerId,
      String orgUnitPath,
      OrgUnit content)
Updates an organizational unit.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Orgunits
public Orgunits()









Method Detail





delete
public Directory.Orgunits.Delete delete(String customerId,
                                        String orgUnitPath)
                                 throws IOException
Removes an organizational unit.

 Create a request for the method "orgunits.delete".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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 (minus the leading `/`) or its unique ID.
Returns:
the request
Throws:
IOException








get
public Directory.Orgunits.Get get(String customerId,
                                  String orgUnitPath)
                           throws IOException
Retrieves an organizational unit.

 Create a request for the method "orgunits.get".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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 (minus the leading `/`) or its unique ID.
Returns:
the request
Throws:
IOException








insert
public Directory.Orgunits.Insert insert(String customerId,
                                        OrgUnit content)
                                 throws IOException
Adds an organizational unit.

 Create a request for the method "orgunits.insert".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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).
content - the OrgUnit
Returns:
the request
Throws:
IOException








list
public Directory.Orgunits.List list(String customerId)
                             throws IOException
Retrieves a list of all organizational units for an account.

 Create a request for the method "orgunits.list".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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).
Returns:
the request
Throws:
IOException








patch
public Directory.Orgunits.Patch patch(String customerId,
                                      String orgUnitPath,
                                      OrgUnit content)
                               throws IOException
Updates an organizational unit. This method supports [patch semantics](/admin-
 sdk/directory/v1/guides/performance#patch)

 Create a request for the method "orgunits.patch".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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 (minus the leading `/`) or its unique ID.
content - the OrgUnit
Returns:
the request
Throws:
IOException








update
public Directory.Orgunits.Update update(String customerId,
                                        String orgUnitPath,
                                        OrgUnit content)
                                 throws IOException
Updates an organizational unit.

 Create a request for the method "orgunits.update".

 This request holds the parameters needed by the admin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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 (minus the leading `/`) or its unique ID.
content - the OrgUnit
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Directory.Orgunits.Delete`
`class`	`Directory.Orgunits.Get`
`class`	`Directory.Orgunits.Insert`
`class`	`Directory.Orgunits.List`
`class`	`Directory.Orgunits.Patch`
`class`	`Directory.Orgunits.Update`

Modifier and Type	Method and Description
`Directory.Orgunits.Delete`	`delete(String customerId, String orgUnitPath)` Removes an organizational unit.
`Directory.Orgunits.Get`	`get(String customerId, String orgUnitPath)` Retrieves an organizational unit.
`Directory.Orgunits.Insert`	`insert(String customerId, OrgUnit content)` Adds an organizational unit.
`Directory.Orgunits.List`	`list(String customerId)` Retrieves a list of all organizational units for an account.
`Directory.Orgunits.Patch`	`patch(String customerId, String orgUnitPath, OrgUnit content)` Updates an organizational unit.
`Directory.Orgunits.Update`	`update(String customerId, String orgUnitPath, OrgUnit content)` Updates an organizational unit.