com.google.cloud.kms.v1

Interface MacSignRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

MacSignRequest, MacSignRequest.Builder

public interface MacSignRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ByteString	getData() Required.
Int64Value	getDataCrc32C() Optional.
Int64ValueOrBuilder	getDataCrc32COrBuilder() Optional.
String	getName() Required.
ByteString	getNameBytes() Required.
boolean	hasDataCrc32C() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The name.

getNameBytes

ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for name.

getData

ByteString getData()

 Required. The data to sign. The MAC tag is computed over this data field
 based on the specific algorithm.
 

bytes data = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The data.

hasDataCrc32C

boolean hasDataCrc32C()

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

.google.protobuf.Int64Value data_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the dataCrc32c field is set.

getDataCrc32C

Int64Value getDataCrc32C()

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

.google.protobuf.Int64Value data_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The dataCrc32c.

getDataCrc32COrBuilder

Int64ValueOrBuilder getDataCrc32COrBuilder()

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

.google.protobuf.Int64Value data_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];