Network.Google.Resource.Genomics.ReadGroupSets.CoverageBuckets.List

Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. For the definitions of read group sets and other genomics resources, see Fundamentals of Google Genomics Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.

See: Genomics API Reference for genomics.readgroupsets.coveragebuckets.list.

REST Resource

type ReadGroupSetsCoverageBucketsListResource = "v1" :> ("readgroupsets" :> (Capture "readGroupSetId" Text :> ("coveragebuckets" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "start" (Textual Int64) :> (QueryParam "uploadType" Text :> (QueryParam "targetBucketWidth" (Textual Int64) :> (QueryParam "referenceName" Text :> (QueryParam "bearer_token" Text :> (QueryParam "end" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCoverageBucketsResponse)))))))))))))))))

A resource alias for genomics.readgroupsets.coveragebuckets.list method which the ReadGroupSetsCoverageBucketsList request conforms to.

Creating a Request

readGroupSetsCoverageBucketsList

Arguments

:: Text

rgscblReadGroupSetId

-> ReadGroupSetsCoverageBucketsList

Creates a value of ReadGroupSetsCoverageBucketsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rgscblXgafv
• rgscblReadGroupSetId
• rgscblUploadProtocol
• rgscblPp
• rgscblAccessToken
• rgscblStart
• rgscblUploadType
• rgscblTargetBucketWidth
• rgscblReferenceName
• rgscblBearerToken
• rgscblEnd
• rgscblPageToken
• rgscblPageSize
• rgscblCallback

data ReadGroupSetsCoverageBucketsList

Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. For the definitions of read group sets and other genomics resources, see Fundamentals of Google Genomics Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.

See: readGroupSetsCoverageBucketsList smart constructor.

Instances

Eq ReadGroupSetsCoverageBucketsList

Methods

(==) :: ReadGroupSetsCoverageBucketsList -> ReadGroupSetsCoverageBucketsList -> Bool

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

Data ReadGroupSetsCoverageBucketsList

Methods

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

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

toConstr :: ReadGroupSetsCoverageBucketsList -> Constr

dataTypeOf :: ReadGroupSetsCoverageBucketsList -> DataType

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

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

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

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

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

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

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

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

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

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

Show ReadGroupSetsCoverageBucketsList

Methods

showsPrec :: Int -> ReadGroupSetsCoverageBucketsList -> ShowS

show :: ReadGroupSetsCoverageBucketsList -> String

showList :: [ReadGroupSetsCoverageBucketsList] -> ShowS

Generic ReadGroupSetsCoverageBucketsList

Associated Types

type Rep ReadGroupSetsCoverageBucketsList :: * -> *

Methods

from :: ReadGroupSetsCoverageBucketsList -> Rep ReadGroupSetsCoverageBucketsList x

to :: Rep ReadGroupSetsCoverageBucketsList x -> ReadGroupSetsCoverageBucketsList

GoogleRequest ReadGroupSetsCoverageBucketsList

Associated Types

type Rs ReadGroupSetsCoverageBucketsList :: *

type Scopes ReadGroupSetsCoverageBucketsList :: [Symbol]

Methods

requestClient :: ReadGroupSetsCoverageBucketsList -> Client (Rs ReadGroupSetsCoverageBucketsList)

type Rep ReadGroupSetsCoverageBucketsList

type Rep ReadGroupSetsCoverageBucketsList = D1 (MetaData "ReadGroupSetsCoverageBucketsList" "Network.Google.Resource.Genomics.ReadGroupSets.CoverageBuckets.List" "gogol-genomics-0.3.0-GPX9YasYuQx91P3G1HVwWC" False) (C1 (MetaCons "ReadGroupSetsCoverageBucketsList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rgscblXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) ((:*:) (S1 (MetaSel (Just Symbol "_rgscblReadGroupSetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rgscblUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rgscblPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_rgscblAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_rgscblStart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) (S1 (MetaSel (Just Symbol "_rgscblUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rgscblTargetBucketWidth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) ((:*:) (S1 (MetaSel (Just Symbol "_rgscblReferenceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rgscblBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rgscblEnd") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) (S1 (MetaSel (Just Symbol "_rgscblPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_rgscblPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) (S1 (MetaSel (Just Symbol "_rgscblCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes ReadGroupSetsCoverageBucketsList

type Scopes ReadGroupSetsCoverageBucketsList = (:) 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 ReadGroupSetsCoverageBucketsList

type Rs ReadGroupSetsCoverageBucketsList = ListCoverageBucketsResponse

Request Lenses

rgscblXgafv :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Xgafv)

V1 error format.

rgscblReadGroupSetId :: Lens' ReadGroupSetsCoverageBucketsList Text

Required. The ID of the read group set over which coverage is requested.

rgscblUploadProtocol :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)

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

rgscblPp :: Lens' ReadGroupSetsCoverageBucketsList Bool

Pretty-print response.

rgscblAccessToken :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)

OAuth access token.

rgscblStart :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int64)

The start position of the range on the reference, 0-based inclusive. If specified, `referenceName` must also be specified. Defaults to 0.

rgscblUploadType :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)

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

rgscblTargetBucketWidth :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int64)

The desired width of each reported coverage bucket in base pairs. This will be rounded down to the nearest precomputed bucket width; the value of which is returned as `bucketWidth` in the response. Defaults to infinity (each bucket spans an entire reference sequence) or the length of the target range, if specified. The smallest precomputed `bucketWidth` is currently 2048 base pairs; this is subject to change.

rgscblReferenceName :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)

The name of the reference to query, within the reference set associated with this query. Optional.

rgscblBearerToken :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)

OAuth bearer token.

rgscblEnd :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int64)

The end position of the range on the reference, 0-based exclusive. If specified, `referenceName` must also be specified. If unset or 0, defaults to the length of the reference.

rgscblPageToken :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)

The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response.

rgscblPageSize :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Int32)

The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 2048.

rgscblCallback :: Lens' ReadGroupSetsCoverageBucketsList (Maybe Text)

JSONP