Module: ncbi.datasets.openapi.model.v1_virus_dataset_request

NCBI Datasets API

Module: ncbi.datasets.openapi.model.v1_virus_dataset_request

NCBI Datasets API

### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 1 API is considred stable and will not be subject to breaking changes. However, certain endpoints will be [deprecated](https://0-www-ncbi-nlm-nih-gov.brum.beds.ac.uk/datasets/docs/v1/reference-docs/rest-api/deprecated_apis/), and then sunset as newer versions are published. For some larger downloads, you may want to download a [dehydrated zip archive](https://0-www-ncbi-nlm-nih-gov.brum.beds.ac.uk/datasets/docs/v1/how-tos/genomes/large-download/), and retrieve the individual data files at a later time. # noqa: E501

The version of the OpenAPI document: v1 Generated by: https://openapi-generator.tech

ncbi.datasets.openapi.model.v1_virus_dataset_request.lazy_import()
class ncbi.datasets.openapi.model.v1_virus_dataset_request.V1VirusDatasetRequest(*args, **kwargs)

Bases: ncbi.datasets.openapi.model_utils.ModelNormal

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

allowed_values

The key is the tuple path to the attribute and the for var_name this is (var_name,). The value is a dict with a capitalized key describing the allowed value and an allowed value. These dicts store the allowed enum values.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

discriminator_value_class_map

A dict to go from the discriminator variable value to the discriminator class name.

Type

dict

validations

The key is the tuple path to the attribute and the for var_name this is (var_name,). The value is a dict that stores validations for max_length, min_length, max_items, min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, inclusive_minimum, and regex.

Type

dict

additional_properties_type

A tuple of classes accepted as additional properties values.

Type

tuple

allowed_values = {}
validations = {}
additional_properties_type = (<class 'bool'>, <class 'datetime.date'>, <class 'datetime.datetime'>, <class 'dict'>, <class 'float'>, <class 'int'>, <class 'list'>, <class 'str'>, <class 'NoneType'>)
openapi_types = {'accession': (<class 'str'>,), 'accessions': ([<class 'str'>],), 'annotated_only': (<class 'bool'>,), 'complete_only': (<class 'bool'>,), 'exclude_sequence': (<class 'bool'>,), 'format': (<class 'ncbi.datasets.openapi.model.v1_table_format.V1TableFormat'>,), 'geo_location': (<class 'str'>,), 'host': (<class 'str'>,), 'include_annotation_type': ([<class 'ncbi.datasets.openapi.model.v1_annotation_for_virus_type.V1AnnotationForVirusType'>],), 'pangolin_classification': (<class 'str'>,), 'refseq_only': (<class 'bool'>,), 'released_since': (<class 'datetime.datetime'>,), 'table_fields': ([<class 'ncbi.datasets.openapi.model.v1_virus_table_field.V1VirusTableField'>],), 'tax_id': (<class 'int'>,), 'tax_name': (<class 'str'>,), 'taxon': (<class 'str'>,), 'updated_since': (<class 'datetime.datetime'>,)}
discriminator = None
attribute_map = {'accession': 'accession', 'accessions': 'accessions', 'annotated_only': 'annotated_only', 'complete_only': 'complete_only', 'exclude_sequence': 'exclude_sequence', 'format': 'format', 'geo_location': 'geo_location', 'host': 'host', 'include_annotation_type': 'include_annotation_type', 'pangolin_classification': 'pangolin_classification', 'refseq_only': 'refseq_only', 'released_since': 'released_since', 'table_fields': 'table_fields', 'tax_id': 'tax_id', 'tax_name': 'tax_name', 'taxon': 'taxon', 'updated_since': 'updated_since'}
read_only_vars = {}
required_properties = {'_check_type', '_configuration', '_data_store', '_path_to_item', '_spec_property_naming', '_visited_composed_classes'}
Generated March 25, 2024