com.google.api.services.cloudkms.v1.model

Class PublicKey

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudkms.v1.model.PublicKey

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The public keys for a given CryptoKeyVersion. Obtained via GetPublicKey.

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 Cloud Key Management Service (KMS) 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
PublicKey()

Method Summary

Modifier and Type	Method and Description
PublicKey	clone()
String	getAlgorithm() The Algorithm associated with this key.
String	getName() The name of the CryptoKeyVersion public key.
String	getPem() The public key, encoded in PEM format.
Long	getPemCrc32c() Integrity verification field.
String	getProtectionLevel() The ProtectionLevel of the CryptoKeyVersion public key.
ChecksummedData	getPublicKey() This field contains the public key (with integrity verification), formatted according to the public_key_format field.
String	getPublicKeyFormat() The PublicKey format specified by the customer through the public_key_format field.
PublicKey	set(String fieldName, Object value)
PublicKey	setAlgorithm(String algorithm) The Algorithm associated with this key.
PublicKey	setName(String name) The name of the CryptoKeyVersion public key.
PublicKey	setPem(String pem) The public key, encoded in PEM format.
PublicKey	setPemCrc32c(Long pemCrc32c) Integrity verification field.
PublicKey	setProtectionLevel(String protectionLevel) The ProtectionLevel of the CryptoKeyVersion public key.
PublicKey	setPublicKey(ChecksummedData publicKey) This field contains the public key (with integrity verification), formatted according to the public_key_format field.
PublicKey	setPublicKeyFormat(String publicKeyFormat) The PublicKey format specified by the customer through the public_key_format field.

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

PublicKey

public PublicKey()

Method Detail

getAlgorithm

public String getAlgorithm()

The Algorithm associated with this key.

Returns:

value or null for none

setAlgorithm

public PublicKey setAlgorithm(String algorithm)

The Algorithm associated with this key.

Parameters:

algorithm - algorithm or null for none

getName

public String getName()

The name of the CryptoKeyVersion public key. Provided here for verification. NOTE: This field is in Beta.

Returns:

value or null for none

setName

public PublicKey setName(String name)

The name of the CryptoKeyVersion public key. Provided here for verification. NOTE: This field is in Beta.

Parameters:

name - name or null for none

getPem

public String getPem()

The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13).

Returns:

value or null for none

setPem

public PublicKey setPem(String pem)

The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13).

Parameters:

pem - pem or null for none

getPemCrc32c

public Long getPemCrc32c()

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.

Returns:

value or null for none

setPemCrc32c

public PublicKey setPemCrc32c(Long pemCrc32c)

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.

Parameters:

pemCrc32c - pemCrc32c or null for none

getProtectionLevel

public String getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion public key.

Returns:

value or null for none

setProtectionLevel

public PublicKey setProtectionLevel(String protectionLevel)

The ProtectionLevel of the CryptoKeyVersion public key.

Parameters:

protectionLevel - protectionLevel or null for none

getPublicKey

public ChecksummedData getPublicKey()

This field contains the public key (with integrity verification), formatted according to the public_key_format field.

Returns:

value or null for none

setPublicKey

public PublicKey setPublicKey(ChecksummedData publicKey)

This field contains the public key (with integrity verification), formatted according to the public_key_format field.

Parameters:

publicKey - publicKey or null for none

getPublicKeyFormat

public String getPublicKeyFormat()

The PublicKey format specified by the customer through the public_key_format field.

Returns:

value or null for none

setPublicKeyFormat

public PublicKey setPublicKeyFormat(String publicKeyFormat)

The PublicKey format specified by the customer through the public_key_format field.

Parameters:

publicKeyFormat - publicKeyFormat or null for none

set

public PublicKey set(String fieldName,
                     Object value)

Overrides:

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

clone

public PublicKey clone()

Overrides:

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