Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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
.
Synopsis
- 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))))))))))))))
- regionInstanceGroupsListInstances' :: Text -> RegionInstanceGroupsListInstancesRequest -> Text -> Text -> RegionInstanceGroupsListInstances'
- data RegionInstanceGroupsListInstances'
- rigliOrderBy :: Lens' RegionInstanceGroupsListInstances' (Maybe Text)
- rigliProject :: Lens' RegionInstanceGroupsListInstances' Text
- rigliPayload :: Lens' RegionInstanceGroupsListInstances' RegionInstanceGroupsListInstancesRequest
- rigliFilter :: Lens' RegionInstanceGroupsListInstances' (Maybe Text)
- rigliRegion :: Lens' RegionInstanceGroupsListInstances' Text
- rigliPageToken :: Lens' RegionInstanceGroupsListInstances' (Maybe Text)
- rigliInstanceGroup :: Lens' RegionInstanceGroupsListInstances' Text
- rigliMaxResults :: Lens' RegionInstanceGroupsListInstances' Word32
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)))))))))))))) Source #
A resource alias for compute.regionInstanceGroups.listInstances
method which the
RegionInstanceGroupsListInstances'
request conforms to.
Creating a Request
regionInstanceGroupsListInstances' Source #
:: Text | |
-> RegionInstanceGroupsListInstancesRequest | |
-> Text | |
-> Text | |
-> 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:
data RegionInstanceGroupsListInstances' Source #
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
Request Lenses
rigliOrderBy :: Lens' RegionInstanceGroupsListInstances' (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.
rigliProject :: Lens' RegionInstanceGroupsListInstances' Text Source #
Project ID for this request.
rigliPayload :: Lens' RegionInstanceGroupsListInstances' RegionInstanceGroupsListInstancesRequest Source #
Multipart request metadata.
rigliFilter :: Lens' RegionInstanceGroupsListInstances' (Maybe Text) Source #
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 Source #
Name of the region scoping this request.
rigliPageToken :: Lens' RegionInstanceGroupsListInstances' (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.
rigliInstanceGroup :: Lens' RegionInstanceGroupsListInstances' Text Source #
Name of the regional instance group for which we want to list the instances.
rigliMaxResults :: Lens' RegionInstanceGroupsListInstances' 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. Acceptable values are 0 to 500, inclusive. (Default: 500)