com.google.api.services.cloudidentity.v1

Class CloudIdentity.Groups.Memberships.SearchTransitiveGroups

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudIdentity.Groups.Memberships

public class CloudIdentity.Groups.Memberships.SearchTransitiveGroups
extends CloudIdentityRequest<SearchTransitiveGroupsResponse>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SearchTransitiveGroups(String parent) Search transitive groups of a member.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
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.SearchTransitiveGroups	set(String parameterName, Object value)
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	set$Xgafv(String $Xgafv) V1 error format.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setAccessToken(String accessToken) OAuth access token.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setAlt(String alt) Data format for response.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setCallback(String callback) JSONP
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setKey(String key) API key.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setPageSize(Integer pageSize) The default page size is 200 (max 1000).
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setPageToken(String pageToken) The next_page_token value returned from a previous list request, if any.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setParent(String parent) [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setQuery(String query) Required.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudIdentity.Groups.Memberships.SearchTransitiveGroups	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

SearchTransitiveGroups

protected SearchTransitiveGroups(String parent)

Search transitive groups of a member. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups. Create a request for the method "memberships.searchTransitiveGroups". 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.

SearchTransitiveGroups#initialize(com.google.api.client.googleapis .services.AbstractGoogleClientRequest) 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}`, where `group` 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<SearchTransitiveGroupsResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchTransitiveGroupsResponse>

Throws:

IOException

set$Xgafv

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups set$Xgafv(String $Xgafv)

Description copied from class: CloudIdentityRequest

V1 error format.

Overrides:

set$Xgafv in class CloudIdentityRequest<SearchTransitiveGroupsResponse>

setAccessToken

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups setAccessToken(String accessToken)

Description copied from class: CloudIdentityRequest

OAuth access token.

Overrides:

setAccessToken in class CloudIdentityRequest<SearchTransitiveGroupsResponse>

setAlt

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups setAlt(String alt)

Description copied from class: CloudIdentityRequest

Data format for response.

Overrides:

setAlt in class CloudIdentityRequest<SearchTransitiveGroupsResponse>

setCallback

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups setCallback(String callback)

Description copied from class: CloudIdentityRequest

JSONP

Overrides:

setCallback in class CloudIdentityRequest<SearchTransitiveGroupsResponse>

setFields

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups setFields(String fields)

Description copied from class: CloudIdentityRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudIdentityRequest<SearchTransitiveGroupsResponse>

setKey

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups 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<SearchTransitiveGroupsResponse>

setOauthToken

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups setOauthToken(String oauthToken)

Description copied from class: CloudIdentityRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudIdentityRequest<SearchTransitiveGroupsResponse>

setPrettyPrint

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudIdentityRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudIdentityRequest<SearchTransitiveGroupsResponse>

setQuotaUser

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups 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<SearchTransitiveGroupsResponse>

setUploadType

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups setUploadType(String uploadType)

Description copied from class: CloudIdentityRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class CloudIdentityRequest<SearchTransitiveGroupsResponse>

setUploadProtocol

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups setUploadProtocol(String uploadProtocol)

Description copied from class: CloudIdentityRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class CloudIdentityRequest<SearchTransitiveGroupsResponse>

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}`, where `group` is always '-' as this API will [ search across all groups for a given member. [

setParent

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups setParent(String parent)

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

getPageSize

public Integer getPageSize()

The default page size is 200 (max 1000).

setPageSize

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups 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.SearchTransitiveGroups 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). This is a `required` field. 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' && in labels` Query may optionally contain equality operators on the parent of the group restricting the search within a particular customer, e.g. `parent == 'customers/{customer_id}'`. The `customer_id` must begin with "C" (for example, 'C046psxkn'). This filtering is only supported for Admins with groups read permissons on the input customer. Example query: `member_key_id == 'member_key_id_value' && in labels && parent == 'customers/C046psxkn'`

setQuery

public CloudIdentity.Groups.Memberships.SearchTransitiveGroups setQuery(String query)

Required. A CEL expression that MUST include member specification AND label(s). This is a `required` field. 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' && in labels` Query may optionally contain equality operators on the parent of the group restricting the search within a particular customer, e.g. `parent == 'customers/{customer_id}'`. The `customer_id` must begin with "C" (for example, 'C046psxkn'). This filtering is only supported for Admins with groups read permissons on the input customer. Example query: `member_key_id == 'member_key_id_value' && in labels && parent == 'customers/C046psxkn'`

set

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

Overrides:

set in class CloudIdentityRequest<SearchTransitiveGroupsResponse>