gogol-compute-0.2.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 private images available to the specified project. Private 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

illProject

-> 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 private images available to the specified project. Private 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 # 
Data ImagesList Source # 

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 # 
Generic ImagesList Source # 

Associated Types

type Rep ImagesList :: * -> * #

GoogleRequest ImagesList Source # 

Associated Types

type Rs ImagesList :: * #

type Scopes ImagesList :: [Symbol] #

type Rep ImagesList Source # 
type Rep ImagesList = D1 (MetaData "ImagesList" "Network.Google.Resource.Compute.Images.List" "gogol-compute-0.2.0-Au6gUXsPbe4EHzC1JwxdWw" False) (C1 (MetaCons "ImagesList'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_illOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_illProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_illFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_illPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_illMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)))))))
type Scopes ImagesList Source # 
type Scopes ImagesList = (:) Symbol "https://www.googleapis.com/auth/cloud-platform" ((:) Symbol "https://www.googleapis.com/auth/compute" ((:) Symbol "https://www.googleapis.com/auth/compute.readonly" ([] Symbol)))
type Rs ImagesList Source # 

Request Lenses

illOrderBy :: 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.

illProject :: Lens' ImagesList Text Source #

Project ID for this request.

illFilter :: Lens' ImagesList (Maybe Text) Source #

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

illPageToken :: 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.

illMaxResults :: 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.