Package com.google.cloud.kms.v1

Class AsymmetricSignRequest

  • All Implemented Interfaces:
    AsymmetricSignRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AsymmetricSignRequest
extends com.google.protobuf.GeneratedMessageV3
implements AsymmetricSignRequestOrBuilder
     Request message for
 [KeyManagementService.AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign].
    Protobuf type google.cloud.kms.v1.AsymmetricSignRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance 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 AsymmetricSignRequestOrBuilder
        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 AsymmetricSignRequestOrBuilder
        Returns:
        The bytes for name.

      • hasDigest

        public boolean hasDigest()
         Optional. The digest of the data to sign. The digest must be produced with
 the same digest algorithm as specified by the key version's
 [algorithm][google.cloud.kms.v1.CryptoKeyVersion.algorithm].

 This field may not be supplied if
 [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data]
 is supplied.
        .google.cloud.kms.v1.Digest digest = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasDigest in interface AsymmetricSignRequestOrBuilder
        Returns:
        Whether the digest field is set.

      • getDigest

        public Digest getDigest()
         Optional. The digest of the data to sign. The digest must be produced with
 the same digest algorithm as specified by the key version's
 [algorithm][google.cloud.kms.v1.CryptoKeyVersion.algorithm].

 This field may not be supplied if
 [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data]
 is supplied.
        .google.cloud.kms.v1.Digest digest = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDigest in interface AsymmetricSignRequestOrBuilder
        Returns:
        The digest.

      • getDigestOrBuilder

        public DigestOrBuilder getDigestOrBuilder()
         Optional. The digest of the data to sign. The digest must be produced with
 the same digest algorithm as specified by the key version's
 [algorithm][google.cloud.kms.v1.CryptoKeyVersion.algorithm].

 This field may not be supplied if
 [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data]
 is supplied.
        .google.cloud.kms.v1.Digest digest = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDigestOrBuilder in interface AsymmetricSignRequestOrBuilder

      • hasDigestCrc32C

        public boolean hasDigestCrc32C()
         Optional. An optional CRC32C checksum of the
 [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest]
 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([AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest])
 is equal to
 [AsymmetricSignRequest.digest_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.digest_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 digest_crc32c = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasDigestCrc32C in interface AsymmetricSignRequestOrBuilder
        Returns:
        Whether the digestCrc32c field is set.

      • getDigestCrc32C

        public com.google.protobuf.Int64Value getDigestCrc32C()
         Optional. An optional CRC32C checksum of the
 [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest]
 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([AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest])
 is equal to
 [AsymmetricSignRequest.digest_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.digest_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 digest_crc32c = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDigestCrc32C in interface AsymmetricSignRequestOrBuilder
        Returns:
        The digestCrc32c.

      • getDigestCrc32COrBuilder

        public com.google.protobuf.Int64ValueOrBuilder getDigestCrc32COrBuilder()
         Optional. An optional CRC32C checksum of the
 [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest]
 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([AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest])
 is equal to
 [AsymmetricSignRequest.digest_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.digest_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 digest_crc32c = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDigestCrc32COrBuilder in interface AsymmetricSignRequestOrBuilder

      • getData

        public com.google.protobuf.ByteString getData()
         Optional. The data to sign.
 It can't be supplied if
 [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest]
 is supplied.
        bytes data = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getData in interface AsymmetricSignRequestOrBuilder
        Returns:
        The data.

      • hasDataCrc32C

        public boolean hasDataCrc32C()
         Optional. An optional CRC32C checksum of the
 [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.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([AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data])
 is equal to
 [AsymmetricSignRequest.data_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.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 = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasDataCrc32C in interface AsymmetricSignRequestOrBuilder
        Returns:
        Whether the dataCrc32c field is set.

      • getDataCrc32C

        public com.google.protobuf.Int64Value getDataCrc32C()
         Optional. An optional CRC32C checksum of the
 [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.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([AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data])
 is equal to
 [AsymmetricSignRequest.data_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.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 = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDataCrc32C in interface AsymmetricSignRequestOrBuilder
        Returns:
        The dataCrc32c.

      • getDataCrc32COrBuilder

        public com.google.protobuf.Int64ValueOrBuilder getDataCrc32COrBuilder()
         Optional. An optional CRC32C checksum of the
 [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.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([AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data])
 is equal to
 [AsymmetricSignRequest.data_crc32c][google.cloud.kms.v1.AsymmetricSignRequest.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 = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDataCrc32COrBuilder in interface AsymmetricSignRequestOrBuilder

      • 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 AsymmetricSignRequest parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AsymmetricSignRequest parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AsymmetricSignRequest parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AsymmetricSignRequest parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AsymmetricSignRequest parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AsymmetricSignRequest parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public AsymmetricSignRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AsymmetricSignRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AsymmetricSignRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AsymmetricSignRequest> 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 AsymmetricSignRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder