http4s-grpc-google-cloud-kms-v1
0.122.0+0.0.5
API
Generated with
http4s-grpc-google-cloud-kms-v1/com.google.cloud.kms.v1/com.google.cloud.kms.v1.service/RawDecryptRequest

RawDecryptRequest

com.google.cloud.kms.v1.service.RawDecryptRequest
See theRawDecryptRequest companion object
final case class RawDecryptRequest(name: String, ciphertext: ByteString, additionalAuthenticatedData: ByteString, initializationVector: ByteString, tagLength: Int, ciphertextCrc32C: Option[Long], additionalAuthenticatedDataCrc32C: Option[Long], initializationVectorCrc32C: Option[Long], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RawDecryptRequest]

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

Value parameters

additionalAuthenticatedData

Optional. Optional data that must match the data originally supplied in [RawEncryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data].

additionalAuthenticatedDataCrc32C

Optional. An optional CRC32C checksum of the [RawDecryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received additional_authenticated_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(additional_authenticated_data) is equal to additional_authenticated_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.

ciphertext

Required. The encrypted data originally returned in [RawEncryptResponse.ciphertext][google.cloud.kms.v1.RawEncryptResponse.ciphertext].

ciphertextCrc32C

Optional. An optional CRC32C checksum of the [RawDecryptRequest.ciphertext][google.cloud.kms.v1.RawDecryptRequest.ciphertext]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received ciphertext 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(ciphertext) is equal to ciphertext_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.

initializationVector

Required. The initialization vector (IV) used during encryption, which must match the data originally provided in [RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].

initializationVectorCrc32C

Optional. An optional CRC32C checksum of the [RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received initialization_vector 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(initialization_vector) is equal to initialization_vector_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 decryption.

tagLength

The length of the authentication tag that is appended to the end of the ciphertext. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16).

Attributes

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

Members list

Value members

Concrete methods

def getCiphertextCrc32C: Long

Attributes

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

Attributes

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

Attributes

Source
RawDecryptRequest.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
RawDecryptRequest.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
RawDecryptRequest.scala
def withCiphertext(`__v`: ByteString): RawDecryptRequest

Attributes

Source
RawDecryptRequest.scala
def withCiphertextCrc32C(`__v`: Long): RawDecryptRequest

Attributes

Source
RawDecryptRequest.scala
def withInitializationVector(`__v`: ByteString): RawDecryptRequest

Attributes

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

Attributes

Source
RawDecryptRequest.scala
def withTagLength(`__v`: Int): RawDecryptRequest

Attributes

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

Attributes

Source
RawDecryptRequest.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
RawDecryptRequest.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
def update(ms: Lens[RawDecryptRequest, RawDecryptRequest] => () => RawDecryptRequest*): A

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
Generated with