com.google.api.services.cloudidentity.v1

Class CloudIdentity.Groups.Lookup

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudIdentity.Groups

public class CloudIdentity.Groups.Lookup
extends CloudIdentityRequest<LookupGroupNameResponse>

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	Lookup() Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getGroupKeyId() The ID of the entity.
String	getGroupKeyNamespace() The namespace in which the entity exists.
CloudIdentity.Groups.Lookup	set(String parameterName, Object value)
CloudIdentity.Groups.Lookup	set$Xgafv(String $Xgafv) V1 error format.
CloudIdentity.Groups.Lookup	setAccessToken(String accessToken) OAuth access token.
CloudIdentity.Groups.Lookup	setAlt(String alt) Data format for response.
CloudIdentity.Groups.Lookup	setCallback(String callback) JSONP
CloudIdentity.Groups.Lookup	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudIdentity.Groups.Lookup	setGroupKeyId(String groupKeyId) The ID of the entity.
CloudIdentity.Groups.Lookup	setGroupKeyNamespace(String groupKeyNamespace) The namespace in which the entity exists.
CloudIdentity.Groups.Lookup	setKey(String key) API key.
CloudIdentity.Groups.Lookup	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudIdentity.Groups.Lookup	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudIdentity.Groups.Lookup	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudIdentity.Groups.Lookup	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudIdentity.Groups.Lookup	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

Lookup

protected Lookup()

Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`. Create a request for the method "groups.lookup". 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<LookupGroupNameResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public CloudIdentity.Groups.Lookup set$Xgafv(String $Xgafv)

Description copied from class: CloudIdentityRequest

V1 error format.

Overrides:

set$Xgafv in class CloudIdentityRequest<LookupGroupNameResponse>

setAccessToken

public CloudIdentity.Groups.Lookup setAccessToken(String accessToken)

Description copied from class: CloudIdentityRequest

OAuth access token.

Overrides:

setAccessToken in class CloudIdentityRequest<LookupGroupNameResponse>

setAlt

public CloudIdentity.Groups.Lookup setAlt(String alt)

Description copied from class: CloudIdentityRequest

Data format for response.

Overrides:

setAlt in class CloudIdentityRequest<LookupGroupNameResponse>

setCallback

public CloudIdentity.Groups.Lookup setCallback(String callback)

Description copied from class: CloudIdentityRequest

JSONP

Overrides:

setCallback in class CloudIdentityRequest<LookupGroupNameResponse>

setFields

public CloudIdentity.Groups.Lookup setFields(String fields)

Description copied from class: CloudIdentityRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudIdentityRequest<LookupGroupNameResponse>

setKey

public CloudIdentity.Groups.Lookup 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<LookupGroupNameResponse>

setOauthToken

public CloudIdentity.Groups.Lookup setOauthToken(String oauthToken)

Description copied from class: CloudIdentityRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudIdentityRequest<LookupGroupNameResponse>

setPrettyPrint

public CloudIdentity.Groups.Lookup setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudIdentityRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudIdentityRequest<LookupGroupNameResponse>

setQuotaUser

public CloudIdentity.Groups.Lookup 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<LookupGroupNameResponse>

setUploadType

public CloudIdentity.Groups.Lookup setUploadType(String uploadType)

Description copied from class: CloudIdentityRequest

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

Overrides:

setUploadType in class CloudIdentityRequest<LookupGroupNameResponse>

setUploadProtocol

public CloudIdentity.Groups.Lookup setUploadProtocol(String uploadProtocol)

Description copied from class: CloudIdentityRequest

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

Overrides:

setUploadProtocol in class CloudIdentityRequest<LookupGroupNameResponse>

getGroupKeyId

public String getGroupKeyId()

The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`.

setGroupKeyId

public CloudIdentity.Groups.Lookup setGroupKeyId(String groupKeyId)

The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. Email addresses need to adhere to [name guidelines for users and groups](https://support.google.com/a/answer/9193374). For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`.

getGroupKeyNamespace

public String getGroupKeyNamespace()

The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google- managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source}`.

setGroupKeyNamespace

public CloudIdentity.Groups.Lookup setGroupKeyNamespace(String groupKeyNamespace)

The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source}`.

set

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

Overrides:

set in class CloudIdentityRequest<LookupGroupNameResponse>