target.apidocs.com.google.api.services.directory.Directory.Groups.html Maven / Gradle / Ivy
Directory.Groups (Admin SDK API directory_v1-rev20220606-1.32.1)
com.google.api.services.directory
Class Directory.Groups
- java.lang.Object
-
- com.google.api.services.directory.Directory.Groups
-
-
Nested Class Summary
Nested Classes
Modifier and Type
Class and Description
class
Directory.Groups.Aliases
The "aliases" collection of methods.
class
Directory.Groups.Delete
class
Directory.Groups.Get
class
Directory.Groups.Insert
class
Directory.Groups.List
class
Directory.Groups.Patch
class
Directory.Groups.Update
-
Constructor Summary
Constructors
Constructor and Description
Groups()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Directory.Groups.Aliases
aliases()
An accessor for creating requests from the Aliases collection.
Directory.Groups.Delete
delete(String groupKey)
Deletes a group.
Directory.Groups.Get
get(String groupKey)
Retrieves a group's properties.
Directory.Groups.Insert
insert(Group content)
Creates a group.
Directory.Groups.List
list()
Retrieves all groups of a domain or of a user given a userKey (paginated).
Directory.Groups.Patch
patch(String groupKey,
Group content)
Updates a group's properties.
Directory.Groups.Update
update(String groupKey,
Group content)
Updates a group's properties.
-
-
Method Detail
-
delete
public Directory.Groups.Delete delete(String groupKey)
throws IOException
Deletes a group.
Create a request for the method "groups.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:
groupKey
- Identifies the group in the API request. The value can be the group's email address, group alias, or
the unique group ID.
- Returns:
- the request
- Throws:
IOException
-
get
public Directory.Groups.Get get(String groupKey)
throws IOException
Retrieves a group's properties.
Create a request for the method "groups.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:
groupKey
- Identifies the group in the API request. The value can be the group's email address, group alias, or
the unique group ID.
- Returns:
- the request
- Throws:
IOException
-
insert
public Directory.Groups.Insert insert(Group content)
throws IOException
Creates a group.
Create a request for the method "groups.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:
content
- the Group
- Returns:
- the request
- Throws:
IOException
-
list
public Directory.Groups.List list()
throws IOException
Retrieves all groups of a domain or of a user given a userKey (paginated).
Create a request for the method "groups.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.
- Returns:
- the request
- Throws:
IOException
-
patch
public Directory.Groups.Patch patch(String groupKey,
Group content)
throws IOException
Updates a group's properties. This method supports [patch semantics](/admin-
sdk/directory/v1/guides/performance#patch).
Create a request for the method "groups.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:
groupKey
- Identifies the group in the API request. The value can be the group's email address, group alias, or
the unique group ID.
content
- the Group
- Returns:
- the request
- Throws:
IOException
-
update
public Directory.Groups.Update update(String groupKey,
Group content)
throws IOException
Updates a group's properties.
Create a request for the method "groups.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:
groupKey
- Identifies the group in the API request. The value can be the group's email address, group alias, or
the unique group ID.
content
- the Group
- Returns:
- the request
- Throws:
IOException
-
aliases
public Directory.Groups.Aliases aliases()
An accessor for creating requests from the Aliases collection.
The typical use is:
Directory admin = new Directory(...);
Directory.Aliases.List request = admin.aliases().list(parameters ...)
- Returns:
- the resource collection
Copyright © 2011–2022 Google. All rights reserved.