pds.api_client.models.summary 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.5.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.summary.Summary(*, hits: int | None = None, limit: int | None = None, properties: List[str] | None = None, q: str | None = None, search_after: List[str] | None = None, sort: List[str] | None = None, took: int | None = None)[source]

Bases: BaseModel

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None[source]

Create an instance of Summary from a dict

classmethod from_json(json_str: str) → Self | None[source]

Create an instance of Summary from a JSON string

hits: StrictInt | None
limit: StrictInt | None
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'hits': FieldInfo(annotation=Union[Annotated[int, Strict(strict=True)], NoneType], required=False, description='total number of matching results. -1 indicates an excessive amount of resource required to compute it'), 'limit': FieldInfo(annotation=Union[Annotated[int, Strict(strict=True)], NoneType], required=False), 'properties': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False), 'q': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False), 'search_after': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False), 'sort': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], NoneType], required=False), 'took': FieldInfo(annotation=Union[Annotated[int, Strict(strict=True)], NoneType], required=False, description='Number of milliseconds it "took" to do request')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(__context: Any) → None

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Args:

self: The BaseModel instance. __context: The context.

properties: List[StrictStr] | None
q: StrictStr | None
search_after: List[StrictStr] | None
sort: List[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

took: StrictInt | None