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 |
Searches for annotations that match the given criteria. Results are ordered by genomic coordinate (by reference sequence, then position). Annotations with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotations in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried annotation sets.
See: Genomics API Reference for genomics.annotations.search
.
- type AnnotationsSearchResource = "v1" :> ("annotations" :> ("search" :> (QueryParam "$.xgafv" Xgafv :> (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] SearchAnnotationsRequest :> Post '[JSON] SearchAnnotationsResponse)))))))))))
- annotationsSearch :: SearchAnnotationsRequest -> AnnotationsSearch
- data AnnotationsSearch
- asXgafv :: Lens' AnnotationsSearch (Maybe Xgafv)
- asUploadProtocol :: Lens' AnnotationsSearch (Maybe Text)
- asPp :: Lens' AnnotationsSearch Bool
- asAccessToken :: Lens' AnnotationsSearch (Maybe Text)
- asUploadType :: Lens' AnnotationsSearch (Maybe Text)
- asPayload :: Lens' AnnotationsSearch SearchAnnotationsRequest
- asBearerToken :: Lens' AnnotationsSearch (Maybe Text)
- asCallback :: Lens' AnnotationsSearch (Maybe Text)
REST Resource
type AnnotationsSearchResource = "v1" :> ("annotations" :> ("search" :> (QueryParam "$.xgafv" Xgafv :> (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] SearchAnnotationsRequest :> Post '[JSON] SearchAnnotationsResponse))))))))))) Source #
A resource alias for genomics.annotations.search
method which the
AnnotationsSearch
request conforms to.
Creating a Request
Creates a value of AnnotationsSearch
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AnnotationsSearch Source #
Searches for annotations that match the given criteria. Results are ordered by genomic coordinate (by reference sequence, then position). Annotations with equivalent genomic coordinates are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotations in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried annotation sets.
See: annotationsSearch
smart constructor.
Request Lenses
asUploadProtocol :: Lens' AnnotationsSearch (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
asAccessToken :: Lens' AnnotationsSearch (Maybe Text) Source #
OAuth access token.
asUploadType :: Lens' AnnotationsSearch (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
asPayload :: Lens' AnnotationsSearch SearchAnnotationsRequest Source #
Multipart request metadata.
asBearerToken :: Lens' AnnotationsSearch (Maybe Text) Source #
OAuth bearer token.
asCallback :: Lens' AnnotationsSearch (Maybe Text) Source #
JSONP