com.google.api.services.gmail.model

Class CseKeyPair

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME 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
CseKeyPair()

Method Summary

Modifier and Type	Method and Description
CseKeyPair	clone()
String	getDisableTime() Output only.
String	getEnablementState() Output only.
String	getKeyPairId() Output only.
String	getPem() Output only.
String	getPkcs7() Input only.
List<CsePrivateKeyMetadata>	getPrivateKeyMetadata() Metadata for instances of this key pair's private key.
List<String>	getSubjectEmailAddresses() Output only.
CseKeyPair	set(String fieldName, Object value)
CseKeyPair	setDisableTime(String disableTime) Output only.
CseKeyPair	setEnablementState(String enablementState) Output only.
CseKeyPair	setKeyPairId(String keyPairId) Output only.
CseKeyPair	setPem(String pem) Output only.
CseKeyPair	setPkcs7(String pkcs7) Input only.
CseKeyPair	setPrivateKeyMetadata(List<CsePrivateKeyMetadata> privateKeyMetadata) Metadata for instances of this key pair's private key.
CseKeyPair	setSubjectEmailAddresses(List<String> subjectEmailAddresses) Output only.

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

CseKeyPair

public CseKeyPair()

Method Detail

getDisableTime

public String getDisableTime()

Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.

Returns:

value or null for none

setDisableTime

public CseKeyPair setDisableTime(String disableTime)

Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.

Parameters:

disableTime - disableTime or null for none

getEnablementState

public String getEnablementState()

Output only. The current state of the key pair.

Returns:

value or null for none

setEnablementState

public CseKeyPair setEnablementState(String enablementState)

Output only. The current state of the key pair.

Parameters:

enablementState - enablementState or null for none

getKeyPairId

public String getKeyPairId()

Output only. The immutable ID for the client-side encryption S/MIME key pair.

Returns:

value or null for none

setKeyPairId

public CseKeyPair setKeyPairId(String keyPairId)

Output only. The immutable ID for the client-side encryption S/MIME key pair.

Parameters:

keyPairId - keyPairId or null for none

getPem

public String getPem()

Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.

Returns:

value or null for none

setPem

public CseKeyPair setPem(String pem)

Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.

Parameters:

pem - pem or null for none

getPkcs7

public String getPkcs7()

Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.

Returns:

value or null for none

setPkcs7

public CseKeyPair setPkcs7(String pkcs7)

Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.

Parameters:

pkcs7 - pkcs7 or null for none

getPrivateKeyMetadata

public List<CsePrivateKeyMetadata> getPrivateKeyMetadata()

Metadata for instances of this key pair's private key.

Returns:

value or null for none

setPrivateKeyMetadata

public CseKeyPair setPrivateKeyMetadata(List<CsePrivateKeyMetadata> privateKeyMetadata)

Metadata for instances of this key pair's private key.

Parameters:

privateKeyMetadata - privateKeyMetadata or null for none

getSubjectEmailAddresses

public List<String> getSubjectEmailAddresses()

Output only. The email address identities that are specified on the leaf certificate.

Returns:

value or null for none

setSubjectEmailAddresses

public CseKeyPair setSubjectEmailAddresses(List<String> subjectEmailAddresses)

Output only. The email address identities that are specified on the leaf certificate.

Parameters:

subjectEmailAddresses - subjectEmailAddresses or null for none

set

public CseKeyPair set(String fieldName,
                      Object value)

Overrides:

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

clone

public CseKeyPair clone()

Overrides:

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