com.google.cloud.kms.v1

Class MacSignRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.kms.v1.MacSignRequest

All Implemented Interfaces:

MacSignRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class MacSignRequest
extends com.google.protobuf.GeneratedMessageV3
implements MacSignRequestOrBuilder

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

Protobuf type google.cloud.kms.v1.MacSignRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MacSignRequest.Builder Request message for [KeyManagementService.MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATA_CRC32C_FIELD_NUMBER
static int	DATA_FIELD_NUMBER
static int	NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
com.google.protobuf.ByteString	getData() Required.
com.google.protobuf.Int64Value	getDataCrc32C() Optional.
com.google.protobuf.Int64ValueOrBuilder	getDataCrc32COrBuilder() Optional.
static MacSignRequest	getDefaultInstance()
MacSignRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Parser<MacSignRequest>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasDataCrc32C() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static MacSignRequest.Builder	newBuilder()
static MacSignRequest.Builder	newBuilder(MacSignRequest prototype)
MacSignRequest.Builder	newBuilderForType()
protected MacSignRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static MacSignRequest	parseDelimitedFrom(InputStream input)
static MacSignRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MacSignRequest	parseFrom(byte[] data)
static MacSignRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MacSignRequest	parseFrom(ByteBuffer data)
static MacSignRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MacSignRequest	parseFrom(com.google.protobuf.ByteString data)
static MacSignRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MacSignRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static MacSignRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MacSignRequest	parseFrom(InputStream input)
static MacSignRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<MacSignRequest>	parser()
MacSignRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER

See Also:

Constant Field Values

DATA_CRC32C_FIELD_NUMBER

public static final int DATA_CRC32C_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public 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) = { ... }

Specified by:

getName in interface MacSignRequestOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.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) = { ... }

Specified by:

getNameBytes in interface MacSignRequestOrBuilder

Returns:

The bytes for name.

getData

public com.google.protobuf.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];

Specified by:

getData in interface MacSignRequestOrBuilder

Returns:

The data.

hasDataCrc32C

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

Specified by:

hasDataCrc32C in interface MacSignRequestOrBuilder

Returns:

Whether the dataCrc32c field is set.

getDataCrc32C

public com.google.protobuf.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];

Specified by:

getDataCrc32C in interface MacSignRequestOrBuilder

Returns:

The dataCrc32c.

getDataCrc32COrBuilder

public com.google.protobuf.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];

Specified by:

getDataCrc32COrBuilder in interface MacSignRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static MacSignRequest parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MacSignRequest parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MacSignRequest parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MacSignRequest parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MacSignRequest parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MacSignRequest parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MacSignRequest parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static MacSignRequest parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static MacSignRequest parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static MacSignRequest parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static MacSignRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static MacSignRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public MacSignRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static MacSignRequest.Builder newBuilder()

newBuilder

public static MacSignRequest.Builder newBuilder(MacSignRequest prototype)

toBuilder

public MacSignRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected MacSignRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static MacSignRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<MacSignRequest> parser()

getParserForType

public com.google.protobuf.Parser<MacSignRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public MacSignRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder