pds.api_client.models.reference module
PDS Registry Search API
Registry API enabling advanced search on PDS data and metadata. The API provides end-points to search for bundles, collections and any PDS products with advanced search queries. It also enables to browse the archive hierarchically downward (e.g. collection/s products) or upward (e.g. bundles containing a product).
The version of the OpenAPI document: 1.6.0 Contact: pds-operator@jpl.nasa.gov Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class pds.api_client.models.reference.Reference(*, description: Annotated[str, Strict(strict=True)] | None = None, href: Annotated[str, Strict(strict=True)] | None = None, id: Annotated[str, Strict(strict=True)], title: Annotated[str, Strict(strict=True)] | None = None, type: Annotated[str, Strict(strict=True)] | None = None)[source]
Bases:
BaseModelobject describing a reference to a different product. TODO The properties should be defined by a standard (xlink, json-ld) to be chosen
- description: StrictStr | None
- classmethod from_dict(obj: Dict[str, Any] | None) Self | None[source]
Create an instance of Reference from a dict
- classmethod from_json(json_str: str) Self | None[source]
Create an instance of Reference from a JSON string
- href: StrictStr | None
- id: StrictStr
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- title: StrictStr | None
- to_dict() Dict[str, Any][source]
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True):
None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- type: StrictStr | None