com.google.api.services.gmail

Class Gmail.Users.Settings.Cse.Keypairs.Enable

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.gmail.GmailRequest<CseKeyPair>

com.google.api.services.gmail.Gmail.Users.Settings.Cse.Keypairs.Enable

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Gmail.Users.Settings.Cse.Keypairs

public class Gmail.Users.Settings.Cse.Keypairs.Enable
extends GmailRequest<CseKeyPair>

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	Enable(String userId, String keyPairId, EnableCseKeyPairRequest content) Turns on a client-side encryption key pair that was turned off.

Method Summary

Modifier and Type	Method and Description
String	getKeyPairId() The identifier of the key pair to turn on.
String	getUserId() The requester's primary email address.
Gmail.Users.Settings.Cse.Keypairs.Enable	set(String parameterName, Object value)
Gmail.Users.Settings.Cse.Keypairs.Enable	set$Xgafv(String $Xgafv) V1 error format.
Gmail.Users.Settings.Cse.Keypairs.Enable	setAccessToken(String accessToken) OAuth access token.
Gmail.Users.Settings.Cse.Keypairs.Enable	setAlt(String alt) Data format for response.
Gmail.Users.Settings.Cse.Keypairs.Enable	setCallback(String callback) JSONP
Gmail.Users.Settings.Cse.Keypairs.Enable	setFields(String fields) Selector specifying which fields to include in a partial response.
Gmail.Users.Settings.Cse.Keypairs.Enable	setKey(String key) API key.
Gmail.Users.Settings.Cse.Keypairs.Enable	setKeyPairId(String keyPairId) The identifier of the key pair to turn on.
Gmail.Users.Settings.Cse.Keypairs.Enable	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Gmail.Users.Settings.Cse.Keypairs.Enable	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Gmail.Users.Settings.Cse.Keypairs.Enable	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Gmail.Users.Settings.Cse.Keypairs.Enable	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Gmail.Users.Settings.Cse.Keypairs.Enable	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Gmail.Users.Settings.Cse.Keypairs.Enable	setUserId(String userId) The requester's primary email address.

Methods inherited from class com.google.api.services.gmail.GmailRequest

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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Enable

protected Enable(String userId,
                 String keyPairId,
                 EnableCseKeyPairRequest content)

Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities. For administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2S erviceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured. Create a request for the method "keypairs.enable". This request holds the parameters needed by the the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Gmail.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

userId - The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. [default: me]

keyPairId - The identifier of the key pair to turn on.

content - the EnableCseKeyPairRequest

Since:

1.13

Method Detail

set$Xgafv

public Gmail.Users.Settings.Cse.Keypairs.Enable set$Xgafv(String $Xgafv)

Description copied from class: GmailRequest

V1 error format.

Overrides:

set$Xgafv in class GmailRequest<CseKeyPair>

setAccessToken

public Gmail.Users.Settings.Cse.Keypairs.Enable setAccessToken(String accessToken)

Description copied from class: GmailRequest

OAuth access token.

Overrides:

setAccessToken in class GmailRequest<CseKeyPair>

setAlt

public Gmail.Users.Settings.Cse.Keypairs.Enable setAlt(String alt)

Description copied from class: GmailRequest

Data format for response.

Overrides:

setAlt in class GmailRequest<CseKeyPair>

setCallback

public Gmail.Users.Settings.Cse.Keypairs.Enable setCallback(String callback)

Description copied from class: GmailRequest

JSONP

Overrides:

setCallback in class GmailRequest<CseKeyPair>

setFields

public Gmail.Users.Settings.Cse.Keypairs.Enable setFields(String fields)

Description copied from class: GmailRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GmailRequest<CseKeyPair>

setKey

public Gmail.Users.Settings.Cse.Keypairs.Enable setKey(String key)

Description copied from class: GmailRequest

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 GmailRequest<CseKeyPair>

setOauthToken

public Gmail.Users.Settings.Cse.Keypairs.Enable setOauthToken(String oauthToken)

Description copied from class: GmailRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GmailRequest<CseKeyPair>

setPrettyPrint

public Gmail.Users.Settings.Cse.Keypairs.Enable setPrettyPrint(Boolean prettyPrint)

Description copied from class: GmailRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GmailRequest<CseKeyPair>

setQuotaUser

public Gmail.Users.Settings.Cse.Keypairs.Enable setQuotaUser(String quotaUser)

Description copied from class: GmailRequest

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 GmailRequest<CseKeyPair>

setUploadType

public Gmail.Users.Settings.Cse.Keypairs.Enable setUploadType(String uploadType)

Description copied from class: GmailRequest

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

Overrides:

setUploadType in class GmailRequest<CseKeyPair>

setUploadProtocol

public Gmail.Users.Settings.Cse.Keypairs.Enable setUploadProtocol(String uploadProtocol)

Description copied from class: GmailRequest

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

Overrides:

setUploadProtocol in class GmailRequest<CseKeyPair>

getUserId

public String getUserId()

The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. [default: me]

setUserId

public Gmail.Users.Settings.Cse.Keypairs.Enable setUserId(String userId)

The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

getKeyPairId

public String getKeyPairId()

The identifier of the key pair to turn on.

setKeyPairId

public Gmail.Users.Settings.Cse.Keypairs.Enable setKeyPairId(String keyPairId)

The identifier of the key pair to turn on.

set

public Gmail.Users.Settings.Cse.Keypairs.Enable set(String parameterName,
                                                    Object value)

Overrides:

set in class GmailRequest<CseKeyPair>