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

Class AsymmetricSignResponse

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AsymmetricSignResponse
extends GenericJson

Response message for KeyManagementService.AsymmetricSign.

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

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
AsymmetricSignResponse()

Method Summary

Modifier and Type	Method and Description
AsymmetricSignResponse	clone()
byte[]	decodeSignature() The created signature.
AsymmetricSignResponse	encodeSignature(byte[] signature) The created signature.
String	getName() The resource name of the CryptoKeyVersion used for signing.
String	getProtectionLevel() The ProtectionLevel of the CryptoKeyVersion used for signing.
String	getSignature() The created signature.
Long	getSignatureCrc32c() Integrity verification field.
Boolean	getVerifiedDataCrc32c() Integrity verification field.
Boolean	getVerifiedDigestCrc32c() Integrity verification field.
AsymmetricSignResponse	set(String fieldName, Object value)
AsymmetricSignResponse	setName(String name) The resource name of the CryptoKeyVersion used for signing.
AsymmetricSignResponse	setProtectionLevel(String protectionLevel) The ProtectionLevel of the CryptoKeyVersion used for signing.
AsymmetricSignResponse	setSignature(String signature) The created signature.
AsymmetricSignResponse	setSignatureCrc32c(Long signatureCrc32c) Integrity verification field.
AsymmetricSignResponse	setVerifiedDataCrc32c(Boolean verifiedDataCrc32c) Integrity verification field.
AsymmetricSignResponse	setVerifiedDigestCrc32c(Boolean verifiedDigestCrc32c) Integrity verification 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

AsymmetricSignResponse

public AsymmetricSignResponse()

Method Detail

getName

public String getName()

The resource name of the CryptoKeyVersion used for signing. Check this field to verify that the intended resource was used for signing.

Returns:

value or null for none

setName

public AsymmetricSignResponse setName(String name)

The resource name of the CryptoKeyVersion used for signing. Check this field to verify that the intended resource was used for signing.

Parameters:

name - name or null for none

getProtectionLevel

public String getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion used for signing.

Returns:

value or null for none

setProtectionLevel

public AsymmetricSignResponse setProtectionLevel(String protectionLevel)

The ProtectionLevel of the CryptoKeyVersion used for signing.

Parameters:

protectionLevel - protectionLevel or null for none

getSignature

public String getSignature()

The created signature.

Returns:

value or null for none

See Also:

decodeSignature()

decodeSignature

public byte[] decodeSignature()

The created signature.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getSignature()

setSignature

public AsymmetricSignResponse setSignature(String signature)

The created signature.

Parameters:

signature - signature or null for none

See Also:

#encodeSignature()

encodeSignature

public AsymmetricSignResponse encodeSignature(byte[] signature)

The created signature.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getSignatureCrc32c

public Long getSignatureCrc32c()

Integrity verification field. A CRC32C checksum of the returned AsymmetricSignResponse.signature. An integrity check of AsymmetricSignResponse.signature can be performed by computing the CRC32C checksum of AsymmetricSignResponse.signature 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.

Returns:

value or null for none

setSignatureCrc32c

public AsymmetricSignResponse setSignatureCrc32c(Long signatureCrc32c)

Integrity verification field. A CRC32C checksum of the returned AsymmetricSignResponse.signature. An integrity check of AsymmetricSignResponse.signature can be performed by computing the CRC32C checksum of AsymmetricSignResponse.signature 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.

Parameters:

signatureCrc32c - signatureCrc32c or null for none

getVerifiedDataCrc32c

public Boolean getVerifiedDataCrc32c()

Integrity verification field. A flag indicating whether AsymmetricSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that AsymmetricSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricSignRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries.

Returns:

value or null for none

setVerifiedDataCrc32c

public AsymmetricSignResponse setVerifiedDataCrc32c(Boolean verifiedDataCrc32c)

Integrity verification field. A flag indicating whether AsymmetricSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that AsymmetricSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricSignRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries.

Parameters:

verifiedDataCrc32c - verifiedDataCrc32c or null for none

getVerifiedDigestCrc32c

public Boolean getVerifiedDigestCrc32c()

Integrity verification field. A flag indicating whether AsymmetricSignRequest.digest_crc32c was received by KeyManagementService and used for the integrity verification of the digest. A false value of this field indicates either that AsymmetricSignRequest.digest_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricSignRequest.digest_crc32c but this field is still false, discard the response and perform a limited number of retries.

Returns:

value or null for none

setVerifiedDigestCrc32c

public AsymmetricSignResponse setVerifiedDigestCrc32c(Boolean verifiedDigestCrc32c)

Integrity verification field. A flag indicating whether AsymmetricSignRequest.digest_crc32c was received by KeyManagementService and used for the integrity verification of the digest. A false value of this field indicates either that AsymmetricSignRequest.digest_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricSignRequest.digest_crc32c but this field is still false, discard the response and perform a limited number of retries.

Parameters:

verifiedDigestCrc32c - verifiedDigestCrc32c or null for none

set

public AsymmetricSignResponse set(String fieldName,
                                  Object value)

Overrides:

set in class GenericJson

clone

public AsymmetricSignResponse clone()

Overrides:

clone in class GenericJson