api_client.api package

Submodules

api_client.api.bundles_api 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.api.bundles_api.BundlesApi(api_client=None)

Bases: object

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

Do not edit the class manually.

bundle_by_lidvid(lidvid, **kwargs)

bundle URN resolver for lidvid, get one bundle # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.bundle_by_lidvid(lidvid, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • lidvid (str) – lidvid (urn) (required)

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Product If the method is called asynchronously, returns the request thread.

bundle_by_lidvid_with_http_info(lidvid, **kwargs)

bundle URN resolver for lidvid, get one bundle # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.bundle_by_lidvid_with_http_info(lidvid, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • lidvid (str) – lidvid (urn) (required)

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Product, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_bundles(**kwargs)

request all PDS bundles # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_bundles(async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • start (int) – offset in matching result list, for pagination

  • limit (int) – maximum number of matching results returned, for pagination

  • q (str) – search query, complex query uses eq,ne,gt,ge,lt,le,(,),not,and,or. Properties are named as in ‘properties’ attributes, literals are strings between ” or numbers. Detailed query specification is available at https://bit.ly/393i1af

  • fields (list[str]) – returned fields, syntax field0,field1

  • sort (list[str]) – sort results, syntax asc(field0),desc(field1)

  • only_summary (bool) – only return the summary, useful to get the list of available properties

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Products If the method is called asynchronously, returns the request thread.

get_bundles_with_http_info(**kwargs)

request all PDS bundles # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_bundles_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • start (int) – offset in matching result list, for pagination

  • limit (int) – maximum number of matching results returned, for pagination

  • q (str) – search query, complex query uses eq,ne,gt,ge,lt,le,(,),not,and,or. Properties are named as in ‘properties’ attributes, literals are strings between ” or numbers. Detailed query specification is available at https://bit.ly/393i1af

  • fields (list[str]) – returned fields, syntax field0,field1

  • sort (list[str]) – sort results, syntax asc(field0),desc(field1)

  • only_summary (bool) – only return the summary, useful to get the list of available properties

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Products, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

api_client.api.bundles_collections_api 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.api.bundles_collections_api.BundlesCollectionsApi(api_client=None)

Bases: object

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

Do not edit the class manually.

collections_of_a_bundle(lidvid, **kwargs)

get collections belonging to a given bundle # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.collections_of_a_bundle(lidvid, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • lidvid (str) – lidvid (urn) (required)

  • start (int) – offset in matching result list, for pagination

  • limit (int) – maximum number of matching results returned, for pagination

  • fields (list[str]) – returned fields, syntax field0,field1

  • sort (list[str]) – sort results, syntax asc(field0),desc(field1)

  • only_summary (bool) – only return the summary, useful to get the list of available properties

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Products If the method is called asynchronously, returns the request thread.

collections_of_a_bundle_with_http_info(lidvid, **kwargs)

get collections belonging to a given bundle # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.collections_of_a_bundle_with_http_info(lidvid, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • lidvid (str) – lidvid (urn) (required)

  • start (int) – offset in matching result list, for pagination

  • limit (int) – maximum number of matching results returned, for pagination

  • fields (list[str]) – returned fields, syntax field0,field1

  • sort (list[str]) – sort results, syntax asc(field0),desc(field1)

  • only_summary (bool) – only return the summary, useful to get the list of available properties

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Products, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

api_client.api.capabilities_api 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.api.capabilities_api.CapabilitiesApi(api_client=None)

Bases: object

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

Do not edit the class manually.

capabilities(**kwargs)

capabilities api entry point, list the resources provided by the current API end-point. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.capabilities(async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[Capability] If the method is called asynchronously, returns the request thread.

capabilities_with_http_info(**kwargs)

capabilities api entry point, list the resources provided by the current API end-point. # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.capabilities_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[Capability], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

api_client.api.collections_api 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.api.collections_api.CollectionsApi(api_client=None)

Bases: object

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

Do not edit the class manually.

collections_by_lidvid(lidvid, **kwargs)

collections URN resolver for lidvid # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.collections_by_lidvid(lidvid, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • lidvid (str) – lidvid (urn) (required)

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Product If the method is called asynchronously, returns the request thread.

collections_by_lidvid_with_http_info(lidvid, **kwargs)

collections URN resolver for lidvid # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.collections_by_lidvid_with_http_info(lidvid, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • lidvid (str) – lidvid (urn) (required)

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Product, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

get_collection(**kwargs)

request PDS collections # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_collection(async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • start (int) – offset in matching result list, for pagination

  • limit (int) – maximum number of matching results returned, for pagination

  • q (str) – search query, complex query uses eq,ne,gt,ge,lt,le,(,),not,and,or. Properties are named as in ‘properties’ attributes, literals are strings between ” or numbers. Detailed query specification is available at https://bit.ly/393i1af

  • fields (list[str]) – returned fields, syntax field0,field1

  • sort (list[str]) – sort results, syntax asc(field0),desc(field1)

  • only_summary (bool) – only return the summary, useful to get the list of available properties

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Products If the method is called asynchronously, returns the request thread.

get_collection_with_http_info(**kwargs)

request PDS collections # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_collection_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • start (int) – offset in matching result list, for pagination

  • limit (int) – maximum number of matching results returned, for pagination

  • q (str) – search query, complex query uses eq,ne,gt,ge,lt,le,(,),not,and,or. Properties are named as in ‘properties’ attributes, literals are strings between ” or numbers. Detailed query specification is available at https://bit.ly/393i1af

  • fields (list[str]) – returned fields, syntax field0,field1

  • sort (list[str]) – sort results, syntax asc(field0),desc(field1)

  • only_summary (bool) – only return the summary, useful to get the list of available properties

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Products, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

api_client.api.collections_products_api 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.api.collections_products_api.CollectionsProductsApi(api_client=None)

Bases: object

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

Do not edit the class manually.

products_of_a_collection(lidvid, **kwargs)

get producs belonging to a given collection # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.products_of_a_collection(lidvid, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • lidvid (str) – lidvid (urn) (required)

  • start (int) – offset in matching result list, for pagination

  • limit (int) – maximum number of matching results returned, for pagination

  • fields (list[str]) – returned fields, syntax field0,field1

  • sort (list[str]) – sort results, syntax asc(field0),desc(field1)

  • only_summary (bool) – only return the summary, useful to get the list of available properties

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Products If the method is called asynchronously, returns the request thread.

products_of_a_collection_with_http_info(lidvid, **kwargs)

get producs belonging to a given collection # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.products_of_a_collection_with_http_info(lidvid, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • lidvid (str) – lidvid (urn) (required)

  • start (int) – offset in matching result list, for pagination

  • limit (int) – maximum number of matching results returned, for pagination

  • fields (list[str]) – returned fields, syntax field0,field1

  • sort (list[str]) – sort results, syntax asc(field0),desc(field1)

  • only_summary (bool) – only return the summary, useful to get the list of available properties

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Products, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

api_client.api.products_api 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.api.products_api.ProductsApi(api_client=None)

Bases: object

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

Do not edit the class manually.

products(**kwargs)

search across all PDS data products, including bundles, collections, documentation, context and observational products, # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.products(async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • start (int) – offset in matching result list, for pagination

  • limit (int) – maximum number of matching results returned, for pagination

  • q (str) – search query

  • fields (list[str]) – returned fields, syntax field0,field1

  • sort (list[str]) – sort results, syntax asc(field0),desc(field1)

  • only_summary (bool) – only return the summary, useful to get the list of available properties

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Products If the method is called asynchronously, returns the request thread.

products_by_lidvid(lidvid, **kwargs)

URN resolver for lidvid # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.products_by_lidvid(lidvid, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • lidvid (str) – lidvid (urn) (required)

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

Product If the method is called asynchronously, returns the request thread.

products_by_lidvid_with_http_info(lidvid, **kwargs)

URN resolver for lidvid # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.products_by_lidvid_with_http_info(lidvid, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • lidvid (str) – lidvid (urn) (required)

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Product, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

products_with_http_info(**kwargs)

search across all PDS data products, including bundles, collections, documentation, context and observational products, # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.products_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • start (int) – offset in matching result list, for pagination

  • limit (int) – maximum number of matching results returned, for pagination

  • q (str) – search query

  • fields (list[str]) – returned fields, syntax field0,field1

  • sort (list[str]) – sort results, syntax asc(field0),desc(field1)

  • only_summary (bool) – only return the summary, useful to get the list of available properties

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(Products, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

api_client.api.routes_api 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.api.routes_api.RoutesApi(api_client=None)

Bases: object

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

Do not edit the class manually.

all_routes(**kwargs)

all_routes # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.all_routes(async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

list[Route] If the method is called asynchronously, returns the request thread.

all_routes_with_http_info(**kwargs)

all_routes # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.all_routes_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

tuple(list[Route], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.

routes(resource, **kwargs)

routes # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.routes(resource, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • resource (str) – requested action as a request path, e.g. ‘/record’ (required)

  • version (str) –

  • query (str) – query parameter on the action, e.g. lidvid urn for a ‘/records’ action

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

routes_with_http_info(resource, **kwargs)

routes # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.routes_with_http_info(resource, async_req=True) >>> result = thread.get()

Parameters

  • bool (async_req) – execute request asynchronously

  • resource (str) – requested action as a request path, e.g. ‘/record’ (required)

  • version (str) –

  • query (str) – query parameter on the action, e.g. lidvid urn for a ‘/records’ action

  • _return_http_data_only – response data without head status code and headers

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

Module contents