Class MacSignRequest.Builder (2.11.0)

public static final class MacSignRequest.Builder extends GeneratedMessageV3.Builder<MacSignRequest.Builder> implements MacSignRequestOrBuilder

Request message for KeyManagementService.MacSign.

Protobuf type google.cloud.kms.v1.MacSignRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MacSignRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
MacSignRequest.Builder
Overrides

build()

public MacSignRequest build()
Returns
TypeDescription
MacSignRequest

buildPartial()

public MacSignRequest buildPartial()
Returns
TypeDescription
MacSignRequest

clear()

public MacSignRequest.Builder clear()
Returns
TypeDescription
MacSignRequest.Builder
Overrides

clearData()

public MacSignRequest.Builder clearData()

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
TypeDescription
MacSignRequest.Builder

This builder for chaining.

clearDataCrc32C()

public MacSignRequest.Builder clearDataCrc32C()

Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.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(MacSignRequest.data) is equal to 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
TypeDescription
MacSignRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public MacSignRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
MacSignRequest.Builder
Overrides

clearName()

public MacSignRequest.Builder clearName()

Required. The resource name of the CryptoKeyVersion to use for signing.

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

Returns
TypeDescription
MacSignRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public MacSignRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
MacSignRequest.Builder
Overrides

clone()

public MacSignRequest.Builder clone()
Returns
TypeDescription
MacSignRequest.Builder
Overrides

getData()

public 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
TypeDescription
ByteString

The data.

getDataCrc32C()

public Int64Value getDataCrc32C()

Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.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(MacSignRequest.data) is equal to 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
TypeDescription
Int64Value

The dataCrc32c.

getDataCrc32CBuilder()

public Int64Value.Builder getDataCrc32CBuilder()

Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.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(MacSignRequest.data) is equal to 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
TypeDescription
Builder

getDataCrc32COrBuilder()

public Int64ValueOrBuilder getDataCrc32COrBuilder()

Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.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(MacSignRequest.data) is equal to 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
TypeDescription
Int64ValueOrBuilder

getDefaultInstanceForType()

public MacSignRequest getDefaultInstanceForType()
Returns
TypeDescription
MacSignRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getName()

public String getName()

Required. The resource name of the CryptoKeyVersion to use for signing.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the CryptoKeyVersion to use for signing.

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

Returns
TypeDescription
ByteString

The bytes for name.

hasDataCrc32C()

public boolean hasDataCrc32C()

Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.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(MacSignRequest.data) is equal to 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
TypeDescription
boolean

Whether the dataCrc32c field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDataCrc32C(Int64Value value)

public MacSignRequest.Builder mergeDataCrc32C(Int64Value value)

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

Parameter
NameDescription
valueInt64Value
Returns
TypeDescription
MacSignRequest.Builder

mergeFrom(MacSignRequest other)

public MacSignRequest.Builder mergeFrom(MacSignRequest other)
Parameter
NameDescription
otherMacSignRequest
Returns
TypeDescription
MacSignRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MacSignRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MacSignRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public MacSignRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
MacSignRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MacSignRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
MacSignRequest.Builder
Overrides

setData(ByteString value)

public MacSignRequest.Builder setData(ByteString value)

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];

Parameter
NameDescription
valueByteString

The data to set.

Returns
TypeDescription
MacSignRequest.Builder

This builder for chaining.

setDataCrc32C(Int64Value value)

public MacSignRequest.Builder setDataCrc32C(Int64Value value)

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

Parameter
NameDescription
valueInt64Value
Returns
TypeDescription
MacSignRequest.Builder

setDataCrc32C(Int64Value.Builder builderForValue)

public MacSignRequest.Builder setDataCrc32C(Int64Value.Builder builderForValue)

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
MacSignRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public MacSignRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
MacSignRequest.Builder
Overrides

setName(String value)

public MacSignRequest.Builder setName(String value)

Required. The resource name of the CryptoKeyVersion to use for signing.

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
MacSignRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public MacSignRequest.Builder setNameBytes(ByteString value)

Required. The resource name of the CryptoKeyVersion to use for signing.

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
MacSignRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public MacSignRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
MacSignRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final MacSignRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
MacSignRequest.Builder
Overrides