Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Compute.Instances.Stop

Contents

REST Resource
Creating a Request
Request Lenses

Description

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: Compute Engine API Reference for compute.instances.stop.

Synopsis

type InstancesStopResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("zones" :> (Capture "zone" Text :> ("instances" :> (Capture "instance" Text :> ("stop" :> (QueryParam "requestId" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] Operation))))))))))
instancesStop :: Text -> Text -> Text -> InstancesStop
data InstancesStop
isRequestId :: Lens' InstancesStop (Maybe Text)
isProject :: Lens' InstancesStop Text
isZone :: Lens' InstancesStop Text
isInstance :: Lens' InstancesStop Text

REST Resource

type InstancesStopResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("zones" :> (Capture "zone" Text :> ("instances" :> (Capture "instance" Text :> ("stop" :> (QueryParam "requestId" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] Operation)))))))))) Source #

A resource alias for compute.instances.stop method which the InstancesStop request conforms to.

Creating a Request

instancesStop Source #

Arguments

:: Text	`isProject`
-> Text	`isZone`
-> Text	`isInstance`
-> InstancesStop

Creates a value of InstancesStop with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data InstancesStop Source #

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: instancesStop smart constructor.

Instances

Eq InstancesStop Source #
Instance details Defined in Network.Google.Resource.Compute.Instances.Stop Methods (==) :: InstancesStop -> InstancesStop -> Bool # (/=) :: InstancesStop -> InstancesStop -> Bool #
Data InstancesStop Source #
Instance details Defined in Network.Google.Resource.Compute.Instances.Stop Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InstancesStop -> c InstancesStop # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InstancesStop # toConstr :: InstancesStop -> Constr # dataTypeOf :: InstancesStop -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c InstancesStop) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InstancesStop) # gmapT :: (forall b. Data b => b -> b) -> InstancesStop -> InstancesStop # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InstancesStop -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InstancesStop -> r # gmapQ :: (forall d. Data d => d -> u) -> InstancesStop -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> InstancesStop -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> InstancesStop -> m InstancesStop # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InstancesStop -> m InstancesStop # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InstancesStop -> m InstancesStop #
Show InstancesStop Source #
Instance details Defined in Network.Google.Resource.Compute.Instances.Stop Methods showsPrec :: Int -> InstancesStop -> ShowS # show :: InstancesStop -> String # showList :: [InstancesStop] -> ShowS #
Generic InstancesStop Source #
Instance details Defined in Network.Google.Resource.Compute.Instances.Stop Associated Types type Rep InstancesStop :: Type -> Type # Methods from :: InstancesStop -> Rep InstancesStop x # to :: Rep InstancesStop x -> InstancesStop #
GoogleRequest InstancesStop Source #
Instance details Defined in Network.Google.Resource.Compute.Instances.Stop Associated Types type Rs InstancesStop :: Type # type Scopes InstancesStop :: [Symbol] # Methods requestClient :: InstancesStop -> GClient (Rs InstancesStop) #
type Rep InstancesStop Source #
Instance details Defined in Network.Google.Resource.Compute.Instances.Stop type Rep InstancesStop = D1 (MetaData "InstancesStop" "Network.Google.Resource.Compute.Instances.Stop" "gogol-compute-0.4.0-3Vo4S3NyrNeJWlNkflB3dZ" False) (C1 (MetaCons "InstancesStop'" PrefixI True) ((S1 (MetaSel (Just "_isRequestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_isProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_isZone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_isInstance") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Scopes InstancesStop Source #
Instance details Defined in Network.Google.Resource.Compute.Instances.Stop type Scopes InstancesStop = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/compute" ': ([] :: [Symbol]))
type Rs InstancesStop Source #
Instance details Defined in Network.Google.Resource.Compute.Instances.Stop type Rs InstancesStop = Operation

Request Lenses

isRequestId :: Lens' InstancesStop (Maybe Text) Source #

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).

isProject :: Lens' InstancesStop Text Source #

Project ID for this request.

isZone :: Lens' InstancesStop Text Source #

The name of the zone for this request.

isInstance :: Lens' InstancesStop Text Source #

Name of the instance resource to stop.