Network.Google.Resource.Genomics.Reads.Search

Gets a list of reads for one or more read group sets. For the definitions of read group sets and other genomics resources, see Fundamentals of Google Genomics 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 (by reference sequence, then position). Reads 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 reads in the same order across their respective streams of paginated responses. Implements GlobalAllianceApi.searchReads.

See: Genomics API Reference for genomics.reads.search.

REST Resource

type ReadsSearchResource = "v1" :> ("reads" :> ("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] SearchReadsRequest :> Post '[JSON] SearchReadsResponse)))))))))))

A resource alias for genomics.reads.search method which the ReadsSearch request conforms to.

Creating a Request

readsSearch

Arguments

:: SearchReadsRequest

reaPayload

-> ReadsSearch

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:

• reaXgafv
• reaUploadProtocol
• reaPp
• reaAccessToken
• reaUploadType
• reaPayload
• reaBearerToken
• reaCallback

data ReadsSearch

Gets a list of reads for one or more read group sets. For the definitions of read group sets and other genomics resources, see Fundamentals of Google Genomics 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 (by reference sequence, then position). Reads 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 reads in the same order across their respective streams of paginated responses. Implements GlobalAllianceApi.searchReads.

See: readsSearch smart constructor.

Instances

Eq ReadsSearch

Methods

(==) :: ReadsSearch -> ReadsSearch -> Bool

(/=) :: ReadsSearch -> ReadsSearch -> Bool

Data ReadsSearch

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReadsSearch -> c ReadsSearch

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReadsSearch

toConstr :: ReadsSearch -> Constr

dataTypeOf :: ReadsSearch -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ReadsSearch)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReadsSearch)

gmapT :: (forall b. Data b => b -> b) -> ReadsSearch -> ReadsSearch

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReadsSearch -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReadsSearch -> r

gmapQ :: (forall d. Data d => d -> u) -> ReadsSearch -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ReadsSearch -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReadsSearch -> m ReadsSearch

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReadsSearch -> m ReadsSearch

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReadsSearch -> m ReadsSearch

Show ReadsSearch

Methods

showsPrec :: Int -> ReadsSearch -> ShowS

show :: ReadsSearch -> String

showList :: [ReadsSearch] -> ShowS

Generic ReadsSearch

Associated Types

type Rep ReadsSearch :: * -> *

Methods

from :: ReadsSearch -> Rep ReadsSearch x

to :: Rep ReadsSearch x -> ReadsSearch

GoogleRequest ReadsSearch

Associated Types

type Rs ReadsSearch :: *

type Scopes ReadsSearch :: [Symbol]

Methods

requestClient :: ReadsSearch -> Client (Rs ReadsSearch)

type Rep ReadsSearch

type Rep ReadsSearch = D1 (MetaData "ReadsSearch" "Network.Google.Resource.Genomics.Reads.Search" "gogol-genomics-0.2.0-DiUW9lmfsxKE6fYnbPOsRD" False) (C1 (MetaCons "ReadsSearch'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_reaXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) (S1 (MetaSel (Just Symbol "_reaUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_reaPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_reaAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_reaUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_reaPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SearchReadsRequest))) ((:*:) (S1 (MetaSel (Just Symbol "_reaBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_reaCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes ReadsSearch

type Scopes ReadsSearch = (:) Symbol "https://www.googleapis.com/auth/cloud-platform" ((:) Symbol "https://www.googleapis.com/auth/genomics" ((:) Symbol "https://www.googleapis.com/auth/genomics.readonly" ([] Symbol)))

type Rs ReadsSearch

type Rs ReadsSearch = SearchReadsResponse

Request Lenses

reaXgafv :: Lens' ReadsSearch (Maybe Xgafv)

V1 error format.

reaUploadProtocol :: Lens' ReadsSearch (Maybe Text)

Upload protocol for media (e.g. "raw", "multipart").

reaPp :: Lens' ReadsSearch Bool

Pretty-print response.

reaAccessToken :: Lens' ReadsSearch (Maybe Text)

OAuth access token.

reaUploadType :: Lens' ReadsSearch (Maybe Text)

Legacy upload protocol for media (e.g. "media", "multipart").

reaPayload :: Lens' ReadsSearch SearchReadsRequest

Multipart request metadata.

reaBearerToken :: Lens' ReadsSearch (Maybe Text)

OAuth bearer token.

reaCallback :: Lens' ReadsSearch (Maybe Text)

JSONP