htsjdk.samtools.util.htsget

Class HtsgetResponse

java.lang.Object

htsjdk.samtools.util.htsget.HtsgetResponse

public class HtsgetResponse
extends java.lang.Object

Class allowing deserialization from json htsget response, as defined in https://samtools.github.io/hts-specs/htsget.html

This class currently supports version 1.2.0 of the spec

An example response could be as follows { "htsget" : { "format" : "BAM", "urls" : [ { "url" : "data:application/vnd.ga4gh.bam;base64,QkFNAQ==", "class" : "header" }, { "url" : "https://htsget.blocksrv.example/sample1234/run1.bam", "headers" : { "Authorization" : "Bearer xxxx", "Range" : "bytes=65536-1003750" }, "class" : "body" } ], "md5": "abcd" } }

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HtsgetResponse.Block

Constructor Summary

Constructors

Constructor and Description
HtsgetResponse(HtsgetFormat format, java.util.List<HtsgetResponse.Block> blocks, java.lang.String md5)

Method Summary

Modifier and Type	Method and Description
java.util.List<HtsgetResponse.Block>	getBlocks()
java.io.InputStream	getDataStream() Lazily generates an InputStream over this response's data from the concatenation of the InputStreams from each of the response's data blocks
HtsgetFormat	getFormat()
java.lang.String	getMd5()
static HtsgetResponse	parse(java.lang.String s) Parses HtsgetResponse object from json string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HtsgetResponse

public HtsgetResponse(HtsgetFormat format,
                      java.util.List<HtsgetResponse.Block> blocks,
                      java.lang.String md5)

Method Detail

getFormat

public HtsgetFormat getFormat()

getBlocks

public java.util.List<HtsgetResponse.Block> getBlocks()

getMd5

public java.lang.String getMd5()

parse

public static HtsgetResponse parse(java.lang.String s)

Parses HtsgetResponse object from json string

Parameters:

s - json string

Returns:

parsed HtsgetResponse object

getDataStream

public java.io.InputStream getDataStream()

Lazily generates an InputStream over this response's data from the concatenation of the InputStreams from each of the response's data blocks

Returns:

InputStream over this response's data