target.apidocs.com.google.api.services.gmail.Gmail.Users.Settings.Cse.Keypairs.Obliterate.html Maven / Gradle / Ivy
Gmail.Users.Settings.Cse.Keypairs.Obliterate (Gmail API v1-rev20240422-2.0.0)
com.google.api.services.gmail
Class Gmail.Users.Settings.Cse.Keypairs.Obliterate
- 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<Void>
-
- com.google.api.services.gmail.Gmail.Users.Settings.Cse.Keypairs.Obliterate
-
- Enclosing class:
- Gmail.Users.Settings.Cse.Keypairs
public class Gmail.Users.Settings.Cse.Keypairs.Obliterate
extends GmailRequest<Void>
-
-
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 Obliterate(String userId,
String keyPairId,
ObliterateCseKeyPairRequest content)
Deletes a client-side encryption key pair permanently and immediately.
-
Method Summary
-
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
-
Obliterate
protected Obliterate(String userId,
String keyPairId,
ObliterateCseKeyPairRequest content)
Deletes a client-side encryption key pair permanently and immediately. You can only permanently
delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use
the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted
by an obliterated key. Authenticated users and Google Workspace administrators lose access to
reading the encrypted messages.
Create a request for the method "keypairs.obliterate".
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 obliterate.content - the ObliterateCseKeyPairRequest- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Gmail.Users.Settings.Cse.Keypairs.Obliterate set$Xgafv(String $Xgafv)
Description copied from class: GmailRequest
V1 error format.
- Overrides:
set$Xgafv in class GmailRequest<Void>
-
setAccessToken
public Gmail.Users.Settings.Cse.Keypairs.Obliterate setAccessToken(String accessToken)
Description copied from class: GmailRequest
OAuth access token.
- Overrides:
setAccessToken in class GmailRequest<Void>
-
setAlt
public Gmail.Users.Settings.Cse.Keypairs.Obliterate setAlt(String alt)
Description copied from class: GmailRequest
Data format for response.
- Overrides:
setAlt in class GmailRequest<Void>
-
setCallback
public Gmail.Users.Settings.Cse.Keypairs.Obliterate setCallback(String callback)
Description copied from class: GmailRequest
JSONP
- Overrides:
setCallback in class GmailRequest<Void>
-
setFields
public Gmail.Users.Settings.Cse.Keypairs.Obliterate setFields(String fields)
Description copied from class: GmailRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class GmailRequest<Void>
-
setKey
public Gmail.Users.Settings.Cse.Keypairs.Obliterate 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<Void>
-
setOauthToken
public Gmail.Users.Settings.Cse.Keypairs.Obliterate setOauthToken(String oauthToken)
Description copied from class: GmailRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class GmailRequest<Void>
-
setPrettyPrint
public Gmail.Users.Settings.Cse.Keypairs.Obliterate setPrettyPrint(Boolean prettyPrint)
Description copied from class: GmailRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class GmailRequest<Void>
-
setQuotaUser
public Gmail.Users.Settings.Cse.Keypairs.Obliterate 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<Void>
-
setUploadType
public Gmail.Users.Settings.Cse.Keypairs.Obliterate setUploadType(String uploadType)
Description copied from class: GmailRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class GmailRequest<Void>
-
setUploadProtocol
public Gmail.Users.Settings.Cse.Keypairs.Obliterate setUploadProtocol(String uploadProtocol)
Description copied from class: GmailRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class GmailRequest<Void>
-
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.Obliterate 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 obliterate.
-
setKeyPairId
public Gmail.Users.Settings.Cse.Keypairs.Obliterate setKeyPairId(String keyPairId)
The identifier of the key pair to obliterate.
-
set
public Gmail.Users.Settings.Cse.Keypairs.Obliterate set(String parameterName,
Object value)
- Overrides:
set in class GmailRequest<Void>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy