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.Images.List

Contents

Description

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

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

Synopsis

REST Resource

type ImagesListResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("global" :> ("images" :> (QueryParam "orderBy" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] ImageList)))))))))) Source #

A resource alias for compute.images.list method which the ImagesList request conforms to.

Creating a Request

imagesList Source #

Arguments

:: Text

imamProject

-> ImagesList 

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

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

data ImagesList Source #

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

See: imagesList smart constructor.

Instances
Eq ImagesList Source # 
Instance details

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

Data ImagesList Source # 
Instance details

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

Methods

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

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

toConstr :: ImagesList -> Constr #

dataTypeOf :: ImagesList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show ImagesList Source # 
Instance details

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

Generic ImagesList Source # 
Instance details

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

Associated Types

type Rep ImagesList :: Type -> Type #

GoogleRequest ImagesList Source # 
Instance details

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

Associated Types

type Rs ImagesList :: Type #

type Scopes ImagesList :: [Symbol] #

type Rep ImagesList Source # 
Instance details

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

type Rep ImagesList = D1 (MetaData "ImagesList" "Network.Google.Resource.Compute.Images.List" "gogol-compute-0.4.0-3Vo4S3NyrNeJWlNkflB3dZ" False) (C1 (MetaCons "ImagesList'" PrefixI True) ((S1 (MetaSel (Just "_imamOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_imamProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_imamFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_imamPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_imamMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))))))
type Scopes ImagesList Source # 
Instance details

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

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

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

Request Lenses

imamOrderBy :: Lens' ImagesList (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.

imamProject :: Lens' ImagesList Text Source #

Project ID for this request.

imamFilter :: Lens' ImagesList (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).

imamPageToken :: Lens' ImagesList (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.

imamMaxResults :: Lens' ImagesList 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)