MacVerifyRequest

com.google.cloud.kms.v1.service.MacVerifyRequest
See theMacVerifyRequest companion object
final case class MacVerifyRequest(name: String, data: ByteString, dataCrc32C: Option[Long], mac: ByteString, macCrc32C: Option[Long], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[MacVerifyRequest]

Request message for [KeyManagementService.MacVerify][google.cloud.kms.v1.KeyManagementService.MacVerify].

Value parameters

data

Required. The data used previously as a [MacSignRequest.data][google.cloud.kms.v1.MacSignRequest.data] to generate the MAC tag.

dataCrc32C

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

mac

Required. The signature to verify.

macCrc32C

Optional. An optional CRC32C checksum of the [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received [MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac] using this checksum. [KeyManagementService][google.cloud.kms.v1.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][google.cloud.kms.v1.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.

name

Required. The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for verification.

Attributes

Companion
object
Source
MacVerifyRequest.scala
Graph
Supertypes
trait Updatable[MacVerifyRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

Attributes

Source
MacVerifyRequest.scala
def getDataCrc32C: Long

Attributes

Source
MacVerifyRequest.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
MacVerifyRequest.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
MacVerifyRequest.scala
def getMacCrc32C: Long

Attributes

Source
MacVerifyRequest.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
MacVerifyRequest.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
MacVerifyRequest.scala
def withData(`__v`: ByteString): MacVerifyRequest

Attributes

Source
MacVerifyRequest.scala
def withDataCrc32C(`__v`: Long): MacVerifyRequest

Attributes

Source
MacVerifyRequest.scala
def withMac(`__v`: ByteString): MacVerifyRequest

Attributes

Source
MacVerifyRequest.scala
def withMacCrc32C(`__v`: Long): MacVerifyRequest

Attributes

Source
MacVerifyRequest.scala
def withName(`__v`: String): MacVerifyRequest

Attributes

Source
MacVerifyRequest.scala
def withUnknownFields(`__v`: UnknownFieldSet): MacVerifyRequest

Attributes

Source
MacVerifyRequest.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
MacVerifyRequest.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala