Network.Google.Resource.Compute.InstanceGroups.AggregatedList

Retrieves the list of instance groups and sorts them by zone.

See: Compute Engine API Reference for compute.instanceGroups.aggregatedList.

REST Resource

type InstanceGroupsAggregatedListResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("aggregated" :> ("instanceGroups" :> (QueryParam "orderBy" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] InstanceGroupAggregatedList))))))))))

A resource alias for compute.instanceGroups.aggregatedList method which the InstanceGroupsAggregatedList request conforms to.

Creating a Request

instanceGroupsAggregatedList

Arguments

:: Text

igalProject

-> InstanceGroupsAggregatedList

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

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

• igalOrderBy
• igalProject
• igalFilter
• igalPageToken
• igalMaxResults

data InstanceGroupsAggregatedList

Retrieves the list of instance groups and sorts them by zone.

See: instanceGroupsAggregatedList smart constructor.

Instances

Eq InstanceGroupsAggregatedList

Methods

(==) :: InstanceGroupsAggregatedList -> InstanceGroupsAggregatedList -> Bool

(/=) :: InstanceGroupsAggregatedList -> InstanceGroupsAggregatedList -> Bool

Data InstanceGroupsAggregatedList

Methods

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

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

toConstr :: InstanceGroupsAggregatedList -> Constr

dataTypeOf :: InstanceGroupsAggregatedList -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> InstanceGroupsAggregatedList -> InstanceGroupsAggregatedList

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

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

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

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

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

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

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

Show InstanceGroupsAggregatedList

Methods

showsPrec :: Int -> InstanceGroupsAggregatedList -> ShowS

show :: InstanceGroupsAggregatedList -> String

showList :: [InstanceGroupsAggregatedList] -> ShowS

Generic InstanceGroupsAggregatedList

Associated Types

type Rep InstanceGroupsAggregatedList :: * -> *

Methods

from :: InstanceGroupsAggregatedList -> Rep InstanceGroupsAggregatedList x

to :: Rep InstanceGroupsAggregatedList x -> InstanceGroupsAggregatedList

GoogleRequest InstanceGroupsAggregatedList

Associated Types

type Rs InstanceGroupsAggregatedList :: *

type Scopes InstanceGroupsAggregatedList :: [Symbol]

Methods

requestClient :: InstanceGroupsAggregatedList -> Client (Rs InstanceGroupsAggregatedList)

type Rep InstanceGroupsAggregatedList

type Rep InstanceGroupsAggregatedList = D1 (MetaData "InstanceGroupsAggregatedList" "Network.Google.Resource.Compute.InstanceGroups.AggregatedList" "gogol-compute-0.2.0-Au6gUXsPbe4EHzC1JwxdWw" False) (C1 (MetaCons "InstanceGroupsAggregatedList'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_igalOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_igalProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_igalFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_igalPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_igalMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)))))))

type Scopes InstanceGroupsAggregatedList

type Scopes InstanceGroupsAggregatedList = (:) 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 InstanceGroupsAggregatedList

type Rs InstanceGroupsAggregatedList = InstanceGroupAggregatedList

Request Lenses

igalOrderBy :: Lens' InstanceGroupsAggregatedList (Maybe Text)

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.

igalProject :: Lens' InstanceGroupsAggregatedList Text

Project ID for this request.

igalFilter :: Lens' InstanceGroupsAggregatedList (Maybe Text)

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.

igalPageToken :: Lens' InstanceGroupsAggregatedList (Maybe Text)

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

igalMaxResults :: Lens' InstanceGroupsAggregatedList Word32

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.