Network.Google.Resource.Compute.RegionCommitments.List

Retrieves a list of commitments contained within the specified region.

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

REST Resource

type RegionCommitmentsListResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("regions" :> (Capture "region" Text :> ("commitments" :> (QueryParam "orderBy" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CommitmentList)))))))))))

A resource alias for compute.regionCommitments.list method which the RegionCommitmentsList request conforms to.

Creating a Request

regionCommitmentsList

Arguments

:: Text

rclProject

-> Text

rclRegion

-> RegionCommitmentsList

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

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

• rclOrderBy
• rclProject
• rclFilter
• rclRegion
• rclPageToken
• rclMaxResults

data RegionCommitmentsList

Retrieves a list of commitments contained within the specified region.

See: regionCommitmentsList smart constructor.

Instances

Eq RegionCommitmentsList

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

Methods

(==) :: RegionCommitmentsList -> RegionCommitmentsList -> Bool

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

Data RegionCommitmentsList

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

Methods

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

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

toConstr :: RegionCommitmentsList -> Constr

dataTypeOf :: RegionCommitmentsList -> DataType

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

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

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

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

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

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

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

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

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

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

Show RegionCommitmentsList

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

Methods

showsPrec :: Int -> RegionCommitmentsList -> ShowS

show :: RegionCommitmentsList -> String

showList :: [RegionCommitmentsList] -> ShowS

Generic RegionCommitmentsList

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

Associated Types

type Rep RegionCommitmentsList :: Type -> Type

Methods

from :: RegionCommitmentsList -> Rep RegionCommitmentsList x

to :: Rep RegionCommitmentsList x -> RegionCommitmentsList

GoogleRequest RegionCommitmentsList

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

Associated Types

type Rs RegionCommitmentsList :: Type

type Scopes RegionCommitmentsList :: [Symbol]

Methods

requestClient :: RegionCommitmentsList -> GClient (Rs RegionCommitmentsList)

type Rep RegionCommitmentsList

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

type Rep RegionCommitmentsList = D1 (MetaData "RegionCommitmentsList" "Network.Google.Resource.Compute.RegionCommitments.List" "gogol-compute-0.4.0-3Vo4S3NyrNeJWlNkflB3dZ" False) (C1 (MetaCons "RegionCommitmentsList'" PrefixI True) ((S1 (MetaSel (Just "_rclOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_rclProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_rclFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_rclRegion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_rclPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rclMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))))))

type Scopes RegionCommitmentsList

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

type Scopes RegionCommitmentsList = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/compute" ': ("https://www.googleapis.com/auth/compute.readonly" ': ([] :: [Symbol])))

type Rs RegionCommitmentsList

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

type Rs RegionCommitmentsList = CommitmentList

Request Lenses

rclOrderBy :: Lens' RegionCommitmentsList (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.

rclProject :: Lens' RegionCommitmentsList Text

Project ID for this request.

rclFilter :: Lens' RegionCommitmentsList (Maybe Text)

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).

rclRegion :: Lens' RegionCommitmentsList Text

Name of the region for this request.

rclPageToken :: Lens' RegionCommitmentsList (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.

rclMaxResults :: Lens' RegionCommitmentsList 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. Acceptable values are 0 to 500, inclusive. (Default: 500)