content: {-# LANGUAGE DataKinds #-}
  {-# LANGUAGE DerivingStrategies #-}
  {-# LANGUAGE DuplicateRecordFields #-}
  {-# LANGUAGE ImportQualifiedPost #-}
  {-# LANGUAGE LambdaCase #-}
  {-# LANGUAGE OverloadedStrings #-}
  {-# LANGUAGE PatternSynonyms #-}
  {-# LANGUAGE RecordWildCards #-}
  {-# LANGUAGE StrictData #-}
  {-# LANGUAGE TypeFamilies #-}
  {-# LANGUAGE NoImplicitPrelude #-}
  {-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
  {-# OPTIONS_GHC -fno-warn-name-shadowing #-}
  {-# OPTIONS_GHC -fno-warn-unused-binds #-}
  {-# OPTIONS_GHC -fno-warn-unused-imports #-}
  {-# OPTIONS_GHC -fno-warn-unused-matches #-}
  
  -- |
  -- Module      : Gogol.CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt
  -- Copyright   : (c) 2015-2025 Brendan Hay
  -- License     : Mozilla Public License, v. 2.0.
  -- Maintainer  : Brendan Hay <brendan.g.hay+gogol@gmail.com>
  --               Toni Cebrián <toni@tonicebrian.com>
  -- Stability   : auto-generated
  -- Portability : non-portable (GHC extensions)
  --
  -- Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
  --
  -- /See:/ <https://cloud.google.com/kms/ Cloud Key Management Service (KMS) API Reference> for @cloudkms.projects.locations.keyRings.cryptoKeys.encrypt@.
  module Gogol.CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt
    ( -- * Resource
      CloudKMSProjectsLocationsKeyRingsCryptoKeysEncryptResource,
  
      -- ** Constructing a Request
      CloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt (..),
      newCloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt,
    )
  where
  
  import Gogol.CloudKMS.Types
  import Gogol.Prelude qualified as Core
  
  -- | A resource alias for @cloudkms.projects.locations.keyRings.cryptoKeys.encrypt@ method which the
  -- 'CloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt' request conforms to.
  type CloudKMSProjectsLocationsKeyRingsCryptoKeysEncryptResource =
    "v1"
      Core.:> Core.CaptureMode "name" "encrypt" Core.Text
      Core.:> Core.QueryParam "$.xgafv" Xgafv
      Core.:> Core.QueryParam "access_token" Core.Text
      Core.:> Core.QueryParam "callback" Core.Text
      Core.:> Core.QueryParam "uploadType" Core.Text
      Core.:> Core.QueryParam "upload_protocol" Core.Text
      Core.:> Core.QueryParam "alt" Core.AltJSON
      Core.:> Core.ReqBody '[Core.JSON] EncryptRequest
      Core.:> Core.Post '[Core.JSON] EncryptResponse
  
  -- | Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
  --
  -- /See:/ 'newCloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt' smart constructor.
  data CloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt = CloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt
    { -- | V1 error format.
      xgafv :: (Core.Maybe Xgafv),
      -- | OAuth access token.
      accessToken :: (Core.Maybe Core.Text),
      -- | JSONP
      callback :: (Core.Maybe Core.Text),
      -- | Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version.
      name :: Core.Text,
      -- | Multipart request metadata.
      payload :: EncryptRequest,
      -- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
      uploadType :: (Core.Maybe Core.Text),
      -- | Upload protocol for media (e.g. \"raw\", \"multipart\").
      uploadProtocol :: (Core.Maybe Core.Text)
    }
    deriving (Core.Eq, Core.Show, Core.Generic)
  
  -- | Creates a value of 'CloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt' with the minimum fields required to make a request.
  newCloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt ::
    -- |  Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version. See 'name'.
    Core.Text ->
    -- |  Multipart request metadata. See 'payload'.
    EncryptRequest ->
    CloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt
  newCloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt name payload =
    CloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt
      { xgafv =
          Core.Nothing,
        accessToken = Core.Nothing,
        callback = Core.Nothing,
        name = name,
        payload = payload,
        uploadType = Core.Nothing,
        uploadProtocol = Core.Nothing
      }
  
  instance
    Core.GoogleRequest
      CloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt
    where
    type
      Rs CloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt =
        EncryptResponse
    type
      Scopes CloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt =
        '[CloudPlatform'FullControl, Cloudkms'FullControl]
    requestClient
      CloudKMSProjectsLocationsKeyRingsCryptoKeysEncrypt {..} =
        go
          name
          xgafv
          accessToken
          callback
          uploadType
          uploadProtocol
          (Core.Just Core.AltJSON)
          payload
          cloudKMSService
        where
          go =
            Core.buildClient
              ( Core.Proxy ::
                  Core.Proxy
                    CloudKMSProjectsLocationsKeyRingsCryptoKeysEncryptResource
              )
              Core.mempty
  