pds.api_client.model package

Submodules

pds.api_client.model.error_message module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.error_message.ErrorMessage(*_args: Union[dict, frozendict], request: Union[StrSchema, str], message: Union[StrSchema, str], _configuration: Optional[Configuration] = None, **kwargs: Union[AnyTypeSchema, dict, frozendict, str, date, datetime, UUID, int, float, Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

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

Do not edit the class manually.

error message

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

message

alias of StrSchema

request

alias of StrSchema

required = {'message', 'request'}
get_item_oapg(name: Literal['request']) MetaOapg.properties.request[source]
get_item_oapg(name: Literal['message']) MetaOapg.properties.message
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
message: StrSchema
request: StrSchema

pds.api_client.model.metadata module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.metadata.Metadata(*_args: ~typing.Union[dict, ~frozendict.frozendict], label_url: ~typing.Union[~pds.api_client.schemas.StrSchema, str], archive_status: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, creation_date_time: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, update_date_time: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, version: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, _configuration: ~typing.Optional[~pds.api_client.configuration.Configuration] = None, **kwargs: ~typing.Union[~pds.api_client.schemas.AnyTypeSchema, dict, ~frozendict.frozendict, str, ~datetime.date, ~datetime.datetime, ~uuid.UUID, int, float, ~decimal.Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

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

Do not edit the class manually.

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

archive_status

alias of StrSchema

creation_date_time

alias of StrSchema

label_url

alias of StrSchema

update_date_time

alias of StrSchema

version

alias of StrSchema

required = {'label_url'}
get_item_oapg(name: Literal['label_url']) MetaOapg.properties.label_url[source]
get_item_oapg(name: Literal['archive_status']) Union[MetaOapg.properties.archive_status, schemas.Unset]
get_item_oapg(name: Literal['creation_date_time']) Union[MetaOapg.properties.creation_date_time, schemas.Unset]
get_item_oapg(name: Literal['update_date_time']) Union[MetaOapg.properties.update_date_time, schemas.Unset]
get_item_oapg(name: Literal['version']) Union[MetaOapg.properties.version, schemas.Unset]
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
label_url: StrSchema

pds.api_client.model.pds4_metadata module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.pds4_metadata.Pds4Metadata(*_args: ~typing.Union[dict, ~frozendict.frozendict], node_name: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, _configuration: ~typing.Optional[~pds.api_client.configuration.Configuration] = None, **kwargs: ~typing.Union[~pds.api_client.schemas.AnyTypeSchema, dict, ~frozendict.frozendict, str, ~datetime.date, ~datetime.datetime, ~uuid.UUID, int, float, ~decimal.Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

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

Do not edit the class manually.

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

node_name

alias of StrSchema

class ops_data_files(_arg: Union[Tuple[Union[items, dict, frozendict]], List[Union[items, dict, frozendict]]], _configuration: Optional[Configuration] = None)[source]

Bases: ListSchema

class MetaOapg[source]

Bases: object

class items(*_args: Union[dict, frozendict], _configuration: Optional[Configuration] = None, **kwargs: Union[AnyTypeSchema, dict, frozendict, str, date, datetime, UUID, int, float, Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

opscreation_date

alias of StrSchema

opsfile_name

alias of StrSchema

opsfile_ref

alias of StrSchema

opsfile_size

alias of StrSchema

opsmd5_checksum

alias of StrSchema

opsmime_type

alias of StrSchema

get_item_oapg(name: Literal['ops:file_name']) Union[MetaOapg.properties.opsfile_name, schemas.Unset][source]
get_item_oapg(name: Literal['ops:file_ref']) Union[MetaOapg.properties.opsfile_ref, schemas.Unset]
get_item_oapg(name: Literal['ops:creation_date']) Union[MetaOapg.properties.opscreation_date, schemas.Unset]
get_item_oapg(name: Literal['ops:file_size']) Union[MetaOapg.properties.opsfile_size, schemas.Unset]
get_item_oapg(name: Literal['ops:md5_checksum']) Union[MetaOapg.properties.opsmd5_checksum, schemas.Unset]
get_item_oapg(name: Literal['ops:mime_type']) Union[MetaOapg.properties.opsmime_type, schemas.Unset]
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
class ops_label_file_info(*_args: Union[dict, frozendict], _configuration: Optional[Configuration] = None, **kwargs: Union[AnyTypeSchema, dict, frozendict, str, date, datetime, UUID, int, float, Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

opscreation_date

alias of StrSchema

opsfile_name

alias of StrSchema

opsfile_ref

alias of StrSchema

opsfile_size

alias of StrSchema

opsmd5_checksum

alias of StrSchema

get_item_oapg(name: Literal['ops:file_name']) Union[MetaOapg.properties.opsfile_name, schemas.Unset][source]
get_item_oapg(name: Literal['ops:file_ref']) Union[MetaOapg.properties.opsfile_ref, schemas.Unset]
get_item_oapg(name: Literal['ops:creation_date']) Union[MetaOapg.properties.opscreation_date, schemas.Unset]
get_item_oapg(name: Literal['ops:file_size']) Union[MetaOapg.properties.opsfile_size, schemas.Unset]
get_item_oapg(name: Literal['ops:md5_checksum']) Union[MetaOapg.properties.opsmd5_checksum, schemas.Unset]
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
class ops_tracking_meta(*_args: Union[dict, frozendict], _configuration: Optional[Configuration] = None, **kwargs: Union[AnyTypeSchema, dict, frozendict, str, date, datetime, UUID, int, float, Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

opsarchive_status

alias of StrSchema

get_item_oapg(name: Literal['ops:archive_status']) Union[MetaOapg.properties.opsarchive_status, schemas.Unset][source]
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
get_item_oapg(name: Literal['node_name']) Union[MetaOapg.properties.node_name, schemas.Unset][source]
get_item_oapg(name: Literal['ops:Label_File_Info']) Union[MetaOapg.properties.ops_label_file_info, schemas.Unset]
get_item_oapg(name: Literal['ops:Data_Files']) Union[MetaOapg.properties.ops_data_files, schemas.Unset]
get_item_oapg(name: Literal['ops:Tracking_Meta']) Union[MetaOapg.properties.ops_tracking_meta, schemas.Unset]
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]

pds.api_client.model.pds4_product module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.pds4_product.Pds4Product(*_args: ~typing.Union[dict, ~frozendict.frozendict], id: ~typing.Union[~pds.api_client.schemas.StrSchema, str], metadata: ~typing.Union[~pds.api_client.model.pds4_metadata.Pds4Metadata, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, pds4: ~typing.Union[~pds.api_client.schemas.DictSchema, dict, ~frozendict.frozendict, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, _configuration: ~typing.Optional[~pds.api_client.configuration.Configuration] = None, **kwargs: ~typing.Union[~pds.api_client.schemas.AnyTypeSchema, dict, ~frozendict.frozendict, str, ~datetime.date, ~datetime.datetime, ~uuid.UUID, int, float, ~decimal.Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

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

Do not edit the class manually.

PDS product description as structured by the PDS4 information model (https://pds.nasa.gov/datastandards/documents/im/)

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

id

alias of StrSchema

static metadata() Type[Pds4Metadata][source]
pds4

alias of DictSchema

required = {'id'}
get_item_oapg(name: Literal['id']) MetaOapg.properties.id[source]
get_item_oapg(name: Literal['metadata']) Union[Pds4Metadata, Unset]
get_item_oapg(name: Literal['pds4']) Union[MetaOapg.properties.pds4, schemas.Unset]
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
id: StrSchema

pds.api_client.model.pds4_products module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.pds4_products.Pds4Products(*_args: Union[dict, frozendict], summary: Summary, data: Union[data, list, tuple], _configuration: Optional[Configuration] = None, **kwargs: Union[AnyTypeSchema, dict, frozendict, str, date, datetime, UUID, int, float, Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

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

Do not edit the class manually.

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

class data(_arg: Union[Tuple[Pds4Product], List[Pds4Product]], _configuration: Optional[Configuration] = None)[source]

Bases: ListSchema

class MetaOapg[source]

Bases: object

static items() Type[Pds4Product][source]
static summary() Type[Summary][source]
required = {'data', 'summary'}
data: data
get_item_oapg(name: Literal['summary']) Summary[source]
get_item_oapg(name: Literal['data']) MetaOapg.properties.data
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
summary: Summary

pds.api_client.model.pds_product module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.pds_product.PdsProduct(*_args: ~typing.Union[dict, ~frozendict.frozendict], metadata: ~pds.api_client.model.metadata.Metadata, id: ~typing.Union[~pds.api_client.schemas.StrSchema, str], type: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, title: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, description: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, start_date_time: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, stop_date_time: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, investigations: ~typing.Union[~pds.api_client.model.pds_product.PdsProduct.MetaOapg.properties.investigations, list, tuple, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, observing_system_components: ~typing.Union[~pds.api_client.model.pds_product.PdsProduct.MetaOapg.properties.observing_system_components, list, tuple, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, targets: ~typing.Union[~pds.api_client.model.pds_product.PdsProduct.MetaOapg.properties.targets, list, tuple, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, properties: ~typing.Union[~pds.api_client.model.pds_product.PdsProduct.MetaOapg.properties.properties, dict, ~frozendict.frozendict, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, _configuration: ~typing.Optional[~pds.api_client.configuration.Configuration] = None, **kwargs: ~typing.Union[~pds.api_client.schemas.AnyTypeSchema, dict, ~frozendict.frozendict, str, ~datetime.date, ~datetime.datetime, ~uuid.UUID, int, float, ~decimal.Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

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

Do not edit the class manually.

default PDS product description format for the API.

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

description

alias of StrSchema

id

alias of StrSchema

class investigations(_arg: Union[Tuple[Reference], List[Reference]], _configuration: Optional[Configuration] = None)[source]

Bases: ListSchema

class MetaOapg[source]

Bases: object

static items() Type[Reference][source]
static metadata() Type[Metadata][source]
class observing_system_components(_arg: Union[Tuple[Reference], List[Reference]], _configuration: Optional[Configuration] = None)[source]

Bases: ListSchema

class MetaOapg[source]

Bases: object

static items() Type[Reference][source]
class properties(*_args: Union[dict, frozendict], _configuration: Optional[Configuration] = None, **kwargs: PropertyArrayValues)[source]

Bases: DictSchema

class MetaOapg[source]

Bases: object

static additional_properties() Type[PropertyArrayValues][source]
get_item_oapg(name: str) PropertyArrayValues[source]
start_date_time

alias of StrSchema

stop_date_time

alias of StrSchema

class targets(_arg: Union[Tuple[Reference], List[Reference]], _configuration: Optional[Configuration] = None)[source]

Bases: ListSchema

class MetaOapg[source]

Bases: object

static items() Type[Reference][source]
title

alias of StrSchema

type

alias of StrSchema

required = {'id', 'metadata'}
get_item_oapg(name: Literal['id']) MetaOapg.properties.id[source]
get_item_oapg(name: Literal['metadata']) Metadata
get_item_oapg(name: Literal['type']) Union[MetaOapg.properties.type, schemas.Unset]
get_item_oapg(name: Literal['title']) Union[MetaOapg.properties.title, schemas.Unset]
get_item_oapg(name: Literal['description']) Union[MetaOapg.properties.description, schemas.Unset]
get_item_oapg(name: Literal['start_date_time']) Union[MetaOapg.properties.start_date_time, schemas.Unset]
get_item_oapg(name: Literal['stop_date_time']) Union[MetaOapg.properties.stop_date_time, schemas.Unset]
get_item_oapg(name: Literal['investigations']) Union[MetaOapg.properties.investigations, schemas.Unset]
get_item_oapg(name: Literal['observing_system_components']) Union[MetaOapg.properties.observing_system_components, schemas.Unset]
get_item_oapg(name: Literal['targets']) Union[MetaOapg.properties.targets, schemas.Unset]
get_item_oapg(name: Literal['properties']) Union[MetaOapg.properties.properties, schemas.Unset]
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
id: StrSchema
metadata: Metadata

pds.api_client.model.pds_products module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.pds_products.PdsProducts(*_args: Union[dict, frozendict], summary: Summary, data: Union[data, list, tuple], _configuration: Optional[Configuration] = None, **kwargs: Union[AnyTypeSchema, dict, frozendict, str, date, datetime, UUID, int, float, Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

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

Do not edit the class manually.

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

class data(_arg: Union[Tuple[PdsProduct], List[PdsProduct]], _configuration: Optional[Configuration] = None)[source]

Bases: ListSchema

class MetaOapg[source]

Bases: object

static items() Type[PdsProduct][source]
static summary() Type[Summary][source]
required = {'data', 'summary'}
data: data
get_item_oapg(name: Literal['summary']) Summary[source]
get_item_oapg(name: Literal['data']) MetaOapg.properties.data
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
summary: Summary

pds.api_client.model.property_array_values module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.property_array_values.PropertyArrayValues(_arg: Union[Tuple[Union[StrSchema, str]], List[Union[StrSchema, str]]], _configuration: Optional[Configuration] = None)[source]

Bases: ListSchema

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

Do not edit the class manually.

class MetaOapg[source]

Bases: object

items

alias of StrSchema

pds.api_client.model.reference module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.reference.Reference(*_args: ~typing.Union[dict, ~frozendict.frozendict], id: ~typing.Union[~pds.api_client.schemas.StrSchema, str], title: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, href: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, type: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, description: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, _configuration: ~typing.Optional[~pds.api_client.configuration.Configuration] = None, **kwargs: ~typing.Union[~pds.api_client.schemas.AnyTypeSchema, dict, ~frozendict.frozendict, str, ~datetime.date, ~datetime.datetime, ~uuid.UUID, int, float, ~decimal.Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

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

Do not edit the class manually.

object describing a reference to a different product. TODO The properties should be defined by a standard (xlink, json-ld) to be chosen

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

description

alias of StrSchema

href

alias of StrSchema

id

alias of StrSchema

title

alias of StrSchema

type

alias of StrSchema

required = {'id'}
get_item_oapg(name: Literal['id']) MetaOapg.properties.id[source]
get_item_oapg(name: Literal['title']) Union[MetaOapg.properties.title, schemas.Unset]
get_item_oapg(name: Literal['href']) Union[MetaOapg.properties.href, schemas.Unset]
get_item_oapg(name: Literal['type']) Union[MetaOapg.properties.type, schemas.Unset]
get_item_oapg(name: Literal['description']) Union[MetaOapg.properties.description, schemas.Unset]
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
id: StrSchema

pds.api_client.model.summary module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.summary.Summary(*_args: ~typing.Union[dict, ~frozendict.frozendict], q: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, hits: ~typing.Union[~pds.api_client.schemas.IntSchema, ~decimal.Decimal, int, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, took: ~typing.Union[~pds.api_client.schemas.IntSchema, ~decimal.Decimal, int, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, start: ~typing.Union[~pds.api_client.schemas.IntSchema, ~decimal.Decimal, int, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, limit: ~typing.Union[~pds.api_client.schemas.IntSchema, ~decimal.Decimal, int, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, sort: ~typing.Union[~pds.api_client.model.summary.Summary.MetaOapg.properties.sort, list, tuple, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, properties: ~typing.Union[~pds.api_client.model.summary.Summary.MetaOapg.properties.properties, list, tuple, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, _configuration: ~typing.Optional[~pds.api_client.configuration.Configuration] = None, **kwargs: ~typing.Union[~pds.api_client.schemas.AnyTypeSchema, dict, ~frozendict.frozendict, str, ~datetime.date, ~datetime.datetime, ~uuid.UUID, int, float, ~decimal.Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

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

Do not edit the class manually.

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

hits

alias of IntSchema

limit

alias of IntSchema

class properties(_arg: Union[Tuple[Union[StrSchema, str]], List[Union[StrSchema, str]]], _configuration: Optional[Configuration] = None)[source]

Bases: ListSchema

class MetaOapg[source]

Bases: object

items

alias of StrSchema

q

alias of StrSchema

class sort(_arg: Union[Tuple[Union[StrSchema, str]], List[Union[StrSchema, str]]], _configuration: Optional[Configuration] = None)[source]

Bases: ListSchema

class MetaOapg[source]

Bases: object

items

alias of StrSchema

start

alias of IntSchema

took

alias of IntSchema

get_item_oapg(name: Literal['q']) Union[MetaOapg.properties.q, schemas.Unset][source]
get_item_oapg(name: Literal['hits']) Union[MetaOapg.properties.hits, schemas.Unset]
get_item_oapg(name: Literal['took']) Union[MetaOapg.properties.took, schemas.Unset]
get_item_oapg(name: Literal['start']) Union[MetaOapg.properties.start, schemas.Unset]
get_item_oapg(name: Literal['limit']) Union[MetaOapg.properties.limit, schemas.Unset]
get_item_oapg(name: Literal['sort']) Union[MetaOapg.properties.sort, schemas.Unset]
get_item_oapg(name: Literal['properties']) Union[MetaOapg.properties.properties, schemas.Unset]
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]

pds.api_client.model.wyriwyg_product module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.wyriwyg_product.WyriwygProduct(*_args: Union[dict, frozendict], key_value_pairs: Union[key_value_pairs, list, tuple], _configuration: Optional[Configuration] = None, **kwargs: Union[AnyTypeSchema, dict, frozendict, str, date, datetime, UUID, int, float, Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

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

Do not edit the class manually.

minimalistic description of a pds product with only the key value pairs requested by the user (what you request is what you get)

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

class key_value_pairs(_arg: Union[Tuple[Union[items, dict, frozendict]], List[Union[items, dict, frozendict]]], _configuration: Optional[Configuration] = None)[source]

Bases: ListSchema

class MetaOapg[source]

Bases: object

class items(*_args: ~typing.Union[dict, ~frozendict.frozendict], key: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, value: ~typing.Union[~pds.api_client.schemas.StrSchema, str, ~pds.api_client.schemas.Unset] = <pds.api_client.schemas.Unset object>, _configuration: ~typing.Optional[~pds.api_client.configuration.Configuration] = None, **kwargs: ~typing.Union[~pds.api_client.schemas.AnyTypeSchema, dict, ~frozendict.frozendict, str, ~datetime.date, ~datetime.datetime, ~uuid.UUID, int, float, ~decimal.Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

key

alias of StrSchema

value

alias of StrSchema

get_item_oapg(name: Literal['key']) Union[MetaOapg.properties.key, schemas.Unset][source]
get_item_oapg(name: Literal['value']) Union[MetaOapg.properties.value, schemas.Unset]
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
required = {'key_value_pairs'}
get_item_oapg(name: Literal['key_value_pairs']) MetaOapg.properties.key_value_pairs[source]
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
key_value_pairs: key_value_pairs

pds.api_client.model.wyriwyg_products module

Registry 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 detailed syntax for querying the end-point is given in the reference documentation. # noqa: E501

The version of the OpenAPI document: 1.1 Contact: pds-operator@jpl.nasa.gov Generated by: https://openapi-generator.tech

class pds.api_client.model.wyriwyg_products.WyriwygProducts(*_args: Union[dict, frozendict], summary: Summary, data: Union[data, list, tuple], _configuration: Optional[Configuration] = None, **kwargs: Union[AnyTypeSchema, dict, frozendict, str, date, datetime, UUID, int, float, Decimal, None, list, tuple, bytes])[source]

Bases: DictSchema

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

Do not edit the class manually.

class MetaOapg[source]

Bases: object

class properties[source]

Bases: object

class data(_arg: Union[Tuple[WyriwygProduct], List[WyriwygProduct]], _configuration: Optional[Configuration] = None)[source]

Bases: ListSchema

class MetaOapg[source]

Bases: object

static items() Type[WyriwygProduct][source]
static summary() Type[Summary][source]
required = {'data', 'summary'}
data: data
get_item_oapg(name: Literal['summary']) Summary[source]
get_item_oapg(name: Literal['data']) MetaOapg.properties.data
get_item_oapg(name: str) Union[UnsetAnyTypeSchema, Unset]
summary: Summary

Module contents