AddSignedUrlKey.hs

{-# 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.Compute.BackendServices.AddSignedUrlKey
-- 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)
--
-- Adds a key for validating requests with signed URLs for this backend service.
--
-- /See:/ <https://cloud.google.com/compute/ Compute Engine API Reference> for @compute.backendServices.addSignedUrlKey@.
module Gogol.Compute.BackendServices.AddSignedUrlKey
  ( -- * Resource
    ComputeBackendServicesAddSignedUrlKeyResource,

    -- ** Constructing a Request
    ComputeBackendServicesAddSignedUrlKey (..),
    newComputeBackendServicesAddSignedUrlKey,
  )
where

import Gogol.Compute.Types
import Gogol.Prelude qualified as Core

-- | A resource alias for @compute.backendServices.addSignedUrlKey@ method which the
-- 'ComputeBackendServicesAddSignedUrlKey' request conforms to.
type ComputeBackendServicesAddSignedUrlKeyResource =
  "compute"
    Core.:> "v1"
    Core.:> "projects"
    Core.:> Core.Capture "project" Core.Text
    Core.:> "global"
    Core.:> "backendServices"
    Core.:> Core.Capture "backendService" Core.Text
    Core.:> "addSignedUrlKey"
    Core.:> Core.QueryParam "$.xgafv" Xgafv
    Core.:> Core.QueryParam "access_token" Core.Text
    Core.:> Core.QueryParam "callback" Core.Text
    Core.:> Core.QueryParam "requestId" 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] SignedUrlKey
    Core.:> Core.Post '[Core.JSON] Operation

-- | Adds a key for validating requests with signed URLs for this backend service.
--
-- /See:/ 'newComputeBackendServicesAddSignedUrlKey' smart constructor.
data ComputeBackendServicesAddSignedUrlKey = ComputeBackendServicesAddSignedUrlKey
  { -- | V1 error format.
    xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    accessToken :: (Core.Maybe Core.Text),
    -- | Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
    backendService :: Core.Text,
    -- | JSONP
    callback :: (Core.Maybe Core.Text),
    -- | Multipart request metadata.
    payload :: SignedUrlKey,
    -- | Project ID for this request.
    project :: Core.Text,
    -- | An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    requestId :: (Core.Maybe Core.Text),
    -- | 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 'ComputeBackendServicesAddSignedUrlKey' with the minimum fields required to make a request.
newComputeBackendServicesAddSignedUrlKey ::
  -- |  Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. See 'backendService'.
  Core.Text ->
  -- |  Multipart request metadata. See 'payload'.
  SignedUrlKey ->
  -- |  Project ID for this request. See 'project'.
  Core.Text ->
  ComputeBackendServicesAddSignedUrlKey
newComputeBackendServicesAddSignedUrlKey
  backendService
  payload
  project =
    ComputeBackendServicesAddSignedUrlKey
      { xgafv = Core.Nothing,
        accessToken = Core.Nothing,
        backendService = backendService,
        callback = Core.Nothing,
        payload = payload,
        project = project,
        requestId = Core.Nothing,
        uploadType = Core.Nothing,
        uploadProtocol = Core.Nothing
      }

instance Core.GoogleRequest ComputeBackendServicesAddSignedUrlKey where
  type Rs ComputeBackendServicesAddSignedUrlKey = Operation
  type
    Scopes ComputeBackendServicesAddSignedUrlKey =
      '[CloudPlatform'FullControl, Compute'FullControl]
  requestClient ComputeBackendServicesAddSignedUrlKey {..} =
    go
      project
      backendService
      xgafv
      accessToken
      callback
      requestId
      uploadType
      uploadProtocol
      (Core.Just Core.AltJSON)
      payload
      computeService
    where
      go =
        Core.buildClient
          ( Core.Proxy ::
              Core.Proxy ComputeBackendServicesAddSignedUrlKeyResource
          )
          Core.mempty