pds.api_client.api.by_product_classes_api 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.api.by_product_classes_api.ByProductClassesApi(api_client=None)[source]

Bases: object

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

Do not edit the class manually.

class_list[source]

returns all PDS products of the given PDS product class that meet all given constraints.

Parameters:

  • var_class (str) – syntax: one of the allowable enum values This is a shortcut for doing a query with … (required)

  • fields (List[str]) – syntax: fields=field1,field2,… behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

  • keywords (List[str]) – syntax: keyword=keyword1,keyword2,… behavior: free text search on title and description (if set q is ignored

  • limit (int) – syntax: limit=10 behavior: maximum number of matching results returned, for pagination

  • q (str) – syntax: q=”vid eq 13.0” behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in ‘properties’ attributes, literals are strings between quotes, like “animal”, or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present

  • sort (List[str]) – syntax: sort=field0,field1,… behavior: currently only sorts ascending

  • search_after (List[str]) – syntax: search-after=sortField0Value,sortField1Value,… behavior: for each field specified in the “sort” qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time

  • _request_timeout (int, tuple(int, int), optional) – 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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

class_list_with_http_info[source]

returns all PDS products of the given PDS product class that meet all given constraints.

Parameters:

  • var_class (str) – syntax: one of the allowable enum values This is a shortcut for doing a query with … (required)

  • fields (List[str]) – syntax: fields=field1,field2,… behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

  • keywords (List[str]) – syntax: keyword=keyword1,keyword2,… behavior: free text search on title and description (if set q is ignored

  • limit (int) – syntax: limit=10 behavior: maximum number of matching results returned, for pagination

  • q (str) – syntax: q=”vid eq 13.0” behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in ‘properties’ attributes, literals are strings between quotes, like “animal”, or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present

  • sort (List[str]) – syntax: sort=field0,field1,… behavior: currently only sorts ascending

  • search_after (List[str]) – syntax: search-after=sortField0Value,sortField1Value,… behavior: for each field specified in the “sort” qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time

  • _request_timeout (int, tuple(int, int), optional) – 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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

class_list_without_preload_content[source]

returns all PDS products of the given PDS product class that meet all given constraints.

Parameters:

  • var_class (str) – syntax: one of the allowable enum values This is a shortcut for doing a query with … (required)

  • fields (List[str]) – syntax: fields=field1,field2,… behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

  • keywords (List[str]) – syntax: keyword=keyword1,keyword2,… behavior: free text search on title and description (if set q is ignored

  • limit (int) – syntax: limit=10 behavior: maximum number of matching results returned, for pagination

  • q (str) – syntax: q=”vid eq 13.0” behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in ‘properties’ attributes, literals are strings between quotes, like “animal”, or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present

  • sort (List[str]) – syntax: sort=field0,field1,… behavior: currently only sorts ascending

  • search_after (List[str]) – syntax: search-after=sortField0Value,sortField1Value,… behavior: for each field specified in the “sort” qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time

  • _request_timeout (int, tuple(int, int), optional) – 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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

classes[source]

returns a list of the available PDS product class at this API. This is not all of the PDS product class available in the database, but simply the names that can be used in the /classes/{class} endpoints.

Parameters:

  • _request_timeout (int, tuple(int, int), optional) – 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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

classes_with_http_info[source]

returns a list of the available PDS product class at this API. This is not all of the PDS product class available in the database, but simply the names that can be used in the /classes/{class} endpoints.

Parameters:

  • _request_timeout (int, tuple(int, int), optional) – 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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

classes_without_preload_content[source]

returns a list of the available PDS product class at this API. This is not all of the PDS product class available in the database, but simply the names that can be used in the /classes/{class} endpoints.

Parameters:

  • _request_timeout (int, tuple(int, int), optional) – 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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.