Network.Google.Resource.Compute.RegionInstanceGroups.ListInstances

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.

See: Compute Engine API Reference for compute.regionInstanceGroups.listInstances.

REST Resource

type RegionInstanceGroupsListInstancesResource = "compute" :> ("v1" :> ("projects" :> (Capture "project" Text :> ("regions" :> (Capture "region" Text :> ("instanceGroups" :> (Capture "instanceGroup" Text :> ("listInstances" :> (QueryParam "orderBy" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RegionInstanceGroupsListInstancesRequest :> Post '[JSON] RegionInstanceGroupsListInstances))))))))))))))

A resource alias for compute.regionInstanceGroups.listInstances method which the RegionInstanceGroupsListInstances' request conforms to.

Creating a Request

regionInstanceGroupsListInstances'

Arguments

:: Text

rigliProject

-> RegionInstanceGroupsListInstancesRequest

rigliPayload

-> Text

rigliRegion

-> Text

rigliInstanceGroup

-> RegionInstanceGroupsListInstances'

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

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

• rigliOrderBy
• rigliProject
• rigliPayload
• rigliFilter
• rigliRegion
• rigliPageToken
• rigliInstanceGroup
• rigliMaxResults

data RegionInstanceGroupsListInstances'

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.

See: regionInstanceGroupsListInstances' smart constructor.

Instances

Eq RegionInstanceGroupsListInstances'

Defined in Network.Google.Resource.Compute.RegionInstanceGroups.ListInstances

Methods

(==) :: RegionInstanceGroupsListInstances' -> RegionInstanceGroupsListInstances' -> Bool

(/=) :: RegionInstanceGroupsListInstances' -> RegionInstanceGroupsListInstances' -> Bool

Data RegionInstanceGroupsListInstances'

Defined in Network.Google.Resource.Compute.RegionInstanceGroups.ListInstances

Methods

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

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

toConstr :: RegionInstanceGroupsListInstances' -> Constr

dataTypeOf :: RegionInstanceGroupsListInstances' -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> RegionInstanceGroupsListInstances' -> RegionInstanceGroupsListInstances'

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

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

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

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

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

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

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

Show RegionInstanceGroupsListInstances'

Defined in Network.Google.Resource.Compute.RegionInstanceGroups.ListInstances

Methods

showsPrec :: Int -> RegionInstanceGroupsListInstances' -> ShowS

show :: RegionInstanceGroupsListInstances' -> String

showList :: [RegionInstanceGroupsListInstances'] -> ShowS

Generic RegionInstanceGroupsListInstances'

Defined in Network.Google.Resource.Compute.RegionInstanceGroups.ListInstances

Associated Types

type Rep RegionInstanceGroupsListInstances' :: Type -> Type

Methods

from :: RegionInstanceGroupsListInstances' -> Rep RegionInstanceGroupsListInstances' x

to :: Rep RegionInstanceGroupsListInstances' x -> RegionInstanceGroupsListInstances'

GoogleRequest RegionInstanceGroupsListInstances'

Defined in Network.Google.Resource.Compute.RegionInstanceGroups.ListInstances

Associated Types

type Rs RegionInstanceGroupsListInstances' :: Type

type Scopes RegionInstanceGroupsListInstances' :: [Symbol]

Methods

requestClient :: RegionInstanceGroupsListInstances' -> GClient (Rs RegionInstanceGroupsListInstances')

type Rep RegionInstanceGroupsListInstances'

Defined in Network.Google.Resource.Compute.RegionInstanceGroups.ListInstances

type Rep RegionInstanceGroupsListInstances' = D1 (MetaData "RegionInstanceGroupsListInstances'" "Network.Google.Resource.Compute.RegionInstanceGroups.ListInstances" "gogol-compute-0.4.0-3Vo4S3NyrNeJWlNkflB3dZ" False) (C1 (MetaCons "RegionInstanceGroupsListInstances''" PrefixI True) (((S1 (MetaSel (Just "_rigliOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rigliProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_rigliPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RegionInstanceGroupsListInstancesRequest) :*: S1 (MetaSel (Just "_rigliFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_rigliRegion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_rigliPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_rigliInstanceGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_rigliMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))))))

type Scopes RegionInstanceGroupsListInstances'

Defined in Network.Google.Resource.Compute.RegionInstanceGroups.ListInstances

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

type Rs RegionInstanceGroupsListInstances'

Defined in Network.Google.Resource.Compute.RegionInstanceGroups.ListInstances

type Rs RegionInstanceGroupsListInstances' = RegionInstanceGroupsListInstances

Request Lenses

rigliOrderBy :: Lens' RegionInstanceGroupsListInstances' (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.

rigliProject :: Lens' RegionInstanceGroupsListInstances' Text

Project ID for this request.

rigliPayload :: Lens' RegionInstanceGroupsListInstances' RegionInstanceGroupsListInstancesRequest

Multipart request metadata.

rigliFilter :: Lens' RegionInstanceGroupsListInstances' (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).

rigliRegion :: Lens' RegionInstanceGroupsListInstances' Text

Name of the region scoping this request.

rigliPageToken :: Lens' RegionInstanceGroupsListInstances' (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.

rigliInstanceGroup :: Lens' RegionInstanceGroupsListInstances' Text

Name of the regional instance group for which we want to list the instances.

rigliMaxResults :: Lens' RegionInstanceGroupsListInstances' 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)