pystac.common_metadata#

class pystac.common_metadata.CommonMetadata(object: Asset | Item)[source]

Object containing fields that are not included in core item schema but are still commonly used. All attributes are defined within the properties of this item and are optional

Parameters:: properties – Dictionary of attributes that is the Item’s properties

property constellation: str | None: Gets or set the name of the constellation associate with an object.

property created: datetime | None: Get or set the metadata file’s creation date. All datetime attributes have setters that can take either a string or a datetime, but always stores the attribute as a string.

Note

created has a different meaning depending on the type of STAC object. On an Item, it refers to the creation time of the metadata. On an Asset, it refers to the creation time of the actual data linked to in href.

property description: str | None: Gets or set the object’s description.

property end_datetime: datetime | None: Get or set the item’s end_datetime.

Note

end_datetime is an inclusive datetime.

property gsd: float | None: Gets or sets the Ground Sample Distance at the sensor.

property instruments: list[str] | None: Gets or sets the names of the instruments used.

property keywords: list[str] | None: Get or set the keywords describing the STAC entity.

property license: str | None: Get or set the current license. License should be provided as a SPDX License identifier, or other. If object includes data with multiple different licenses, use other and add a link for each.

Note

The licenses various and proprietary are deprecated.

property mission: str | None: Gets or set the name of the mission associated with an object.

object: Asset | Item: The object from which common metadata is obtained.

property platform: str | None: Gets or set the object’s platform attribute.

property providers: list[Provider] | None: Get or set a list of the object’s providers.

property roles: list[str] | None: Get or set the semantic roles of the entity.

property start_datetime: datetime | None: Get or set the object’s start_datetime.

Note

start_datetime is an inclusive datetime.

property title: str | None: Gets or set the object’s title.

property updated: datetime | None: Get or set the metadata file’s update date. All datetime attributes have setters that can take either a string or a datetime, but always stores the attribute as a string

Note

updated has a different meaning depending on the type of STAC object. On an Item, it refers to the update time of the metadata. On an Asset, it refers to the update time of the actual data linked to in href.