target.apidocs.com.google.api.services.cloudidentity.v1.CloudIdentity.Groups.Memberships.GetMembershipGraph.html Maven / Gradle / Ivy
CloudIdentity.Groups.Memberships.GetMembershipGraph (Cloud Identity API v1-rev20230808-2.0.0)
com.google.api.services.cloudidentity.v1
Class CloudIdentity.Groups.Memberships.GetMembershipGraph
- 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<Operation>
-
- com.google.api.services.cloudidentity.v1.CloudIdentity.Groups.Memberships.GetMembershipGraph
-
- Enclosing class:
- CloudIdentity.Groups.Memberships
public class CloudIdentity.Groups.Memberships.GetMembershipGraph
extends CloudIdentityRequest<Operation>
-
-
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 GetMembershipGraph(String parent)
Get a membership graph of just a member or both a member and 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
-
GetMembershipGraph
protected GetMembershipGraph(String parent)
Get a membership graph of just a member or both a member and 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. Given a member, the
response will contain all membership paths from the member. Given both a group and a member,
the response will contain all membership paths between the group and the member.
Create a request for the method "memberships.getMembershipGraph".
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. GetMembershipGraph#initialize(com.google.api.client.googleapis.services.A
bstractGoogleClientRequest) must be called to initialize this instance immediately after
invoking the constructor.
- Parameters:
parent - Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to
search transitive memberships in. Format: `groups/{group}`, where `group` is the unique ID
assigned to the Group to which the Membership belongs to. group can be a wildcard
collection id "-". When a group is specified, the membership graph will be constrained to
paths between the member (defined in the query) and the parent. If a wildcard collection
is provided, all membership paths connected to the member will be returned.- 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<Operation>- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Operation>- Throws:
IOException
-
set$Xgafv
public CloudIdentity.Groups.Memberships.GetMembershipGraph set$Xgafv(String $Xgafv)
Description copied from class: CloudIdentityRequest
V1 error format.
- Overrides:
set$Xgafv in class CloudIdentityRequest<Operation>
-
setAccessToken
public CloudIdentity.Groups.Memberships.GetMembershipGraph setAccessToken(String accessToken)
Description copied from class: CloudIdentityRequest
OAuth access token.
- Overrides:
setAccessToken in class CloudIdentityRequest<Operation>
-
setAlt
public CloudIdentity.Groups.Memberships.GetMembershipGraph setAlt(String alt)
Description copied from class: CloudIdentityRequest
Data format for response.
- Overrides:
setAlt in class CloudIdentityRequest<Operation>
-
setCallback
public CloudIdentity.Groups.Memberships.GetMembershipGraph setCallback(String callback)
Description copied from class: CloudIdentityRequest
JSONP
- Overrides:
setCallback in class CloudIdentityRequest<Operation>
-
setFields
public CloudIdentity.Groups.Memberships.GetMembershipGraph setFields(String fields)
Description copied from class: CloudIdentityRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class CloudIdentityRequest<Operation>
-
setKey
public CloudIdentity.Groups.Memberships.GetMembershipGraph 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<Operation>
-
setOauthToken
public CloudIdentity.Groups.Memberships.GetMembershipGraph setOauthToken(String oauthToken)
Description copied from class: CloudIdentityRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class CloudIdentityRequest<Operation>
-
setPrettyPrint
public CloudIdentity.Groups.Memberships.GetMembershipGraph setPrettyPrint(Boolean prettyPrint)
Description copied from class: CloudIdentityRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class CloudIdentityRequest<Operation>
-
setQuotaUser
public CloudIdentity.Groups.Memberships.GetMembershipGraph 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<Operation>
-
setUploadType
public CloudIdentity.Groups.Memberships.GetMembershipGraph setUploadType(String uploadType)
Description copied from class: CloudIdentityRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class CloudIdentityRequest<Operation>
-
setUploadProtocol
public CloudIdentity.Groups.Memberships.GetMembershipGraph setUploadProtocol(String uploadProtocol)
Description copied from class: CloudIdentityRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class CloudIdentityRequest<Operation>
-
getParent
public String getParent()
Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to
search transitive memberships in. Format: `groups/{group}`, where `group` is the unique ID assigned
to the Group to which the Membership belongs to. group can be a wildcard collection id "-". When a
group is specified, the membership graph will be constrained to paths between the member (defined
in the query) and the parent. If a wildcard collection is provided, all membership paths connected
to the member will be returned.
-
setParent
public CloudIdentity.Groups.Memberships.GetMembershipGraph setParent(String parent)
Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
group to search transitive memberships in. Format: `groups/{group}`, where `group` is the
unique ID assigned to the Group to which the Membership belongs to. group can be a
wildcard collection id "-". When a group is specified, the membership graph will be
constrained to paths between the member (defined in the query) and the parent. If a
wildcard collection is provided, all membership paths connected to the member will be
returned.
-
getQuery
public String getQuery()
Required. A CEL expression that MUST include member specification AND label(s). 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' && in labels`
-
setQuery
public CloudIdentity.Groups.Memberships.GetMembershipGraph setQuery(String query)
Required. A CEL expression that MUST include member specification AND label(s). 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' && in labels`
-
set
public CloudIdentity.Groups.Memberships.GetMembershipGraph set(String parameterName,
Object value)
- Overrides:
set in class CloudIdentityRequest<Operation>
Copyright © 2011–2023 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy