gogol-compute-0.4.0: Google Compute Engine SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Compute.Instances.List

Contents

Description

Retrieves the list of instances contained within the specified zone.

See: Compute Engine API Reference for compute.instances.list.

Synopsis

REST Resource

type InstancesListResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("zones" :> (Capture "zone" Text :> ("instances" :> (QueryParam "orderBy" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] InstanceList))))))))))) Source #

A resource alias for compute.instances.list method which the InstancesList request conforms to.

Creating a Request

instancesList Source #

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

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

data InstancesList Source #

Retrieves the list of instances contained within the specified zone.

See: instancesList smart constructor.

Instances
Eq InstancesList Source # 
Instance details

Defined in Network.Google.Resource.Compute.Instances.List

Data InstancesList Source # 
Instance details

Defined in Network.Google.Resource.Compute.Instances.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InstancesList -> c InstancesList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InstancesList #

toConstr :: InstancesList -> Constr #

dataTypeOf :: InstancesList -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c InstancesList) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InstancesList) #

gmapT :: (forall b. Data b => b -> b) -> InstancesList -> InstancesList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InstancesList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InstancesList -> r #

gmapQ :: (forall d. Data d => d -> u) -> InstancesList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> InstancesList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InstancesList -> m InstancesList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InstancesList -> m InstancesList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InstancesList -> m InstancesList #

Show InstancesList Source # 
Instance details

Defined in Network.Google.Resource.Compute.Instances.List

Generic InstancesList Source # 
Instance details

Defined in Network.Google.Resource.Compute.Instances.List

Associated Types

type Rep InstancesList :: Type -> Type #

GoogleRequest InstancesList Source # 
Instance details

Defined in Network.Google.Resource.Compute.Instances.List

Associated Types

type Rs InstancesList :: Type #

type Scopes InstancesList :: [Symbol] #

type Rep InstancesList Source # 
Instance details

Defined in Network.Google.Resource.Compute.Instances.List

type Rep InstancesList = D1 (MetaData "InstancesList" "Network.Google.Resource.Compute.Instances.List" "gogol-compute-0.4.0-3Vo4S3NyrNeJWlNkflB3dZ" False) (C1 (MetaCons "InstancesList'" PrefixI True) ((S1 (MetaSel (Just "_il1OrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_il1Project") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_il1Zone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: (S1 (MetaSel (Just "_il1Filter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_il1PageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_il1MaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))))))
type Scopes InstancesList Source # 
Instance details

Defined in Network.Google.Resource.Compute.Instances.List

type Scopes InstancesList = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/compute" ': ("https://www.googleapis.com/auth/compute.readonly" ': ([] :: [Symbol])))
type Rs InstancesList Source # 
Instance details

Defined in Network.Google.Resource.Compute.Instances.List

Request Lenses

il1OrderBy :: Lens' InstancesList (Maybe Text) Source #

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

il1Project :: Lens' InstancesList Text Source #

Project ID for this request.

il1Zone :: Lens' InstancesList Text Source #

The name of the zone for this request.

il1Filter :: Lens' InstancesList (Maybe Text) Source #

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).

il1PageToken :: Lens' InstancesList (Maybe Text) Source #

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

il1MaxResults :: Lens' InstancesList Word32 Source #

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)