• Home
• com.google.apis
• google-api-services-cloudidentity
• v1-rev20230808-2.0.0
• source code
• CloudIdentity.Groups.Search.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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.Search



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>


com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>


com.google.api.services.cloudidentity.v1.CloudIdentityRequest<SearchGroupsResponse>


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

















All Implemented Interfaces:
Cloneable, Map<String,Object>


Enclosing class:
CloudIdentity.Groups




public class CloudIdentity.Groups.Search
extends CloudIdentityRequest<SearchGroupsResponse>











Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Field Summary




Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
USER_AGENT_SUFFIX








Constructor Summary

Constructors 

Modifier
Constructor and Description


protected 
Search()
Searches for `Group` resources matching a specified query.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead() 


com.google.api.client.http.HttpResponse
executeUsingHead() 


Integer
getPageSize()
The maximum number of results to return.



String
getPageToken()
The `next_page_token` value returned from a previous search request, if any.



String
getQuery()
Required.



String
getView()
The level of detail to be returned.



CloudIdentity.Groups.Search
set(String parameterName,
   Object value) 


CloudIdentity.Groups.Search
set$Xgafv(String $Xgafv)
V1 error format.



CloudIdentity.Groups.Search
setAccessToken(String accessToken)
OAuth access token.



CloudIdentity.Groups.Search
setAlt(String alt)
Data format for response.



CloudIdentity.Groups.Search
setCallback(String callback)
JSONP



CloudIdentity.Groups.Search
setFields(String fields)
Selector specifying which fields to include in a partial response.



CloudIdentity.Groups.Search
setKey(String key)
API key.



CloudIdentity.Groups.Search
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



CloudIdentity.Groups.Search
setPageSize(Integer pageSize)
The maximum number of results to return.



CloudIdentity.Groups.Search
setPageToken(String pageToken)
The `next_page_token` value returned from a previous search request, if any.



CloudIdentity.Groups.Search
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



CloudIdentity.Groups.Search
setQuery(String query)
Required.



CloudIdentity.Groups.Search
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



CloudIdentity.Groups.Search
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



CloudIdentity.Groups.Search
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.



CloudIdentity.Groups.Search
setView(String view)
The level of detail to be returned.







Methods inherited from class com.google.api.services.cloudidentity.v1.CloudIdentityRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders





Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue





Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream





Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





Search
protected Search()
Searches for `Group` resources matching a specified query.

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

 This request holds the parameters needed by the the cloudidentity server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
 
 CloudIdentity.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must
 be called to initialize this instance immediately after invoking the constructor. 

Since:
1.13










Method Detail





executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:
executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchGroupsResponse>
Throws:
IOException








buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchGroupsResponse>
Throws:
IOException








set$Xgafv
public CloudIdentity.Groups.Search set$Xgafv(String $Xgafv)
Description copied from class: CloudIdentityRequest
V1 error format.

Overrides:
set$Xgafv in class CloudIdentityRequest<SearchGroupsResponse>








setAccessToken
public CloudIdentity.Groups.Search setAccessToken(String accessToken)
Description copied from class: CloudIdentityRequest
OAuth access token.

Overrides:
setAccessToken in class CloudIdentityRequest<SearchGroupsResponse>








setAlt
public CloudIdentity.Groups.Search setAlt(String alt)
Description copied from class: CloudIdentityRequest
Data format for response.

Overrides:
setAlt in class CloudIdentityRequest<SearchGroupsResponse>








setCallback
public CloudIdentity.Groups.Search setCallback(String callback)
Description copied from class: CloudIdentityRequest
JSONP

Overrides:
setCallback in class CloudIdentityRequest<SearchGroupsResponse>








setFields
public CloudIdentity.Groups.Search setFields(String fields)
Description copied from class: CloudIdentityRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class CloudIdentityRequest<SearchGroupsResponse>








setKey
public CloudIdentity.Groups.Search setKey(String key)
Description copied from class: CloudIdentityRequest
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.

Overrides:
setKey in class CloudIdentityRequest<SearchGroupsResponse>








setOauthToken
public CloudIdentity.Groups.Search setOauthToken(String oauthToken)
Description copied from class: CloudIdentityRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class CloudIdentityRequest<SearchGroupsResponse>








setPrettyPrint
public CloudIdentity.Groups.Search setPrettyPrint(Boolean prettyPrint)
Description copied from class: CloudIdentityRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class CloudIdentityRequest<SearchGroupsResponse>








setQuotaUser
public CloudIdentity.Groups.Search setQuotaUser(String quotaUser)
Description copied from class: CloudIdentityRequest
Available to use for quota purposes for server-side applications. Can be any arbitrary string
 assigned to a user, but should not exceed 40 characters.

Overrides:
setQuotaUser in class CloudIdentityRequest<SearchGroupsResponse>








setUploadType
public CloudIdentity.Groups.Search setUploadType(String uploadType)
Description copied from class: CloudIdentityRequest
Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:
setUploadType in class CloudIdentityRequest<SearchGroupsResponse>








setUploadProtocol
public CloudIdentity.Groups.Search setUploadProtocol(String uploadProtocol)
Description copied from class: CloudIdentityRequest
Upload protocol for media (e.g. "raw", "multipart").

Overrides:
setUploadProtocol in class CloudIdentityRequest<SearchGroupsResponse>








getPageSize
public Integer getPageSize()
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`.







setPageSize
public CloudIdentity.Groups.Search setPageSize(Integer 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`.







getPageToken
public String getPageToken()
The `next_page_token` value returned from a previous search request, if any.







setPageToken
public CloudIdentity.Groups.Search setPageToken(String pageToken)
The `next_page_token` value returned from a previous search request, if any.







getQuery
public String getQuery()
Required. The search query. * Must be specified in [Common Expression
     Language](https://opensource.google/projects/cel). * 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 == 'abc.com'` * Can contain optional
     `startsWith/contains/equality` operators on `group_key`, e.g. `group_key.startsWith('dev')`,
     `group_key.contains('dev'), group_key == '[email protected]'` * Can contain optional
     `startsWith/contains/equality` operators on `display_name`, such as
     `display_name.startsWith('dev')` , `display_name.contains('dev')`, `display_name == 'dev'`







setQuery
public CloudIdentity.Groups.Search setQuery(String query)
Required. The search query. * Must be specified in [Common Expression
 Language](https://opensource.google/projects/cel). * 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
 == 'abc.com'` * Can contain optional `startsWith/contains/equality` operators on
 `group_key`, e.g. `group_key.startsWith('dev')`, `group_key.contains('dev'), group_key ==
 '[email protected]'` * Can contain optional `startsWith/contains/equality` operators on
 `display_name`, such as `display_name.startsWith('dev')` , `display_name.contains('dev')`,
 `display_name == 'dev'`







getView
public String getView()
The level of detail to be returned. If unspecified, defaults to `View.BASIC`.







setView
public CloudIdentity.Groups.Search setView(String view)
The level of detail to be returned. If unspecified, defaults to `View.BASIC`.







set
public CloudIdentity.Groups.Search set(String parameterName,
                                       Object value)

Overrides:
set in class CloudIdentityRequest<SearchGroupsResponse>














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