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

Class MacSignResponse

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class MacSignResponse
extends GenericJson

Response message for KeyManagementService.MacSign.

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

Method Summary

Modifier and Type	Method and Description
MacSignResponse	clone()
byte[]	decodeMac() The created signature.
MacSignResponse	encodeMac(byte[] mac) The created signature.
String	getMac() The created signature.
Long	getMacCrc32c() Integrity verification field.
String	getName() The resource name of the CryptoKeyVersion used for signing.
String	getProtectionLevel() The ProtectionLevel of the CryptoKeyVersion used for signing.
Boolean	getVerifiedDataCrc32c() Integrity verification field.
MacSignResponse	set(String fieldName, Object value)
MacSignResponse	setMac(String mac) The created signature.
MacSignResponse	setMacCrc32c(Long macCrc32c) Integrity verification field.
MacSignResponse	setName(String name) The resource name of the CryptoKeyVersion used for signing.
MacSignResponse	setProtectionLevel(String protectionLevel) The ProtectionLevel of the CryptoKeyVersion used for signing.
MacSignResponse	setVerifiedDataCrc32c(Boolean verifiedDataCrc32c) 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

MacSignResponse

public MacSignResponse()

Method Detail

getMac

public String getMac()

The created signature.

Returns:

value or null for none

See Also:

decodeMac()

decodeMac

public byte[] decodeMac()

The created signature.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getMac()

setMac

public MacSignResponse setMac(String mac)

The created signature.

Parameters:

mac - mac or null for none

See Also:

#encodeMac()

encodeMac

public MacSignResponse encodeMac(byte[] mac)

The created signature.

Since:

1.14

See Also:

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

getMacCrc32c

public Long getMacCrc32c()

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

setMacCrc32c

public MacSignResponse setMacCrc32c(Long macCrc32c)

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

macCrc32c - macCrc32c or null for none

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 MacSignResponse 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 MacSignResponse setProtectionLevel(String protectionLevel)

The ProtectionLevel of the CryptoKeyVersion used for signing.

Parameters:

protectionLevel - protectionLevel or null for none

getVerifiedDataCrc32c

public Boolean getVerifiedDataCrc32c()

Integrity verification field. A flag indicating whether MacSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that MacSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacSignRequest.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 MacSignResponse setVerifiedDataCrc32c(Boolean verifiedDataCrc32c)

Integrity verification field. A flag indicating whether MacSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that MacSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacSignRequest.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

set

public MacSignResponse set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public MacSignResponse clone()

Overrides:

clone in class GenericJson