Copyright | (c) 2013-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 information about a collection of Resource
resources.
This operation returns paginated results.
- getResources :: Text -> GetResources
- data GetResources
- grsLimit :: Lens' GetResources (Maybe Int)
- grsPosition :: Lens' GetResources (Maybe Text)
- grsRestAPIId :: Lens' GetResources Text
- getResourcesResponse :: Int -> GetResourcesResponse
- data GetResourcesResponse
- grrsItems :: Lens' GetResourcesResponse [Resource]
- grrsPosition :: Lens' GetResourcesResponse (Maybe Text)
- grrsResponseStatus :: Lens' GetResourcesResponse Int
Creating a Request
Creates a value of GetResources
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
grsLimit
- The maximum number ofResource
resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.grsPosition
- The position of the next set of results in the currentResources
resource to get information about.grsRestAPIId
- TheRestApi
identifier for the Resource.
data GetResources Source #
Request to list information about a collection of resources.
See: getResources
smart constructor.
Request Lenses
grsLimit :: Lens' GetResources (Maybe Int) Source #
The maximum number of Resource
resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
grsPosition :: Lens' GetResources (Maybe Text) Source #
The position of the next set of results in the current Resources
resource to get information about.
grsRestAPIId :: Lens' GetResources Text Source #
The RestApi
identifier for the Resource.
Destructuring the Response
Creates a value of GetResourcesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
grrsItems
- Gets the currentResource
resource in the collection.grrsPosition
- Undocumented member.grrsResponseStatus
- -- | The response status code.
data GetResourcesResponse Source #
Represents a collection of Resource
resources.
See: getResourcesResponse
smart constructor.
Response Lenses
grrsItems :: Lens' GetResourcesResponse [Resource] Source #
Gets the current Resource
resource in the collection.
grrsPosition :: Lens' GetResourcesResponse (Maybe Text) Source #
Undocumented member.
grrsResponseStatus :: Lens' GetResourcesResponse Int Source #
- - | The response status code.