com.google.api.services.gmail.model

Class CseIdentity

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.gmail.model.CseIdentity

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CseIdentity
extends com.google.api.client.json.GenericJson

The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages. 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/OAuth2ServiceAccount# 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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Gmail API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
CseIdentity()

Method Summary

Modifier and Type	Method and Description
CseIdentity	clone()
String	getEmailAddress() The email address for the sending identity.
String	getPrimaryKeyPairId() If a key pair is associated, the ID of the key pair, CseKeyPair.
SignAndEncryptKeyPairs	getSignAndEncryptKeyPairs() The configuration of a CSE identity that uses different key pairs for signing and encryption.
CseIdentity	set(String fieldName, Object value)
CseIdentity	setEmailAddress(String emailAddress) The email address for the sending identity.
CseIdentity	setPrimaryKeyPairId(String primaryKeyPairId) If a key pair is associated, the ID of the key pair, CseKeyPair.
CseIdentity	setSignAndEncryptKeyPairs(SignAndEncryptKeyPairs signAndEncryptKeyPairs) The configuration of a CSE identity that uses different key pairs for signing and encryption.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

CseIdentity

public CseIdentity()

Method Detail

getEmailAddress

public String getEmailAddress()

The email address for the sending identity. The email address must be the primary email address of the authenticated user.

Returns:

value or null for none

setEmailAddress

public CseIdentity setEmailAddress(String emailAddress)

The email address for the sending identity. The email address must be the primary email address of the authenticated user.

Parameters:

emailAddress - emailAddress or null for none

getPrimaryKeyPairId

public String getPrimaryKeyPairId()

If a key pair is associated, the ID of the key pair, CseKeyPair.

Returns:

value or null for none

setPrimaryKeyPairId

public CseIdentity setPrimaryKeyPairId(String primaryKeyPairId)

If a key pair is associated, the ID of the key pair, CseKeyPair.

Parameters:

primaryKeyPairId - primaryKeyPairId or null for none

getSignAndEncryptKeyPairs

public SignAndEncryptKeyPairs getSignAndEncryptKeyPairs()

The configuration of a CSE identity that uses different key pairs for signing and encryption.

Returns:

value or null for none

setSignAndEncryptKeyPairs

public CseIdentity setSignAndEncryptKeyPairs(SignAndEncryptKeyPairs signAndEncryptKeyPairs)

The configuration of a CSE identity that uses different key pairs for signing and encryption.

Parameters:

signAndEncryptKeyPairs - signAndEncryptKeyPairs or null for none

set

public CseIdentity set(String fieldName,
                       Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public CseIdentity clone()

Overrides:

clone in class com.google.api.client.json.GenericJson