target.apidocs.com.google.api.services.cloudidentity.v1.CloudIdentity.Groups.html Maven / Gradle / Ivy

Go to download

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

The newest version!







CloudIdentity.Groups (Cloud Identity API v1-rev20241010-2.0.0)











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.cloudidentity.v1
Class CloudIdentity.Groups



java.lang.Object


com.google.api.services.cloudidentity.v1.CloudIdentity.Groups







Enclosing class:
CloudIdentity




public class CloudIdentity.Groups
extends Object
The "groups" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
CloudIdentity.Groups.Create 


class 
CloudIdentity.Groups.Delete 


class 
CloudIdentity.Groups.Get 


class 
CloudIdentity.Groups.GetSecuritySettings 


class 
CloudIdentity.Groups.List 


class 
CloudIdentity.Groups.Lookup 


class 
CloudIdentity.Groups.Memberships
The "memberships" collection of methods.



class 
CloudIdentity.Groups.Patch 


class 
CloudIdentity.Groups.Search 


class 
CloudIdentity.Groups.UpdateSecuritySettings 









Constructor Summary

Constructors 

Constructor and Description


Groups() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CloudIdentity.Groups.Create
create(Group content)
Creates a Group.



CloudIdentity.Groups.Delete
delete(String name)
Deletes a `Group`.



CloudIdentity.Groups.Get
get(String name)
Retrieves a `Group`.



CloudIdentity.Groups.GetSecuritySettings
getSecuritySettings(String name)
Get Security Settings

 Create a request for the method "groups.getSecuritySettings".



CloudIdentity.Groups.List
list()
Lists the `Group` resources under a customer or namespace.



CloudIdentity.Groups.Lookup
lookup()
Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by
 its `EntityKey`.



CloudIdentity.Groups.Memberships
memberships()
An accessor for creating requests from the Memberships collection.



CloudIdentity.Groups.Patch
patch(String name,
     Group content)
Updates a `Group`.



CloudIdentity.Groups.Search
search()
Searches for `Group` resources matching a specified query.



CloudIdentity.Groups.UpdateSecuritySettings
updateSecuritySettings(String name,
                      SecuritySettings content)
Update Security Settings

 Create a request for the method "groups.updateSecuritySettings".







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














Constructor Detail





Groups
public Groups()









Method Detail





create
public CloudIdentity.Groups.Create create(Group content)
                                   throws IOException
Creates a Group.

 Create a request for the method "groups.create".

 This request holds the parameters needed by the cloudidentity 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








delete
public CloudIdentity.Groups.Delete delete(String name)
                                   throws IOException
Deletes a `Group`.

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

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

Parameters:
name - Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to
        retrieve. Must be of the form `groups/{group}`.
Returns:
the request
Throws:
IOException








get
public CloudIdentity.Groups.Get get(String name)
                             throws IOException
Retrieves a `Group`.

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

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

Parameters:
name - Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to
        retrieve. Must be of the form `groups/{group}`.
Returns:
the request
Throws:
IOException








getSecuritySettings
public CloudIdentity.Groups.GetSecuritySettings getSecuritySettings(String name)
                                                             throws IOException
Get Security Settings

 Create a request for the method "groups.getSecuritySettings".

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

Parameters:
name - Required. The security settings to retrieve. Format: `groups/{group_id}/securitySettings`
Returns:
the request
Throws:
IOException








list
public CloudIdentity.Groups.List list()
                               throws IOException
Lists the `Group` resources under a customer or namespace.

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

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

Returns:
the request
Throws:
IOException








lookup
public CloudIdentity.Groups.Lookup lookup()
                                   throws IOException
Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by
 its `EntityKey`.

 Create a request for the method "groups.lookup".

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

Returns:
the request
Throws:
IOException








patch
public CloudIdentity.Groups.Patch patch(String name,
                                        Group content)
                                 throws IOException
Updates a `Group`.

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

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

Parameters:
name - Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the
        `Group`. Shall be of the form `groups/{group}`.
content - the Group
Returns:
the request
Throws:
IOException








search
public CloudIdentity.Groups.Search search()
                                   throws IOException
Searches for `Group` resources matching a specified query.

 Create a request for the method "groups.search".

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

Returns:
the request
Throws:
IOException








updateSecuritySettings
public CloudIdentity.Groups.UpdateSecuritySettings updateSecuritySettings(String name,
                                                                          SecuritySettings content)
                                                                   throws IOException
Update Security Settings

 Create a request for the method "groups.updateSecuritySettings".

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

Parameters:
name - Output only. The resource name of the security settings. Shall be of the form
        `groups/{group_id}/securitySettings`.
content - the SecuritySettings
Returns:
the request
Throws:
IOException








memberships
public CloudIdentity.Groups.Memberships memberships()
An accessor for creating requests from the Memberships collection.

 The typical use is:
     CloudIdentity cloudidentity = new CloudIdentity(...);
    CloudIdentity.Memberships.List request = cloudidentity.memberships().list(parameters ...)
 

Returns:
the resource collection














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–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`CloudIdentity.Groups.Create`
`class`	`CloudIdentity.Groups.Delete`
`class`	`CloudIdentity.Groups.Get`
`class`	`CloudIdentity.Groups.GetSecuritySettings`
`class`	`CloudIdentity.Groups.List`
`class`	`CloudIdentity.Groups.Lookup`
`class`	`CloudIdentity.Groups.Memberships` The "memberships" collection of methods.
`class`	`CloudIdentity.Groups.Patch`
`class`	`CloudIdentity.Groups.Search`
`class`	`CloudIdentity.Groups.UpdateSecuritySettings`

Modifier and Type	Method and Description
`CloudIdentity.Groups.Create`	`create(Group content)` Creates a Group.
`CloudIdentity.Groups.Delete`	`delete(String name)` Deletes a `Group`.
`CloudIdentity.Groups.Get`	`get(String name)` Retrieves a `Group`.
`CloudIdentity.Groups.GetSecuritySettings`	`getSecuritySettings(String name)` Get Security Settings Create a request for the method "groups.getSecuritySettings".
`CloudIdentity.Groups.List`	`list()` Lists the `Group` resources under a customer or namespace.
`CloudIdentity.Groups.Lookup`	`lookup()` Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.
`CloudIdentity.Groups.Memberships`	`memberships()` An accessor for creating requests from the Memberships collection.
`CloudIdentity.Groups.Patch`	`patch(String name, Group content)` Updates a `Group`.
`CloudIdentity.Groups.Search`	`search()` Searches for `Group` resources matching a specified query.
`CloudIdentity.Groups.UpdateSecuritySettings`	`updateSecuritySettings(String name, SecuritySettings content)` Update Security Settings Create a request for the method "groups.updateSecuritySettings".