pds.api_client.models.pds_product 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.pds_product.PdsProduct(*, description: Annotated[str, Strict(strict=True)] | None = None, id: Annotated[str, Strict(strict=True)], investigations: List[Reference] | None = None, metadata: Metadata, observing_system_components: List[Reference] | None = None, properties: Dict[str, List[Annotated[str, Strict(strict=True)]]] | None = None, start_date_time: Annotated[str, Strict(strict=True)] | None = None, stop_date_time: Annotated[str, Strict(strict=True)] | None = None, targets: List[Reference] | None = None, title: Annotated[str, Strict(strict=True)] | None = None, type: Annotated[str, Strict(strict=True)] | None = None)[source]

Bases: BaseModel

default PDS product description format for the API.

description: StrictStr | None

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]: Create an instance of PdsProduct from a dict

classmethod from_json(json_str: str) → Self | None[source]: Create an instance of PdsProduct from a JSON string

id: StrictStr

investigations: List[Reference] | None

metadata: Metadata

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].

observing_system_components: List[Reference] | None

properties: Dict[str, List[StrictStr]] | None

start_date_time: StrictStr | None

stop_date_time: StrictStr | None

targets: List[Reference] | None

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.

to_json() → str[source]: Returns the JSON representation of the model using alias

to_str() → str[source]: Returns the string representation of the model using alias

type: StrictStr | None