gfwapiclient.resources.datasets.models.response

Global Fishing Watch (GFW) API Python Client - Datasets API Response Models.

Module Contents

Classes

SARFixedInfrastructureItem	SAR fixed infrastructure item.
SARFixedInfrastructureResult	Result for Get SAR fixed infrastructure API endpoint.

Data

__all__

API

gfwapiclient.resources.datasets.models.response.__all__ = ['SARFixedInfrastructureItem', 'SARFixedInfrastructureResult']

class gfwapiclient.resources.datasets.models.response.SARFixedInfrastructureItem(/, **data: typing.Any)

Bases: gfwapiclient.http.models.response.ResultItem

SAR fixed infrastructure item.

Attributes:

structure_id (int):

Unique identifier for all detections of the same structure.

lat (Optional[float]):

Latitude of the structure.

lon (Optional[float]):

Longitude of the structure.

label (Optional[str]):

Predicted structure type: oil, wind, or unknown.

structure_start_date (Optional[datetime.datetime]):

The first date the structure was detected.

structure_end_date (Optional[datetime.datetime]):

The last date the structure was detected.

label_confidence (Optional[str]):

Label confidence level: high, medium, or low.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

structure_id: Optional[int] = 'Field(...)'

lat: Optional[float] = 'Field(...)'

lon: Optional[float] = 'Field(...)'

label: Optional[str] = 'Field(...)'

structure_start_date: Optional[datetime.datetime] = 'Field(...)'

structure_end_date: Optional[datetime.datetime] = 'Field(...)'

label_confidence: Optional[str] = None

classmethod epoch_to_utc_datetime_or_none(value: Any) → Optional[Any]

Convert an epoch timestamp (milliseconds) to a UTC datetime object or None.

Args:

value (Any):

The epoch value (in milliseconds) to validate.

Returns:

Optional[datetime.datetime]:

The validated and parsed UTC datetime, or None if the input was empty or None-like.

class gfwapiclient.resources.datasets.models.response.SARFixedInfrastructureResult(data: List[gfwapiclient.resources.datasets.models.response.SARFixedInfrastructureItem])

Bases: gfwapiclient.http.models.response.Result[gfwapiclient.resources.datasets.models.response.SARFixedInfrastructureItem]

Result for Get SAR fixed infrastructure API endpoint.

Initialization

Initializes a new FixedInfrastructureResult.

Args:

data (List[SARFixedInfrastructureItem]):

The list of SAR fixed infrastructure items.

_result_item_class: Type[gfwapiclient.resources.datasets.models.response.SARFixedInfrastructureItem] = None

_data: List[gfwapiclient.resources.datasets.models.response.SARFixedInfrastructureItem] = None