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.Compute.Instances.Stop
  -- 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)
  --
  -- Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
  --
  -- /See:/ <https://cloud.google.com/compute/ Compute Engine API Reference> for @compute.instances.stop@.
  module Gogol.Compute.Instances.Stop
    ( -- * Resource
      ComputeInstancesStopResource,
  
      -- ** Constructing a Request
      ComputeInstancesStop (..),
      newComputeInstancesStop,
    )
  where
  
  import Gogol.Compute.Types
  import Gogol.Prelude qualified as Core
  
  -- | A resource alias for @compute.instances.stop@ method which the
  -- 'ComputeInstancesStop' request conforms to.
  type ComputeInstancesStopResource =
    "compute"
      Core.:> "v1"
      Core.:> "projects"
      Core.:> Core.Capture "project" Core.Text
      Core.:> "zones"
      Core.:> Core.Capture "zone" Core.Text
      Core.:> "instances"
      Core.:> Core.Capture "instance" Core.Text
      Core.:> "stop"
      Core.:> Core.QueryParam "$.xgafv" Xgafv
      Core.:> Core.QueryParam "access_token" Core.Text
      Core.:> Core.QueryParam "callback" Core.Text
      Core.:> Core.QueryParam "discardLocalSsd" Core.Bool
      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.Post '[Core.JSON] Operation
  
  -- | Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
  --
  -- /See:/ 'newComputeInstancesStop' smart constructor.
  data ComputeInstancesStop = ComputeInstancesStop
    { -- | V1 error format.
      xgafv :: (Core.Maybe Xgafv),
      -- | OAuth access token.
      accessToken :: (Core.Maybe Core.Text),
      -- | JSONP
      callback :: (Core.Maybe Core.Text),
      -- | This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.
      discardLocalSsd :: (Core.Maybe Core.Bool),
      -- | Name of the instance resource to stop.
      instance' :: Core.Text,
      -- | 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),
      -- | The name of the zone for this request.
      zone :: Core.Text
    }
    deriving (Core.Eq, Core.Show, Core.Generic)
  
  -- | Creates a value of 'ComputeInstancesStop' with the minimum fields required to make a request.
  newComputeInstancesStop ::
    -- |  Name of the instance resource to stop. See 'instance''.
    Core.Text ->
    -- |  Project ID for this request. See 'project'.
    Core.Text ->
    -- |  The name of the zone for this request. See 'zone'.
    Core.Text ->
    ComputeInstancesStop
  newComputeInstancesStop instance' project zone =
    ComputeInstancesStop
      { xgafv = Core.Nothing,
        accessToken = Core.Nothing,
        callback = Core.Nothing,
        discardLocalSsd = Core.Nothing,
        instance' = instance',
        project = project,
        requestId = Core.Nothing,
        uploadType = Core.Nothing,
        uploadProtocol = Core.Nothing,
        zone = zone
      }
  
  instance Core.GoogleRequest ComputeInstancesStop where
    type Rs ComputeInstancesStop = Operation
    type
      Scopes ComputeInstancesStop =
        '[CloudPlatform'FullControl, Compute'FullControl]
    requestClient ComputeInstancesStop {..} =
      go
        project
        zone
        instance'
        xgafv
        accessToken
        callback
        discardLocalSsd
        requestId
        uploadType
        uploadProtocol
        (Core.Just Core.AltJSON)
        computeService
      where
        go =
          Core.buildClient
            (Core.Proxy :: Core.Proxy ComputeInstancesStopResource)
            Core.mempty
  