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

Contents

Description

Retrieves the list of networks available to the specified project.

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

Synopsis

REST Resource

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

A resource alias for compute.networks.list method which the NetworksList request conforms to.

Creating a Request

networksList Source #

Arguments

:: Text

nlProject

-> NetworksList 

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

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

data NetworksList Source #

Retrieves the list of networks available to the specified project.

See: networksList smart constructor.

Instances

Eq NetworksList Source # 
Data NetworksList Source # 

Methods

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

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

toConstr :: NetworksList -> Constr #

dataTypeOf :: NetworksList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show NetworksList Source # 
Generic NetworksList Source # 

Associated Types

type Rep NetworksList :: * -> * #

GoogleRequest NetworksList Source # 

Associated Types

type Rs NetworksList :: * #

type Scopes NetworksList :: [Symbol] #

type Rep NetworksList Source # 
type Rep NetworksList = D1 (MetaData "NetworksList" "Network.Google.Resource.Compute.Networks.List" "gogol-compute-0.2.0-Au6gUXsPbe4EHzC1JwxdWw" False) (C1 (MetaCons "NetworksList'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_nlOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_nlProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_nlFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_nlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_nlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)))))))
type Scopes NetworksList Source # 
type Scopes NetworksList = (:) 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 NetworksList Source # 

Request Lenses

nlOrderBy :: Lens' NetworksList (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.

nlProject :: Lens' NetworksList Text Source #

Project ID for this request.

nlFilter :: Lens' NetworksList (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.

nlPageToken :: Lens' NetworksList (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.

nlMaxResults :: Lens' NetworksList 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.