Copyright | (c) 2015 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 |
Gets a list of reads for one or more read group sets. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (reference sequence & position). Reads with equivalent genomic coordinates are returned in a deterministic order. Implements GlobalAllianceApi.searchReads.
See: API Reference for genomics.reads.search
.
- type ReadsSearchResource = "v1" :> ("reads" :> ("search" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` SearchReadsRequest :> Post `[JSON]` SearchReadsResponse)))))))))))
- readsSearch :: SearchReadsRequest -> ReadsSearch
- data ReadsSearch
- reaXgafv :: Lens' ReadsSearch (Maybe Text)
- reaUploadProtocol :: Lens' ReadsSearch (Maybe Text)
- reaPp :: Lens' ReadsSearch Bool
- reaAccessToken :: Lens' ReadsSearch (Maybe Text)
- reaUploadType :: Lens' ReadsSearch (Maybe Text)
- reaPayload :: Lens' ReadsSearch SearchReadsRequest
- reaBearerToken :: Lens' ReadsSearch (Maybe Text)
- reaCallback :: Lens' ReadsSearch (Maybe Text)
REST Resource
type ReadsSearchResource = "v1" :> ("reads" :> ("search" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` SearchReadsRequest :> Post `[JSON]` SearchReadsResponse))))))))))) Source
A resource alias for genomics.reads.search
method which the
ReadsSearch
request conforms to.
Creating a Request
Creates a value of ReadsSearch
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ReadsSearch Source
Gets a list of reads for one or more read group sets. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (reference sequence & position). Reads with equivalent genomic coordinates are returned in a deterministic order. Implements GlobalAllianceApi.searchReads.
See: readsSearch
smart constructor.
Request Lenses
reaUploadProtocol :: Lens' ReadsSearch (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
reaPp :: Lens' ReadsSearch Bool Source
Pretty-print response.
reaAccessToken :: Lens' ReadsSearch (Maybe Text) Source
OAuth access token.
reaUploadType :: Lens' ReadsSearch (Maybe Text) Source
Legacy upload protocol for media (e.g. "media", "multipart").
reaPayload :: Lens' ReadsSearch SearchReadsRequest Source
Multipart request metadata.
reaBearerToken :: Lens' ReadsSearch (Maybe Text) Source
OAuth bearer token.
reaCallback :: Lens' ReadsSearch (Maybe Text) Source
JSONP