target.apidocs.com.google.api.services.cloudidentity.v1.CloudIdentity.Customers.Userinvitations.IsInvitableUser.html Maven / Gradle / Ivy
The newest version!
CloudIdentity.Customers.Userinvitations.IsInvitableUser (Cloud Identity API v1-rev20241010-2.0.0)
com.google.api.services.cloudidentity.v1
Class CloudIdentity.Customers.Userinvitations.IsInvitableUser
- 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<IsInvitableUserResponse>
-
- com.google.api.services.cloudidentity.v1.CloudIdentity.Customers.Userinvitations.IsInvitableUser
-
- Enclosing class:
- CloudIdentity.Customers.Userinvitations
public class CloudIdentity.Customers.Userinvitations.IsInvitableUser
extends CloudIdentityRequest<IsInvitableUserResponse>
-
-
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 IsInvitableUser(String name)
Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged
account).
-
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
-
IsInvitableUser
protected IsInvitableUser(String name)
Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged
account). Eligibility is based on the following criteria: * the email address is a consumer
account and it's the primary email address of the account, and * the domain of the email
address matches an existing verified Google Workspace or Cloud Identity domain If both
conditions are met, the user is eligible. **Note:** This method is not supported for Workspace
Essentials customers.
Create a request for the method "userinvitations.isInvitableUser".
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. IsInvitableUser#initialize(com.google.api.client.googleapis.services.Abst
ractGoogleClientRequest) must be called to initialize this instance immediately after invoking
the constructor.
- Parameters:
name - Required. `UserInvitation` name in the format
`customers/{customer}/userinvitations/{user_email_address}`- 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<IsInvitableUserResponse>- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<IsInvitableUserResponse>- Throws:
IOException
-
set$Xgafv
public CloudIdentity.Customers.Userinvitations.IsInvitableUser set$Xgafv(String $Xgafv)
Description copied from class: CloudIdentityRequest
V1 error format.
- Overrides:
set$Xgafv in class CloudIdentityRequest<IsInvitableUserResponse>
-
setAccessToken
public CloudIdentity.Customers.Userinvitations.IsInvitableUser setAccessToken(String accessToken)
Description copied from class: CloudIdentityRequest
OAuth access token.
- Overrides:
setAccessToken in class CloudIdentityRequest<IsInvitableUserResponse>
-
setAlt
public CloudIdentity.Customers.Userinvitations.IsInvitableUser setAlt(String alt)
Description copied from class: CloudIdentityRequest
Data format for response.
- Overrides:
setAlt in class CloudIdentityRequest<IsInvitableUserResponse>
-
setCallback
public CloudIdentity.Customers.Userinvitations.IsInvitableUser setCallback(String callback)
Description copied from class: CloudIdentityRequest
JSONP
- Overrides:
setCallback in class CloudIdentityRequest<IsInvitableUserResponse>
-
setFields
public CloudIdentity.Customers.Userinvitations.IsInvitableUser setFields(String fields)
Description copied from class: CloudIdentityRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class CloudIdentityRequest<IsInvitableUserResponse>
-
setKey
public CloudIdentity.Customers.Userinvitations.IsInvitableUser 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<IsInvitableUserResponse>
-
setOauthToken
public CloudIdentity.Customers.Userinvitations.IsInvitableUser setOauthToken(String oauthToken)
Description copied from class: CloudIdentityRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class CloudIdentityRequest<IsInvitableUserResponse>
-
setPrettyPrint
public CloudIdentity.Customers.Userinvitations.IsInvitableUser setPrettyPrint(Boolean prettyPrint)
Description copied from class: CloudIdentityRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class CloudIdentityRequest<IsInvitableUserResponse>
-
setQuotaUser
public CloudIdentity.Customers.Userinvitations.IsInvitableUser 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<IsInvitableUserResponse>
-
setUploadType
public CloudIdentity.Customers.Userinvitations.IsInvitableUser setUploadType(String uploadType)
Description copied from class: CloudIdentityRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class CloudIdentityRequest<IsInvitableUserResponse>
-
setUploadProtocol
public CloudIdentity.Customers.Userinvitations.IsInvitableUser setUploadProtocol(String uploadProtocol)
Description copied from class: CloudIdentityRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class CloudIdentityRequest<IsInvitableUserResponse>
-
getName
public String getName()
Required. `UserInvitation` name in the format
`customers/{customer}/userinvitations/{user_email_address}`
-
setName
public CloudIdentity.Customers.Userinvitations.IsInvitableUser setName(String name)
Required. `UserInvitation` name in the format
`customers/{customer}/userinvitations/{user_email_address}`
-
set
public CloudIdentity.Customers.Userinvitations.IsInvitableUser set(String parameterName,
Object value)
- Overrides:
set in class CloudIdentityRequest<IsInvitableUserResponse>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy