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 all resources in a given deployment.
See: Google Cloud Deployment Manager API Reference for deploymentmanager.resources.list
.
Synopsis
- type ResourcesListResource = "deploymentmanager" :> ("v2" :> ("projects" :> (Capture "project" Text :> ("global" :> ("deployments" :> (Capture "deployment" Text :> ("resources" :> (QueryParam "orderBy" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] ResourcesListResponse))))))))))))
- resourcesList :: Text -> Text -> ResourcesList
- data ResourcesList
- rlOrderBy :: Lens' ResourcesList (Maybe Text)
- rlProject :: Lens' ResourcesList Text
- rlFilter :: Lens' ResourcesList (Maybe Text)
- rlPageToken :: Lens' ResourcesList (Maybe Text)
- rlMaxResults :: Lens' ResourcesList Word32
- rlDeployment :: Lens' ResourcesList Text
REST Resource
type ResourcesListResource = "deploymentmanager" :> ("v2" :> ("projects" :> (Capture "project" Text :> ("global" :> ("deployments" :> (Capture "deployment" Text :> ("resources" :> (QueryParam "orderBy" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] ResourcesListResponse)))))))))))) Source #
A resource alias for deploymentmanager.resources.list
method which the
ResourcesList
request conforms to.
Creating a Request
Creates a value of ResourcesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ResourcesList Source #
Lists all resources in a given deployment.
See: resourcesList
smart constructor.
Instances
Request Lenses
rlOrderBy :: Lens' ResourcesList (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.
rlFilter :: Lens' ResourcesList (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).
rlPageToken :: Lens' ResourcesList (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.
rlMaxResults :: Lens' ResourcesList 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)
rlDeployment :: Lens' ResourcesList Text Source #
The name of the deployment for this request.