admin  directory_v1
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest Class Reference

Retrieve all groups of a domain or of a user given a userKey (paginated) More...

Inheritance diagram for Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest:
Google.Apis.Admin.Directory.directory_v1.DirectoryBaseServiceRequest< Google.Apis.Admin.Directory.directory_v1.Data.Groups >

Public Types

enum  OrderByEnum { OrderByEnum.Email }
 Column to use for sorting results More...
 
enum  SortOrderEnum { SortOrderEnum.ASCENDING, SortOrderEnum.DESCENDING }
 Whether to return results in ascending or descending order. Only of use when orderBy is also used More...
 

Public Member Functions

 ListRequest (Google.Apis.Services.IClientService service)
 Constructs a new List request. More...
 

Protected Member Functions

override void InitParameters ()
 Initializes List parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.Admin.Directory.directory_v1.DirectoryBaseServiceRequest< Google.Apis.Admin.Directory.directory_v1.Data.Groups >
 DirectoryBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new DirectoryBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes Directory parameter list. More...
 

Properties

virtual string Customer [get, set]
 Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain. More...
 
virtual string Domain [get, set]
 Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead. More...
 
virtual System.Nullable< int > MaxResults [get, set]
 Maximum number of results to return. Max allowed value is 200. More...
 
virtual System.Nullable< OrderByEnumOrderBy [get, set]
 Column to use for sorting results More...
 
virtual string PageToken [get, set]
 Token to specify next page in the list More...
 
virtual string Query [get, set]
 Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-groups More...
 
virtual System.Nullable< SortOrderEnumSortOrder [get, set]
 Whether to return results in ascending or descending order. Only of use when orderBy is also used More...
 
virtual string UserKey [get, set]
 Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.Admin.Directory.directory_v1.DirectoryBaseServiceRequest< Google.Apis.Admin.Directory.directory_v1.Data.Groups >
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for the response. More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 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. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...
 
virtual string UserIp [get, set]
 Deprecated. Please use quotaUser instead. More...
 

Detailed Description

Retrieve all groups of a domain or of a user given a userKey (paginated)

Member Enumeration Documentation

◆ OrderByEnum

Column to use for sorting results

Enumerator
Email 

Email of the group.

◆ SortOrderEnum

Whether to return results in ascending or descending order. Only of use when orderBy is also used

Enumerator
ASCENDING 

Ascending order.

DESCENDING 

Descending order.

Constructor & Destructor Documentation

◆ ListRequest()

Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.ListRequest ( Google.Apis.Services.IClientService  service)
inline

Constructs a new List request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.InitParameters ( )
inlineprotected

Initializes List parameter list.

Property Documentation

◆ Customer

virtual string Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.Customer
getset

Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.

◆ Domain

virtual string Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.Domain
getset

Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.

◆ HttpMethod

override string Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.HttpMethod
get

summary>Gets the REST path.

◆ MaxResults

virtual System.Nullable<int> Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.MaxResults
getset

Maximum number of results to return. Max allowed value is 200.

[default: 200] [minimum: 1]

◆ MethodName

override string Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.MethodName
get

summary>Gets the HTTP method.

◆ OrderBy

virtual System.Nullable<OrderByEnum> Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.OrderBy
getset

Column to use for sorting results

◆ PageToken

virtual string Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.PageToken
getset

Token to specify next page in the list

◆ Query

virtual string Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.Query
getset

Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-groups

◆ SortOrder

virtual System.Nullable<SortOrderEnum> Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.SortOrder
getset

Whether to return results in ascending or descending order. Only of use when orderBy is also used

◆ UserKey

virtual string Google.Apis.Admin.Directory.directory_v1.GroupsResource.ListRequest.UserKey
getset

Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object.

summary>Gets the method name.


The documentation for this class was generated from the following file: