packages feed

gogol-compute-1.0.0: gen/Gogol/Compute/Reservations/Update.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.Reservations.Update
-- 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)
--
-- Update share settings of the reservation.
--
-- /See:/ <https://cloud.google.com/compute/ Compute Engine API Reference> for @compute.reservations.update@.
module Gogol.Compute.Reservations.Update
  ( -- * Resource
    ComputeReservationsUpdateResource,

    -- ** Constructing a Request
    ComputeReservationsUpdate (..),
    newComputeReservationsUpdate,
  )
where

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

-- | A resource alias for @compute.reservations.update@ method which the
-- 'ComputeReservationsUpdate' request conforms to.
type ComputeReservationsUpdateResource =
  "compute"
    Core.:> "v1"
    Core.:> "projects"
    Core.:> Core.Capture "project" Core.Text
    Core.:> "zones"
    Core.:> Core.Capture "zone" Core.Text
    Core.:> "reservations"
    Core.:> Core.Capture "reservation" Core.Text
    Core.:> Core.QueryParam "$.xgafv" Xgafv
    Core.:> Core.QueryParam "access_token" Core.Text
    Core.:> Core.QueryParam "callback" Core.Text
    Core.:> Core.QueryParams "paths" Core.Text
    Core.:> Core.QueryParam "requestId" Core.Text
    Core.:> Core.QueryParam "updateMask" Core.FieldMask
    Core.:> Core.QueryParam "uploadType" Core.Text
    Core.:> Core.QueryParam "upload_protocol" Core.Text
    Core.:> Core.QueryParam "alt" Core.AltJSON
    Core.:> Core.ReqBody '[Core.JSON] Reservation
    Core.:> Core.Patch '[Core.JSON] Operation

-- | Update share settings of the reservation.
--
-- /See:/ 'newComputeReservationsUpdate' smart constructor.
data ComputeReservationsUpdate = ComputeReservationsUpdate
  { -- | V1 error format.
    xgafv :: (Core.Maybe Xgafv),
    -- | OAuth access token.
    accessToken :: (Core.Maybe Core.Text),
    -- | JSONP
    callback :: (Core.Maybe Core.Text),
    paths :: (Core.Maybe [Core.Text]),
    -- | Multipart request metadata.
    payload :: Reservation,
    -- | 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),
    -- | Name of the reservation to update.
    reservation :: Core.Text,
    -- | Update_mask indicates fields to be updated as part of this request.
    updateMask :: (Core.Maybe Core.FieldMask),
    -- | 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),
    -- | Name of the zone for this request.
    zone :: Core.Text
  }
  deriving (Core.Eq, Core.Show, Core.Generic)

-- | Creates a value of 'ComputeReservationsUpdate' with the minimum fields required to make a request.
newComputeReservationsUpdate ::
  -- |  Multipart request metadata. See 'payload'.
  Reservation ->
  -- |  Project ID for this request. See 'project'.
  Core.Text ->
  -- |  Name of the reservation to update. See 'reservation'.
  Core.Text ->
  -- |  Name of the zone for this request. See 'zone'.
  Core.Text ->
  ComputeReservationsUpdate
newComputeReservationsUpdate payload project reservation zone =
  ComputeReservationsUpdate
    { xgafv = Core.Nothing,
      accessToken = Core.Nothing,
      callback = Core.Nothing,
      paths = Core.Nothing,
      payload = payload,
      project = project,
      requestId = Core.Nothing,
      reservation = reservation,
      updateMask = Core.Nothing,
      uploadType = Core.Nothing,
      uploadProtocol = Core.Nothing,
      zone = zone
    }

instance Core.GoogleRequest ComputeReservationsUpdate where
  type Rs ComputeReservationsUpdate = Operation
  type
    Scopes ComputeReservationsUpdate =
      '[CloudPlatform'FullControl, Compute'FullControl]
  requestClient ComputeReservationsUpdate {..} =
    go
      project
      zone
      reservation
      xgafv
      accessToken
      callback
      (paths Core.^. Core._Default)
      requestId
      updateMask
      uploadType
      uploadProtocol
      (Core.Just Core.AltJSON)
      payload
      computeService
    where
      go =
        Core.buildClient
          (Core.Proxy :: Core.Proxy ComputeReservationsUpdateResource)
          Core.mempty