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

Class MacVerifyRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class MacVerifyRequest
extends GenericJson

Request message for KeyManagementService.MacVerify.

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

Method Summary

Modifier and Type	Method and Description
MacVerifyRequest	clone()
byte[]	decodeData() Required.
byte[]	decodeMac() Required.
MacVerifyRequest	encodeData(byte[] data) Required.
MacVerifyRequest	encodeMac(byte[] mac) Required.
String	getData() Required.
Long	getDataCrc32c() Optional.
String	getMac() Required.
Long	getMacCrc32c() Optional.
MacVerifyRequest	set(String fieldName, Object value)
MacVerifyRequest	setData(String data) Required.
MacVerifyRequest	setDataCrc32c(Long dataCrc32c) Optional.
MacVerifyRequest	setMac(String mac) Required.
MacVerifyRequest	setMacCrc32c(Long macCrc32c) Optional.

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

MacVerifyRequest

public MacVerifyRequest()

Method Detail

getData

public String getData()

Required. The data used previously as a MacSignRequest.data to generate the MAC tag.

Returns:

value or null for none

See Also:

decodeData()

decodeData

public byte[] decodeData()

Required. The data used previously as a MacSignRequest.data to generate the MAC tag.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getData()

setData

public MacVerifyRequest setData(String data)

Required. The data used previously as a MacSignRequest.data to generate the MAC tag.

Parameters:

data - data or null for none

See Also:

#encodeData()

encodeData

public MacVerifyRequest encodeData(byte[] data)

Required. The data used previously as a MacSignRequest.data to generate the MAC tag.

Since:

1.14

See Also:

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

getDataCrc32c

public Long getDataCrc32c()

Optional. An optional CRC32C checksum of the MacVerifyRequest.data. If specified, KeyManagementService will verify the integrity of the received MacVerifyRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacVerifyRequest.data) is equal to MacVerifyRequest.data_crc32c, and if so, 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

setDataCrc32c

public MacVerifyRequest setDataCrc32c(Long dataCrc32c)

Optional. An optional CRC32C checksum of the MacVerifyRequest.data. If specified, KeyManagementService will verify the integrity of the received MacVerifyRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacVerifyRequest.data) is equal to MacVerifyRequest.data_crc32c, and if so, 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:

dataCrc32c - dataCrc32c or null for none

getMac

public String getMac()

Required. The signature to verify.

Returns:

value or null for none

See Also:

decodeMac()

decodeMac

public byte[] decodeMac()

Required. The signature to verify.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getMac()

setMac

public MacVerifyRequest setMac(String mac)

Required. The signature to verify.

Parameters:

mac - mac or null for none

See Also:

#encodeMac()

encodeMac

public MacVerifyRequest encodeMac(byte[] mac)

Required. The signature to verify.

Since:

1.14

See Also:

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

getMacCrc32c

public Long getMacCrc32c()

Optional. An optional CRC32C checksum of the MacVerifyRequest.mac. If specified, KeyManagementService will verify the integrity of the received MacVerifyRequest.mac using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacVerifyRequest.tag) is equal to MacVerifyRequest.mac_crc32c, and if so, 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 MacVerifyRequest setMacCrc32c(Long macCrc32c)

Optional. An optional CRC32C checksum of the MacVerifyRequest.mac. If specified, KeyManagementService will verify the integrity of the received MacVerifyRequest.mac using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacVerifyRequest.tag) is equal to MacVerifyRequest.mac_crc32c, and if so, 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

set

public MacVerifyRequest set(String fieldName,
                            Object value)

Overrides:

set in class GenericJson

clone

public MacVerifyRequest clone()

Overrides:

clone in class GenericJson