Class GroupsResource.SearchRequest

Searches for Group resources matching a specified query.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<SearchGroupsResponse>
CloudIdentityBaseServiceRequest<SearchGroupsResponse>
GroupsResource.SearchRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudIdentity.v1
Assembly: Google.Apis.CloudIdentity.v1.dll
Syntax
public class GroupsResource.SearchRequest : CloudIdentityBaseServiceRequest<SearchGroupsResponse>, IClientServiceRequest<SearchGroupsResponse>, IClientServiceRequest

Constructors

SearchRequest(IClientService)

Constructs a new Search request.

Declaration
public SearchRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageSize

The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a next_page_token. If unspecified, defaults to 200 for GroupView.BASIC and 50 for GroupView.FULL. Must not be greater than 1000 for GroupView.BASIC or 500 for GroupView.FULL.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

The next_page_token value returned from a previous search request, if any.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Query

Required. The search query. * Must be specified in Common Expression Language. * Must contain equality operators on the parent, e.g. parent == 'customers/{customer_id}'. The customer_id must begin with "C" (for example, 'C046psxkn'). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793) * Can contain optional inclusion operators on labels such as 'cloudidentity.googleapis.com/groups.discussion_forum' in labels). * Can contain an optional equality operator on domain_name. e.g. domain_name == 'examplepetstore.com' * Can contain optional startsWith/contains/equality operators on group_key, e.g. group_key.startsWith('dev'), group_key.contains('dev'), group_key == 'dev@examplepetstore.com'

  • Can contain optional startsWith/contains/equality operators on display_name, such as display_name.startsWith('dev') , display_name.contains('dev'), display_name == 'dev'
Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

View

The level of detail to be returned. If unspecified, defaults to View.BASIC.

Declaration
[RequestParameter("view", RequestParameterType.Query)]
public virtual GroupsResource.SearchRequest.ViewEnum? View { get; set; }
Property Value
Type Description
GroupsResource.SearchRequest.ViewEnum?

Methods

InitParameters()

Initializes Search parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements