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 |
List the `Release` values for a project. This list may optionally be filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any combination thereof.
See: Firebase Rules API Reference for firebaserules.projects.releases.list
.
Synopsis
- type ProjectsReleasesListResource = "v1" :> (Capture "name" Text :> ("releases" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListReleasesResponse)))))))))))
- projectsReleasesList :: Text -> ProjectsReleasesList
- data ProjectsReleasesList
- prlrXgafv :: Lens' ProjectsReleasesList (Maybe Xgafv)
- prlrUploadProtocol :: Lens' ProjectsReleasesList (Maybe Text)
- prlrAccessToken :: Lens' ProjectsReleasesList (Maybe Text)
- prlrUploadType :: Lens' ProjectsReleasesList (Maybe Text)
- prlrName :: Lens' ProjectsReleasesList Text
- prlrFilter :: Lens' ProjectsReleasesList (Maybe Text)
- prlrPageToken :: Lens' ProjectsReleasesList (Maybe Text)
- prlrPageSize :: Lens' ProjectsReleasesList (Maybe Int32)
- prlrCallback :: Lens' ProjectsReleasesList (Maybe Text)
REST Resource
type ProjectsReleasesListResource = "v1" :> (Capture "name" Text :> ("releases" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListReleasesResponse))))))))))) Source #
A resource alias for firebaserules.projects.releases.list
method which the
ProjectsReleasesList
request conforms to.
Creating a Request
Creates a value of ProjectsReleasesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ProjectsReleasesList Source #
List the `Release` values for a project. This list may optionally be filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any combination thereof.
See: projectsReleasesList
smart constructor.
Instances
Request Lenses
prlrUploadProtocol :: Lens' ProjectsReleasesList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
prlrAccessToken :: Lens' ProjectsReleasesList (Maybe Text) Source #
OAuth access token.
prlrUploadType :: Lens' ProjectsReleasesList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
prlrName :: Lens' ProjectsReleasesList Text Source #
Resource name for the project. Format: `projects/{project_id}`
prlrFilter :: Lens' ProjectsReleasesList (Maybe Text) Source #
`Release` filter. The list method supports filters with restrictions on the `Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`. Example 1: A filter of 'name=prod*' might return `Release`s with names within 'projects/foo' prefixed with 'prod': Name | Ruleset Name ------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888 Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only `Release` instances for 'projects/foo' with names prefixed with 'prod' referring to the same `Ruleset` name of 'uuid1234': Name | Ruleset Name ------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/1234 projects/foo/releases/prod/v1 | projects/foo/rulesets/1234 In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used. e.g. `test_suite_name=projects/foo/testsuites/uuid1`
prlrPageToken :: Lens' ProjectsReleasesList (Maybe Text) Source #
Next page token for the next batch of `Release` instances.
prlrPageSize :: Lens' ProjectsReleasesList (Maybe Int32) Source #
Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty.
prlrCallback :: Lens' ProjectsReleasesList (Maybe Text) Source #
JSONP