Documentation for Collection Results
Bases: CustomDict
Dictionary-like object to represent a data collection from CMR.
abstract()
Placeholder.
Returns:
| Type | Description |
|---|---|
str
|
The abstract of a collection. |
concept_id()
Placeholder.
Returns:
| Type | Description |
|---|---|
str
|
A collection's |
data_type()
Placeholder.
Returns:
| Type | Description |
|---|---|
str
|
The collection data type, i.e. HDF5, CSV etc., if available. |
get_data()
Placeholder.
Returns:
| Type | Description |
|---|---|
List[str]
|
The GET DATA links (usually a landing page link, a DAAC portal, or an FTP location). |
get_umm(umm_field)
Placeholder.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
umm_field
|
str
|
Valid UMM item, i.e. |
required |
Returns:
| Type | Description |
|---|---|
Union[str, Dict[str, Any]]
|
The value of a given field inside the UMM (Unified Metadata Model). |
landing_page()
Placeholder.
Returns:
| Type | Description |
|---|---|
str
|
The first landing page for the collection (can be many), if available. |
s3_bucket()
Placeholder.
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
The S3 bucket information if the collection has it (cloud hosted collections only). |
services()
Return list of services available for this collection.
summary()
Summary containing short_name, concept-id, file-type, and cloud-info (if cloud-hosted).
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
A summary of the collection metadata. |
version()
Placeholder.
Returns:
| Type | Description |
|---|---|
str
|
The collection's version. |