Skip to content

Class: ADCAsyncQuery

VDJServer object to represent an ADC asynchronous query.

URI: https://github.com/vdjserver/vdjserver-airr-schema/ADCAsyncQuery

 classDiagram
    class ADCAsyncQuery
    click ADCAsyncQuery href "../ADCAsyncQuery/"
      VDJServerStandards <|-- ADCAsyncQuery
        click VDJServerStandards href "../VDJServerStandards/"

      ADCAsyncQuery : body





        ADCAsyncQuery --> "1" BodyDetails : body
        click BodyDetails href "../BodyDetails/"



      ADCAsyncQuery : collection

      ADCAsyncQuery : count_lrq_id

      ADCAsyncQuery : download_url

      ADCAsyncQuery : endpoint





        ADCAsyncQuery --> "1" ADCAsyncQueryEndpointEnum : endpoint
        click ADCAsyncQueryEndpointEnum href "../ADCAsyncQueryEndpointEnum/"



      ADCAsyncQuery : estimated_count

      ADCAsyncQuery : final_file

      ADCAsyncQuery : lrq_id

      ADCAsyncQuery : message

      ADCAsyncQuery : notification





        ADCAsyncQuery --> "0..1" NotificationDetails : notification
        click NotificationDetails href "../NotificationDetails/"



      ADCAsyncQuery : postit_id

      ADCAsyncQuery : raw_file

      ADCAsyncQuery : status





        ADCAsyncQuery --> "1" StatusEnum : status
        click StatusEnum href "../StatusEnum/"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
endpoint 1
ADCAsyncQueryEndpointEnum		 API endpoint for query direct
collection 1
String		 direct
lrq_id 0..1
String		 Tapis LRQ identifier direct
status 1
StatusEnum		 Status of record, assumed active if the field is not present direct
message 0..1
String		 direct
notification 0..1
NotificationDetails		 Query status notification URL direct
body 1
BodyDetails		 direct
raw_file 0..1
String		 Tapis file containing raw JSON data from LRQ query direct
final_file 0..1
String		 Filename for final processed data to be downloaded by user direct
download_url 0..1
String		 direct
postit_id 0..1
String		 Tapis postit identifier for download file direct
count_lrq_id 0..1
String		 Tapis LRQ identifier for estimated count of query result direct
estimated_count 0..1
Float		 Estimated count of query result direct

Usages

used by used in type used
ADCAsyncQueryMeta value range ADCAsyncQuery

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self https://github.com/vdjserver/vdjserver-airr-schema/ADCAsyncQuery
native https://github.com/vdjserver/vdjserver-airr-schema/ADCAsyncQuery

LinkML Source

Direct

name: ADCAsyncQuery
description: VDJServer object to represent an ADC asynchronous query.
from_schema: https://github.com/vdjserver/vdjserver-airr-schema
is_a: VDJServerStandards
slots:
- endpoint
- collection
- lrq_id
- status
- message
- notification
- body
- raw_file
- final_file
- download_url
- postit_id
- count_lrq_id
- estimated_count
slot_usage:
  endpoint:
    name: endpoint
    required: true
  collection:
    name: collection
    required: true
  status:
    name: status
    required: true
  body:
    name: body
    required: true

Induced

name: ADCAsyncQuery
description: VDJServer object to represent an ADC asynchronous query.
from_schema: https://github.com/vdjserver/vdjserver-airr-schema
is_a: VDJServerStandards
slot_usage:
  endpoint:
    name: endpoint
    required: true
  collection:
    name: collection
    required: true
  status:
    name: status
    required: true
  body:
    name: body
    required: true
attributes:
  endpoint:
    name: endpoint
    annotations:
      nullable:
        tag: nullable
        value: false
    description: API endpoint for query
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    range: ADCAsyncQueryEndpointEnum
    required: true
  collection:
    name: collection
    annotations:
      nullable:
        tag: nullable
        value: false
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    - ADCProjectLoad
    - ADCRearrangementLoad
    range: string
    required: true
  lrq_id:
    name: lrq_id
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Tapis LRQ identifier
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    range: string
  status:
    name: status
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Status of record, assumed active if the field is not present
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - AlleleDescription
    - ADCAsyncQuery
    - AnalysisProperties
    - BasicResponse
    range: StatusEnum
    required: true
  message:
    name: message
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    - BasicResponse
    range: string
  notification:
    name: notification
    description: Query status notification URL
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    range: NotificationDetails
  body:
    name: body
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    - ADCQueryFilter
    range: BodyDetails
    required: true
  raw_file:
    name: raw_file
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Tapis file containing raw JSON data from LRQ query
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    range: string
  final_file:
    name: final_file
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Filename for final processed data to be downloaded by user
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    range: string
  download_url:
    name: download_url
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    - ADCDownloadCacheStudy
    - ADCDownloadCacheRepertoire
    range: string
  postit_id:
    name: postit_id
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Tapis postit identifier for download file
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    range: string
  count_lrq_id:
    name: count_lrq_id
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Tapis LRQ identifier for estimated count of query result
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    range: string
  estimated_count:
    name: estimated_count
    annotations:
      nullable:
        tag: nullable
        value: true
    description: Estimated count of query result. Used to enforce maximum result size.
    from_schema: https://github.com/vdjserver/vdjserver-airr-schema
    rank: 1000
    owner: ADCAsyncQuery
    domain_of:
    - ADCAsyncQuery
    range: float