http4s-grpc-google-cloud-kms-v1
0.122.0+0.0.5
API
Generated with
http4s-grpc-google-cloud-kms-v1/com.google.cloud.kms.v1/com.google.cloud.kms.v1.service/KeyManagementService

KeyManagementService

com.google.cloud.kms.v1.service.KeyManagementService
See theKeyManagementService companion object
trait KeyManagementService[F[_]]

Google Cloud Key Management Service

Manages cryptographic keys and operations using those keys. Implements a REST model with the following objects:

  • [KeyRing][google.cloud.kms.v1.KeyRing]
  • [CryptoKey][google.cloud.kms.v1.CryptoKey]
  • [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
  • [ImportJob][google.cloud.kms.v1.ImportJob]

If you are using manual gRPC libraries, see Using gRPC with Cloud KMS.

Attributes

Companion
object
Source
KeyManagementService.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def asymmetricDecrypt(request: AsymmetricDecryptRequest, ctx: Headers): F[AsymmetricDecryptResponse]

Decrypts data that was encrypted with a public key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey] corresponding to a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_DECRYPT.

Decrypts data that was encrypted with a public key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey] corresponding to a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_DECRYPT.

Attributes

Source
KeyManagementService.scala
def asymmetricSign(request: AsymmetricSignRequest, ctx: Headers): F[AsymmetricSignResponse]

Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].

Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].

Attributes

Source
KeyManagementService.scala
def createCryptoKey(request: CreateCryptoKeyRequest, ctx: Headers): F[CryptoKey]

Create a new [CryptoKey][google.cloud.kms.v1.CryptoKey] within a [KeyRing][google.cloud.kms.v1.KeyRing].

Create a new [CryptoKey][google.cloud.kms.v1.CryptoKey] within a [KeyRing][google.cloud.kms.v1.KeyRing].

[CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] and [CryptoKey.version_template.algorithm][google.cloud.kms.v1.CryptoKeyVersionTemplate.algorithm] are required.

Attributes

Source
KeyManagementService.scala
def createCryptoKeyVersion(request: CreateCryptoKeyVersionRequest, ctx: Headers): F[CryptoKeyVersion]

Create a new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in a [CryptoKey][google.cloud.kms.v1.CryptoKey].

Create a new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in a [CryptoKey][google.cloud.kms.v1.CryptoKey].

The server will assign the next sequential id. If unset, [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED].

Attributes

Source
KeyManagementService.scala
def createImportJob(request: CreateImportJobRequest, ctx: Headers): F[ImportJob]

Create a new [ImportJob][google.cloud.kms.v1.ImportJob] within a [KeyRing][google.cloud.kms.v1.KeyRing].

Create a new [ImportJob][google.cloud.kms.v1.ImportJob] within a [KeyRing][google.cloud.kms.v1.KeyRing].

[ImportJob.import_method][google.cloud.kms.v1.ImportJob.import_method] is required.

Attributes

Source
KeyManagementService.scala
def createKeyRing(request: CreateKeyRingRequest, ctx: Headers): F[KeyRing]

Create a new [KeyRing][google.cloud.kms.v1.KeyRing] in a given Project and Location.

Create a new [KeyRing][google.cloud.kms.v1.KeyRing] in a given Project and Location.

Attributes

Source
KeyManagementService.scala
def decrypt(request: DecryptRequest, ctx: Headers): F[DecryptResponse]

Decrypts data that was protected by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Decrypts data that was protected by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Attributes

Source
KeyManagementService.scala
def destroyCryptoKeyVersion(request: DestroyCryptoKeyVersionRequest, ctx: Headers): F[CryptoKeyVersion]

Schedule a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] for destruction.

Schedule a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] for destruction.

Upon calling this method, [CryptoKeyVersion.state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED], and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will be set to the time [destroy_scheduled_duration][google.cloud.kms.v1.CryptoKey.destroy_scheduled_duration] in the future. At that time, the [state][google.cloud.kms.v1.CryptoKeyVersion.state] will automatically change to [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED], and the key material will be irrevocably destroyed.

Before the [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] is reached, [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] may be called to reverse the process.

Attributes

Source
KeyManagementService.scala
def encrypt(request: EncryptRequest, ctx: Headers): F[EncryptResponse]

Encrypts data, so that it can only be recovered by a call to [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Encrypts data, so that it can only be recovered by a call to [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Attributes

Source
KeyManagementService.scala
def generateRandomBytes(request: GenerateRandomBytesRequest, ctx: Headers): F[GenerateRandomBytesResponse]

Generate random bytes using the Cloud KMS randomness source in the provided location.

Generate random bytes using the Cloud KMS randomness source in the provided location.

Attributes

Source
KeyManagementService.scala
def getCryptoKey(request: GetCryptoKeyRequest, ctx: Headers): F[CryptoKey]

Returns metadata for a given [CryptoKey][google.cloud.kms.v1.CryptoKey], as well as its [primary][google.cloud.kms.v1.CryptoKey.primary] [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

Returns metadata for a given [CryptoKey][google.cloud.kms.v1.CryptoKey], as well as its [primary][google.cloud.kms.v1.CryptoKey.primary] [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

Attributes

Source
KeyManagementService.scala
def getCryptoKeyVersion(request: GetCryptoKeyVersionRequest, ctx: Headers): F[CryptoKeyVersion]

Returns metadata for a given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

Returns metadata for a given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

Attributes

Source
KeyManagementService.scala
def getImportJob(request: GetImportJobRequest, ctx: Headers): F[ImportJob]

Returns metadata for a given [ImportJob][google.cloud.kms.v1.ImportJob].

Returns metadata for a given [ImportJob][google.cloud.kms.v1.ImportJob].

Attributes

Source
KeyManagementService.scala
def getKeyRing(request: GetKeyRingRequest, ctx: Headers): F[KeyRing]

Returns metadata for a given [KeyRing][google.cloud.kms.v1.KeyRing].

Returns metadata for a given [KeyRing][google.cloud.kms.v1.KeyRing].

Attributes

Source
KeyManagementService.scala
def getPublicKey(request: GetPublicKeyRequest, ctx: Headers): F[PublicKey]

Returns the public key for the given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ASYMMETRIC_SIGN][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_SIGN] or [ASYMMETRIC_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_DECRYPT].

Returns the public key for the given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ASYMMETRIC_SIGN][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_SIGN] or [ASYMMETRIC_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_DECRYPT].

Attributes

Source
KeyManagementService.scala
def importCryptoKeyVersion(request: ImportCryptoKeyVersionRequest, ctx: Headers): F[CryptoKeyVersion]

Import wrapped key material into a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

Import wrapped key material into a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

All requests must specify a [CryptoKey][google.cloud.kms.v1.CryptoKey]. If a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the [CryptoKey][google.cloud.kms.v1.CryptoKey].

Attributes

Source
KeyManagementService.scala
def listCryptoKeyVersions(request: ListCryptoKeyVersionsRequest, ctx: Headers): F[ListCryptoKeyVersionsResponse]

Lists [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion].

Lists [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion].

Attributes

Source
KeyManagementService.scala
def listCryptoKeys(request: ListCryptoKeysRequest, ctx: Headers): F[ListCryptoKeysResponse]

Lists [CryptoKeys][google.cloud.kms.v1.CryptoKey].

Lists [CryptoKeys][google.cloud.kms.v1.CryptoKey].

Attributes

Source
KeyManagementService.scala
def listImportJobs(request: ListImportJobsRequest, ctx: Headers): F[ListImportJobsResponse]

Lists [ImportJobs][google.cloud.kms.v1.ImportJob].

Lists [ImportJobs][google.cloud.kms.v1.ImportJob].

Attributes

Source
KeyManagementService.scala
def listKeyRings(request: ListKeyRingsRequest, ctx: Headers): F[ListKeyRingsResponse]

Lists [KeyRings][google.cloud.kms.v1.KeyRing].

Lists [KeyRings][google.cloud.kms.v1.KeyRing].

Attributes

Source
KeyManagementService.scala
def macSign(request: MacSignRequest, ctx: Headers): F[MacSignResponse]

Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] MAC, producing a tag that can be verified by another source with the same key.

Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] MAC, producing a tag that can be verified by another source with the same key.

Attributes

Source
KeyManagementService.scala
def macVerify(request: MacVerifyRequest, ctx: Headers): F[MacVerifyResponse]

Verifies MAC tag using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] MAC, and returns a response that indicates whether or not the verification was successful.

Verifies MAC tag using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] MAC, and returns a response that indicates whether or not the verification was successful.

Attributes

Source
KeyManagementService.scala
def rawDecrypt(request: RawDecryptRequest, ctx: Headers): F[RawDecryptResponse]

Decrypts data that was originally encrypted using a raw cryptographic mechanism. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [RAW_ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.RAW_ENCRYPT_DECRYPT].

Decrypts data that was originally encrypted using a raw cryptographic mechanism. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [RAW_ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.RAW_ENCRYPT_DECRYPT].

Attributes

Source
KeyManagementService.scala
def rawEncrypt(request: RawEncryptRequest, ctx: Headers): F[RawEncryptResponse]

Encrypts data using portable cryptographic primitives. Most users should choose [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt] rather than their raw counterparts. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [RAW_ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.RAW_ENCRYPT_DECRYPT].

Encrypts data using portable cryptographic primitives. Most users should choose [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt] rather than their raw counterparts. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [RAW_ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.RAW_ENCRYPT_DECRYPT].

Attributes

Source
KeyManagementService.scala
def restoreCryptoKeyVersion(request: RestoreCryptoKeyVersionRequest, ctx: Headers): F[CryptoKeyVersion]

Restore a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in the [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED] state.

Restore a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in the [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED] state.

Upon restoration of the CryptoKeyVersion, [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED], and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will be cleared.

Attributes

Source
KeyManagementService.scala
def updateCryptoKey(request: UpdateCryptoKeyRequest, ctx: Headers): F[CryptoKey]

Update a [CryptoKey][google.cloud.kms.v1.CryptoKey].

Update a [CryptoKey][google.cloud.kms.v1.CryptoKey].

Attributes

Source
KeyManagementService.scala
def updateCryptoKeyPrimaryVersion(request: UpdateCryptoKeyPrimaryVersionRequest, ctx: Headers): F[CryptoKey]

Update the version of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that will be used in [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt].

Update the version of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that will be used in [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt].

Returns an error if called on a key whose purpose is not [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Attributes

Source
KeyManagementService.scala
def updateCryptoKeyVersion(request: UpdateCryptoKeyVersionRequest, ctx: Headers): F[CryptoKeyVersion]

Update a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s metadata.

Update a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s metadata.

[state][google.cloud.kms.v1.CryptoKeyVersion.state] may be changed between [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED] and [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED] using this method. See [DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion] and [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] to move between other states.

Attributes

Source
KeyManagementService.scala
Generated with