Package com.google.cloud.kms.v1

Interface AsymmetricSignRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AsymmetricSignRequest, AsymmetricSignRequest.Builder
@Generated public interface AsymmetricSignRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.ByteString
    getData()
    Optional.
    com.google.protobuf.Int64Value
    getDataCrc32C()
    Optional.
    com.google.protobuf.Int64ValueOrBuilder
    getDataCrc32COrBuilder()
    Optional.
    Digest
    getDigest()
    Optional.
    com.google.protobuf.Int64Value
    getDigestCrc32C()
    Optional.
    com.google.protobuf.Int64ValueOrBuilder
    getDigestCrc32COrBuilder()
    Optional.
    DigestOrBuilder
    getDigestOrBuilder()
    Optional.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    boolean
    hasDataCrc32C()
    Optional.
    boolean
    hasDigest()
    Optional.
    boolean
    hasDigestCrc32C()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • 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

      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) = { ... }
      Returns:
      The bytes for name.

    • hasDigest

      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];
      Returns:
      Whether the digest field is set.

    • getDigest

      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];
      Returns:
      The digest.

    • getDigestOrBuilder

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

    • hasDigestCrc32C

      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];
      Returns:
      Whether the digestCrc32c field is set.

    • getDigestCrc32C

      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];
      Returns:
      The digestCrc32c.

    • getDigestCrc32COrBuilder

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

    • getData

      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];
      Returns:
      The data.

    • hasDataCrc32C

      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];
      Returns:
      Whether the dataCrc32c field is set.

    • getDataCrc32C

      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];
      Returns:
      The dataCrc32c.

    • getDataCrc32COrBuilder

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