api_client.models package¶

Submodules¶

api_client.models.capability module¶

Planetary Data System API

Federated PDS API which provides actionable end points standardized between the different nodes. # noqa: E501

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

class api_client.models.capability.Capability(action=None, version=None, local_vars_configuration=None)¶

Bases: object

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

Do not edit the class manually.

property action¶

Gets the action of this Capability. # noqa: E501

Returns: The action of this Capability. # noqa: E501
Return type: str

attribute_map = {'action': 'action', 'version': 'version'}¶

openapi_types = {'action': 'str', 'version': 'str'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property version¶

Gets the version of this Capability. # noqa: E501

Returns: The version of this Capability. # noqa: E501
Return type: str

api_client.models.collection module¶

Planetary Data System API

Federated PDS API which provides actionable end points standardized between the different nodes. # noqa: E501

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

class api_client.models.collection.Collection(id=None, title=None, description=None, instruments=None, targets=None, optional_properties=None, local_vars_configuration=None)¶

Bases: object

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

Do not edit the class manually.

attribute_map = {'description': 'description', 'id': 'id', 'instruments': 'instruments', 'optional_properties': 'optional_properties', 'targets': 'targets', 'title': 'title'}¶

property description¶

Gets the description of this Collection. # noqa: E501

Returns: The description of this Collection. # noqa: E501
Return type: str

property id¶

Gets the id of this Collection. # noqa: E501

identifier lidvid of the collection # noqa: E501

Returns: The id of this Collection. # noqa: E501
Return type: str

property instruments¶

Gets the instruments of this Collection. # noqa: E501

identifier lidvid of the instrument or procedure generating the data # noqa: E501

Returns: The instruments of this Collection. # noqa: E501
Return type: list[str]

openapi_types = {'description': 'str', 'id': 'str', 'instruments': 'list[str]', 'optional_properties': 'dict(str, list[str])', 'targets': 'list[str]', 'title': 'str'}¶

property optional_properties¶

Gets the optional_properties of this Collection. # noqa: E501

Returns: The optional_properties of this Collection. # noqa: E501
Return type: dict(str, list[str])

property targets¶

Gets the targets of this Collection. # noqa: E501

identifier lidvid of the target of the observation # noqa: E501

Returns: The targets of this Collection. # noqa: E501
Return type: list[str]

property title¶

Gets the title of this Collection. # noqa: E501

Returns: The title of this Collection. # noqa: E501
Return type: str

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

api_client.models.collections module¶

Planetary Data System API

Federated PDS API which provides actionable end points standardized between the different nodes. # noqa: E501

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

class api_client.models.collections.Collections(metadata=None, data=None, local_vars_configuration=None)¶

Bases: object

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

Do not edit the class manually.

attribute_map = {'data': 'data', 'metadata': 'metadata'}¶

property data¶

Gets the data of this Collections. # noqa: E501

Returns: The data of this Collections. # noqa: E501
Return type: list[Collection]

property metadata¶

Gets the metadata of this Collections. # noqa: E501

Returns: The metadata of this Collections. # noqa: E501
Return type: Metadata

openapi_types = {'data': 'list[Collection]', 'metadata': 'Metadata'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

api_client.models.error_message module¶

Planetary Data System API

Federated PDS API which provides actionable end points standardized between the different nodes. # noqa: E501

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

class api_client.models.error_message.ErrorMessage(url=None, resource=None, query=None, message=None, local_vars_configuration=None)¶

Bases: object

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

Do not edit the class manually.

attribute_map = {'message': 'message', 'query': 'query', 'resource': 'resource', 'url': 'url'}¶

property message¶

Gets the message of this ErrorMessage. # noqa: E501

Returns: The message of this ErrorMessage. # noqa: E501
Return type: str

openapi_types = {'message': 'str', 'query': 'str', 'resource': 'str', 'url': 'str'}¶

property query¶

Gets the query of this ErrorMessage. # noqa: E501

Returns: The query of this ErrorMessage. # noqa: E501
Return type: str

property resource¶

Gets the resource of this ErrorMessage. # noqa: E501

Returns: The resource of this ErrorMessage. # noqa: E501
Return type: str

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property url¶

Gets the url of this ErrorMessage. # noqa: E501

Returns: The url of this ErrorMessage. # noqa: E501
Return type: str

api_client.models.metadata module¶

Planetary Data System API

Federated PDS API which provides actionable end points standardized between the different nodes. # noqa: E501

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

class api_client.models.metadata.Metadata(creation_date_time=None, update_date_time=None, version=None, label_url=None, local_vars_configuration=None)¶

Bases: object

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

Do not edit the class manually.

attribute_map = {'creation_date_time': 'creation_date_time', 'label_url': 'label_url', 'update_date_time': 'update_date_time', 'version': 'version'}¶

property creation_date_time¶

Gets the creation_date_time of this Metadata. # noqa: E501

Returns: The creation_date_time of this Metadata. # noqa: E501
Return type: str

property label_url¶

Gets the label_url of this Metadata. # noqa: E501

Returns: The label_url of this Metadata. # noqa: E501
Return type: str

openapi_types = {'creation_date_time': 'str', 'label_url': 'str', 'update_date_time': 'str', 'version': 'str'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property update_date_time¶

Gets the update_date_time of this Metadata. # noqa: E501

Returns: The update_date_time of this Metadata. # noqa: E501
Return type: str

property version¶

Gets the version of this Metadata. # noqa: E501

Returns: The version of this Metadata. # noqa: E501
Return type: str

api_client.models.product module¶

Planetary Data System API

Federated PDS API which provides actionable end points standardized between the different nodes. # noqa: E501

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

class api_client.models.product.Product(id=None, type=None, title=None, description=None, start_date_time=None, stop_date_time=None, investigations=None, observing_system_components=None, targets=None, metadata=None, properties=None, local_vars_configuration=None)¶

Bases: object

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

Do not edit the class manually.

attribute_map = {'description': 'description', 'id': 'id', 'investigations': 'investigations', 'metadata': 'metadata', 'observing_system_components': 'observing_system_components', 'properties': 'properties', 'start_date_time': 'start_date_time', 'stop_date_time': 'stop_date_time', 'targets': 'targets', 'title': 'title', 'type': 'type'}¶

property description¶

Gets the description of this Product. # noqa: E501

Returns: The description of this Product. # noqa: E501
Return type: str

property id¶

Gets the id of this Product. # noqa: E501

identifier lidvid of the collection # noqa: E501

Returns: The id of this Product. # noqa: E501
Return type: str

property investigations¶

Gets the investigations of this Product. # noqa: E501

list of missions or observing campaigns which produced the data # noqa: E501

Returns: The investigations of this Product. # noqa: E501
Return type: list[Reference]

property metadata¶

Gets the metadata of this Product. # noqa: E501

Returns: The metadata of this Product. # noqa: E501
Return type: Metadata

property observing_system_components¶

Gets the observing_system_components of this Product. # noqa: E501

list of instruments or platforms generating the data # noqa: E501

Returns: The observing_system_components of this Product. # noqa: E501
Return type: list[Reference]

openapi_types = {'description': 'str', 'id': 'str', 'investigations': 'list[Reference]', 'metadata': 'Metadata', 'observing_system_components': 'list[Reference]', 'properties': 'dict(str, list)', 'start_date_time': 'str', 'stop_date_time': 'str', 'targets': 'list[Reference]', 'title': 'str', 'type': 'str'}¶

property properties¶

Gets the properties of this Product. # noqa: E501

properties extracted from pds4 model, syntax for property name is <namespace>:<property>[/<namespace>:<property>]* # noqa: E501

Returns: The properties of this Product. # noqa: E501
Return type: dict(str, list)

property start_date_time¶

Gets the start_date_time of this Product. # noqa: E501

start date time of the observations in ISO8601 # noqa: E501

Returns: The start_date_time of this Product. # noqa: E501
Return type: str

property stop_date_time¶

Gets the stop_date_time of this Product. # noqa: E501

stop date time of the observations in ISO8601 # noqa: E501

Returns: The stop_date_time of this Product. # noqa: E501
Return type: str

property targets¶

Gets the targets of this Product. # noqa: E501

list of targets or feature of interest the observation. # noqa: E501

Returns: The targets of this Product. # noqa: E501
Return type: list[Reference]

property title¶

Gets the title of this Product. # noqa: E501

Returns: The title of this Product. # noqa: E501
Return type: str

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property type¶

Gets the type of this Product. # noqa: E501

Returns: The type of this Product. # noqa: E501
Return type: str

api_client.models.products module¶

Planetary Data System API

Federated PDS API which provides actionable end points standardized between the different nodes. # noqa: E501

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

class api_client.models.products.Products(summary=None, data=None, local_vars_configuration=None)¶

Bases: object

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

Do not edit the class manually.

attribute_map = {'data': 'data', 'summary': 'summary'}¶

property data¶

Gets the data of this Products. # noqa: E501

Returns: The data of this Products. # noqa: E501
Return type: list[Product]

openapi_types = {'data': 'list[Product]', 'summary': 'Summary'}¶

property summary¶

Gets the summary of this Products. # noqa: E501

Returns: The summary of this Products. # noqa: E501
Return type: Summary

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

api_client.models.reference module¶

Planetary Data System API

Federated PDS API which provides actionable end points standardized between the different nodes. # noqa: E501

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

class api_client.models.reference.Reference(title=None, id=None, href=None, type=None, description=None, local_vars_configuration=None)¶

Bases: object

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

Do not edit the class manually.

attribute_map = {'description': 'description', 'href': 'href', 'id': 'id', 'title': 'title', 'type': 'type'}¶

property description¶

Gets the description of this Reference. # noqa: E501

longer description for the external reference, can be displayed in a tooltip # noqa: E501

Returns: The description of this Reference. # noqa: E501
Return type: str

property href¶

Gets the href of this Reference. # noqa: E501

external reference url of the current reference resolvable by the current API server, http://pds.nasa.gov/api/products/urn:nasa… # noqa: E501

Returns: The href of this Reference. # noqa: E501
Return type: str

property id¶

Gets the id of this Reference. # noqa: E501

external reference, here lidvid urn # noqa: E501

Returns: The id of this Reference. # noqa: E501
Return type: str

openapi_types = {'description': 'str', 'href': 'str', 'id': 'str', 'title': 'str', 'type': 'str'}¶

property title¶

Gets the title of this Reference. # noqa: E501

name to display for the external reference # noqa: E501

Returns: The title of this Reference. # noqa: E501
Return type: str

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property type¶

Gets the type of this Reference. # noqa: E501

type of the external reference, can be displayed as an icon for example # noqa: E501

Returns: The type of this Reference. # noqa: E501
Return type: str

api_client.models.route module¶

Planetary Data System API

Federated PDS API which provides actionable end points standardized between the different nodes. # noqa: E501

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

class api_client.models.route.Route(resource=None, query=None, url=None, local_vars_configuration=None)¶

Bases: object

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

Do not edit the class manually.

attribute_map = {'query': 'query', 'resource': 'resource', 'url': 'url'}¶

openapi_types = {'query': 'str', 'resource': 'str', 'url': 'str'}¶

property query¶

Gets the query of this Route. # noqa: E501

Returns: The query of this Route. # noqa: E501
Return type: str

property resource¶

Gets the resource of this Route. # noqa: E501

Returns: The resource of this Route. # noqa: E501
Return type: str

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

property url¶

Gets the url of this Route. # noqa: E501

Returns: The url of this Route. # noqa: E501
Return type: str

api_client.models.summary module¶

Planetary Data System API

Federated PDS API which provides actionable end points standardized between the different nodes. # noqa: E501

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

class api_client.models.summary.Summary(q=None, start=None, limit=None, sort=None, properties=None, local_vars_configuration=None)¶

Bases: object

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

Do not edit the class manually.

attribute_map = {'limit': 'limit', 'properties': 'properties', 'q': 'q', 'sort': 'sort', 'start': 'start'}¶

property limit¶

Gets the limit of this Summary. # noqa: E501

Returns: The limit of this Summary. # noqa: E501
Return type: int

openapi_types = {'limit': 'int', 'properties': 'list[str]', 'q': 'str', 'sort': 'list[str]', 'start': 'int'}¶

property properties¶

Gets the properties of this Summary. # noqa: E501

Returns: The properties of this Summary. # noqa: E501
Return type: list[str]

property q¶

Gets the q of this Summary. # noqa: E501

Returns: The q of this Summary. # noqa: E501
Return type: str

property sort¶

Gets the sort of this Summary. # noqa: E501

Returns: The sort of this Summary. # noqa: E501
Return type: list[str]

property start¶

Gets the start of this Summary. # noqa: E501

Returns: The start of this Summary. # noqa: E501
Return type: int

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

Module contents¶

Planetary Data System API

Federated PDS API which provides actionable end points standardized between the different nodes. # noqa: E501

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