TAPRegExt API

Models

TAPRegExt classes.

class vo_models.tapregext.models.DataModelType(**data)

IVOA defined data model, identified by an IVORN.

Parameters:

• value (str) – (content) - The human-readable name of the data model.

• ivo_id (str) – (attribute) - The IVORN of the data model.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

class vo_models.tapregext.models.Version(**data)

One version of the language supported by the service.

Parameters:

• value (str) – (content) - The version of the language.

• ivo_id (str | None) – (attribute) - An optional IVORN of the language.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

class vo_models.tapregext.models.LanguageFeature(**data)

A non-standard or non-mandatory feature implemented by the language.

Parameters:

• form (str) – (element) - Formal notation for the language feature.

• description (str | None) – (element) - Human-readable freeform documentation for the language feature.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

class vo_models.tapregext.models.OutputFormat(**data)

An output format supported by the service.

Parameters:

• mime (str) – (element) - The MIME type of this format.

• alias (list[str] | None) – (element) - Other values of FORMAT that make the service return documents with this MIME type.

• ivo_id (str | None) – (attr) - An optional IVORN of the output format.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

class vo_models.tapregext.models.UploadMethod(**data)

An upload method as defined by IVOA.

Parameters:

ivo_id (str) – (attribute) - The IVORN of the upload method.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

class vo_models.tapregext.models.TimeLimits(**data)

Time-valued limits, all values given in seconds.

Parameters:

• default (int | None) – (element) - The value of this limit for newly-created jobs, given in seconds.

• hard (int | None) – (element) - The value this limit cannot be raised above, given in seconds.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

class vo_models.tapregext.models.DataLimit(**data)

A limit on some data size, either in rows or in bytes.

Parameters:

• value (int) – (content) - The value of this limit.

• unit (Literal['byte', 'row']) – (attribute) - The unit of the limit specified.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

class vo_models.tapregext.models.DataLimits(**data)

Limits on data sizes, given in rows or bytes.

Parameters:

• default (DataLimit | None) – (element) - The value of this limit for newly-created jobs.

• hard (DataLimit | None) – (element) - The value this limit cannot be raised above.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

class vo_models.tapregext.models.LanguageFeatureList(**data)

An enumeration of non-standard or non-mandatory features of a specific type implemented by the language.

Parameters:

• feature (list[LanguageFeature] | None) – (element) - A language feature of the type given by this element’s type attribute.

• type (str) – (attribute) - The type of the language feature.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

class vo_models.tapregext.models.Language(**data)

A query language supported by the service.

Parameters:

• name (str) – (element) - The name of the language without a version suffix.

• version (list[Version]) – (element) - A version of the language supported by the server.

• description (str | None) – (element) - A short, human-readable description of the query language.

• language_features (list[LanguageFeatureList] | None) – (element) - Optional features of the query language, grouped by feature type.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

class vo_models.tapregext.models.TableAccess(**data)

The capabilities of a TAP server.

Parameters:

• data_model (list[DataModelType] | None) – (element) - Identifier of IVOA-approved data model supported by the service.

• language (list[Language]) – (element) - Language supported by the service.

• output_format (list[OutputFormat]) – (element) - Output format supported by the service.

• upload_method (list[UploadMethod] | None) – (element) - Upload method supported by the service.

• retention_period (TimeLimits | None) – (element) - Limits on the time between job creation and destruction time.

• execution_duration (TimeLimits | None) – (element) - Limits on executionDuration.

• output_limit (DataLimits | None) – (element) - Limits on the size of data returned.

• upload_limit (DataLimits | None) – (element) - Limits on the size of uploaded data.

• standard_id (Literal['ivo://ivoa.net/std/TAP'])

• type (Literal['tr:TableAccess'])

• validation_level (list[Validation] | None)

• description (str | None)

• interface (list[Interface] | None)

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.