Skip to content

GetReadSetMetadataResponse

Source code in docs_src/capo_omics/types/get_read_set_metadata_response.py
class GetReadSetMetadataResponse(TypedDict, closed=True):
    id: "capo_omics.types.read_set_id.ReadSetId"
    """<p>The read set's ID.</p>"""
    arn: "capo_omics.types.read_set_arn.ReadSetArn"
    """<p>The read set's ARN.</p>"""
    sequence_store_id: "capo_omics.types.sequence_store_id.SequenceStoreId"
    """<p>The read set's sequence store ID.</p>"""
    subject_id: NotRequired["capo_omics.types.subject_id.SubjectId"]
    """<p>The read set's subject ID.</p>"""
    sample_id: NotRequired["capo_omics.types.sample_id.SampleId"]
    """<p>The read set's sample ID.</p>"""
    status: "capo_omics.types.read_set_status.ReadSetStatus"
    """<p>The read set's status.</p>"""
    name: NotRequired["capo_omics.types.read_set_name.ReadSetName"]
    """<p>The read set's name.</p>"""
    description: NotRequired["capo_omics.types.read_set_description.ReadSetDescription"]
    """<p>The read set's description.</p>"""
    file_type: "capo_omics.types.file_type.FileType"
    """<p>The read set's file type.</p>"""
    creation_time: "datetime.datetime"
    """<p>When the read set was created.</p>"""
    sequence_information: NotRequired[
        "capo_omics.types.sequence_information.SequenceInformation"
    ]
    """<p>The read set's sequence information.</p>"""
    reference_arn: NotRequired["capo_omics.types.reference_arn.ReferenceArn"]
    """<p>The read set's genome reference ARN.</p>"""
    files: NotRequired["capo_omics.types.read_set_files.ReadSetFiles"]
    """<p>The read set's files.</p>"""
    status_message: NotRequired[
        "capo_omics.types.read_set_status_message.ReadSetStatusMessage"
    ]
    """<p>The status message for a read set. It provides more detail as to why the read set has a status. </p>"""
    creation_type: NotRequired["capo_omics.types.creation_type.CreationType"]
    """<p> The creation type of the read set. </p>"""
    etag: NotRequired["capo_omics.types.e_tag.ETag"]
    """<p>The entity tag (ETag) is a hash of the object meant to represent its semantic content.</p>"""
    creation_job_id: NotRequired["capo_omics.types.creation_job_id.CreationJobId"]
    """<p>The read set's creation job ID.</p>"""

arn instance-attribute

The read set's ARN.

creation_job_id instance-attribute

creation_job_id: NotRequired[CreationJobId]

The read set's creation job ID.

creation_time instance-attribute

creation_time: datetime

When the read set was created.

creation_type instance-attribute

creation_type: NotRequired[CreationType]

The creation type of the read set.

description instance-attribute

description: NotRequired[ReadSetDescription]

The read set's description.

etag instance-attribute

etag: NotRequired[ETag]

The entity tag (ETag) is a hash of the object meant to represent its semantic content.

file_type instance-attribute

file_type: FileType

The read set's file type.

files instance-attribute

files: NotRequired[ReadSetFiles]

The read set's files.

id instance-attribute

The read set's ID.

name instance-attribute

name: NotRequired[ReadSetName]

The read set's name.

reference_arn instance-attribute

reference_arn: NotRequired[ReferenceArn]

The read set's genome reference ARN.

sample_id instance-attribute

sample_id: NotRequired[SampleId]

The read set's sample ID.

sequence_information instance-attribute

sequence_information: NotRequired[SequenceInformation]

The read set's sequence information.

sequence_store_id instance-attribute

sequence_store_id: SequenceStoreId

The read set's sequence store ID.

status instance-attribute

status: ReadSetStatus

The read set's status.

status_message instance-attribute

status_message: NotRequired[ReadSetStatusMessage]

The status message for a read set. It provides more detail as to why the read set has a status.

subject_id instance-attribute

subject_id: NotRequired[SubjectId]

The read set's subject ID.