• Home
• com.google.apis
• google-api-services-cloudidentity
• v1-rev20230808-2.0.0
• source code
• CloudIdentity.Groups.Memberships.SearchDirectGroups.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.Memberships.SearchDirectGroups.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.Memberships.SearchDirectGroups



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<SearchDirectGroupsResponse>


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

















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


Enclosing class:
CloudIdentity.Groups.Memberships




public class CloudIdentity.Groups.Memberships.SearchDirectGroups
extends CloudIdentityRequest<SearchDirectGroupsResponse>











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 
SearchDirectGroups(String parent)
Searches direct groups of a member.










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() 


String
getOrderBy()
The ordering of membership relation for the display name or email in the response.



Integer
getPageSize()
The default page size is 200 (max 1000).



String
getPageToken()
The next_page_token value returned from a previous list request, if any



String
getParent()
[ Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search
      [ transitive memberships in.



String
getQuery()
Required.



CloudIdentity.Groups.Memberships.SearchDirectGroups
set(String parameterName,
   Object value) 


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



CloudIdentity.Groups.Memberships.SearchDirectGroups
setAccessToken(String accessToken)
OAuth access token.



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



CloudIdentity.Groups.Memberships.SearchDirectGroups
setCallback(String callback)
JSONP



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



CloudIdentity.Groups.Memberships.SearchDirectGroups
setKey(String key)
API key.



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



CloudIdentity.Groups.Memberships.SearchDirectGroups
setOrderBy(String orderBy)
The ordering of membership relation for the display name or email in the response.



CloudIdentity.Groups.Memberships.SearchDirectGroups
setPageSize(Integer pageSize)
The default page size is 200 (max 1000).



CloudIdentity.Groups.Memberships.SearchDirectGroups
setPageToken(String pageToken)
The next_page_token value returned from a previous list request, if any



CloudIdentity.Groups.Memberships.SearchDirectGroups
setParent(String parent)
[Resource name](https://cloud.google.com/apis/design/resource_names) of the group to
 search transitive memberships in.



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



CloudIdentity.Groups.Memberships.SearchDirectGroups
setQuery(String query)
Required.



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



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



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







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





SearchDirectGroups
protected SearchDirectGroups(String parent)
Searches direct groups of a member.

 Create a request for the method "memberships.searchDirectGroups".

 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. 
 SearchDirectGroups#initialize(com.google.api.client.googleapis.services.A
 bstractGoogleClientRequest) must be called to initialize this instance immediately after
 invoking the constructor. 

Parameters:
parent - [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search
        transitive memberships in. Format: groups/{group_id}, where group_id is always '-' as this
        API will search across all groups for a given member.
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<SearchDirectGroupsResponse>
Throws:
IOException








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

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








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

Overrides:
set$Xgafv in class CloudIdentityRequest<SearchDirectGroupsResponse>








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

Overrides:
setAccessToken in class CloudIdentityRequest<SearchDirectGroupsResponse>








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

Overrides:
setAlt in class CloudIdentityRequest<SearchDirectGroupsResponse>








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

Overrides:
setCallback in class CloudIdentityRequest<SearchDirectGroupsResponse>








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

Overrides:
setFields in class CloudIdentityRequest<SearchDirectGroupsResponse>








setKey
public CloudIdentity.Groups.Memberships.SearchDirectGroups 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<SearchDirectGroupsResponse>








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

Overrides:
setOauthToken in class CloudIdentityRequest<SearchDirectGroupsResponse>








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

Overrides:
setPrettyPrint in class CloudIdentityRequest<SearchDirectGroupsResponse>








setQuotaUser
public CloudIdentity.Groups.Memberships.SearchDirectGroups 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<SearchDirectGroupsResponse>








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

Overrides:
setUploadType in class CloudIdentityRequest<SearchDirectGroupsResponse>








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

Overrides:
setUploadProtocol in class CloudIdentityRequest<SearchDirectGroupsResponse>








getParent
public String getParent()
[ Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search
      [ transitive memberships in. Format: groups/{group_id}, where group_id is always '-' as this API
      [ will search across all groups for a given member.
      [







setParent
public CloudIdentity.Groups.Memberships.SearchDirectGroups setParent(String parent)
[Resource name](https://cloud.google.com/apis/design/resource_names) of the group to
 search transitive memberships in. Format: groups/{group_id}, where group_id is always '-'
 as this API will search across all groups for a given member.







getOrderBy
public String getOrderBy()
The ordering of membership relation for the display name or email in the response. The syntax for
       this field can be found at https://cloud.google.com/apis/design/design_patterns#sorting_order.
       Example: Sort by the ascending display name: order_by="group_name" or order_by="group_name asc".
       Sort by the descending display name: order_by="group_name desc". Sort by the ascending group key:
       order_by="group_key" or order_by="group_key asc". Sort by the descending group key:
       order_by="group_key desc".







setOrderBy
public CloudIdentity.Groups.Memberships.SearchDirectGroups setOrderBy(String orderBy)
The ordering of membership relation for the display name or email in the response. The
 syntax for this field can be found at
 https://cloud.google.com/apis/design/design_patterns#sorting_order. Example: Sort by the
 ascending display name: order_by="group_name" or order_by="group_name asc". Sort by the
 descending display name: order_by="group_name desc". Sort by the ascending group key:
 order_by="group_key" or order_by="group_key asc". Sort by the descending group key:
 order_by="group_key desc".







getPageSize
public Integer getPageSize()
The default page size is 200 (max 1000).







setPageSize
public CloudIdentity.Groups.Memberships.SearchDirectGroups setPageSize(Integer pageSize)
The default page size is 200 (max 1000).







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







setPageToken
public CloudIdentity.Groups.Memberships.SearchDirectGroups setPageToken(String pageToken)
The next_page_token value returned from a previous list request, if any







getQuery
public String getQuery()
Required. A CEL expression that MUST include member specification AND label(s). Users can search on
       label attributes of groups. CONTAINS match ('in') is supported on labels. Identity-mapped groups
       are uniquely identified by both a `member_key_id` and a `member_key_namespace`, which requires an
       additional query input: `member_key_namespace`. Example query: `member_key_id ==
       'member_key_id_value' && 'label_value' in labels`







setQuery
public CloudIdentity.Groups.Memberships.SearchDirectGroups setQuery(String query)
Required. A CEL expression that MUST include member specification AND label(s). Users can
 search on label attributes of groups. CONTAINS match ('in') is supported on labels.
 Identity-mapped groups are uniquely identified by both a `member_key_id` and a
 `member_key_namespace`, which requires an additional query input: `member_key_namespace`.
 Example query: `member_key_id == 'member_key_id_value' && 'label_value' in labels`







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

Overrides:
set in class CloudIdentityRequest<SearchDirectGroupsResponse>














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.