target.apidocs.com.google.api.services.cloudidentity.v1.CloudIdentity.Groups.Memberships.CheckTransitiveMembership.html Maven / Gradle / Ivy
The newest version!
CloudIdentity.Groups.Memberships.CheckTransitiveMembership (Cloud Identity API v1-rev20241010-2.0.0)
com.google.api.services.cloudidentity.v1
Class CloudIdentity.Groups.Memberships.CheckTransitiveMembership
- 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<CheckTransitiveMembershipResponse>
-
- com.google.api.services.cloudidentity.v1.CloudIdentity.Groups.Memberships.CheckTransitiveMembership
-
- Enclosing class:
- CloudIdentity.Groups.Memberships
public class CloudIdentity.Groups.Memberships.CheckTransitiveMembership
extends CloudIdentityRequest<CheckTransitiveMembershipResponse>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected CheckTransitiveMembership(String parent)
Check a potential member for membership in a group.
-
Method Summary
-
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
-
CheckTransitiveMembership
protected CheckTransitiveMembership(String parent)
Check a potential member for membership in a group. **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 member has membership to a group as
long as there is a single viewable transitive membership between the group and the member. The
actor must have view permissions to at least one transitive membership between the member and
group.
Create a request for the method "memberships.checkTransitiveMembership".
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. CheckTransitiveMembership#initialize(com.google.api.client.googlea
pis.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 check the
transitive membership in. Format: `groups/{group}`, where `group` is the unique id
assigned to the Group to which the Membership belongs to.- 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<CheckTransitiveMembershipResponse>- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CheckTransitiveMembershipResponse>- Throws:
IOException
-
set$Xgafv
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership set$Xgafv(String $Xgafv)
Description copied from class: CloudIdentityRequest
V1 error format.
- Overrides:
set$Xgafv in class CloudIdentityRequest<CheckTransitiveMembershipResponse>
-
setAccessToken
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership setAccessToken(String accessToken)
Description copied from class: CloudIdentityRequest
OAuth access token.
- Overrides:
setAccessToken in class CloudIdentityRequest<CheckTransitiveMembershipResponse>
-
setAlt
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership setAlt(String alt)
Description copied from class: CloudIdentityRequest
Data format for response.
- Overrides:
setAlt in class CloudIdentityRequest<CheckTransitiveMembershipResponse>
-
setCallback
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership setCallback(String callback)
Description copied from class: CloudIdentityRequest
JSONP
- Overrides:
setCallback in class CloudIdentityRequest<CheckTransitiveMembershipResponse>
-
setFields
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership setFields(String fields)
Description copied from class: CloudIdentityRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class CloudIdentityRequest<CheckTransitiveMembershipResponse>
-
setKey
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership 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<CheckTransitiveMembershipResponse>
-
setOauthToken
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership setOauthToken(String oauthToken)
Description copied from class: CloudIdentityRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class CloudIdentityRequest<CheckTransitiveMembershipResponse>
-
setPrettyPrint
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership setPrettyPrint(Boolean prettyPrint)
Description copied from class: CloudIdentityRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class CloudIdentityRequest<CheckTransitiveMembershipResponse>
-
setQuotaUser
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership 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<CheckTransitiveMembershipResponse>
-
setUploadType
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership setUploadType(String uploadType)
Description copied from class: CloudIdentityRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class CloudIdentityRequest<CheckTransitiveMembershipResponse>
-
setUploadProtocol
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership setUploadProtocol(String uploadProtocol)
Description copied from class: CloudIdentityRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class CloudIdentityRequest<CheckTransitiveMembershipResponse>
-
getParent
public String getParent()
[ Resource name](https://cloud.google.com/apis/design/resource_names) of the group to check the
[ transitive membership in. Format: `groups/{group}`, where `group` is the unique id assigned to the
[ Group to which the Membership belongs to.
[
-
setParent
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership setParent(String parent)
[Resource name](https://cloud.google.com/apis/design/resource_names) of the group to
check the transitive membership in. Format: `groups/{group}`, where `group` is the unique
id assigned to the Group to which the Membership belongs to.
-
getQuery
public String getQuery()
Required. A CEL expression that MUST include member specification. This is a `required` field.
Certain 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'`
-
setQuery
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership setQuery(String query)
Required. A CEL expression that MUST include member specification. This is a `required`
field. Certain 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'`
-
set
public CloudIdentity.Groups.Memberships.CheckTransitiveMembership set(String parameterName,
Object value)
- Overrides:
set in class CloudIdentityRequest<CheckTransitiveMembershipResponse>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy