gfwapiclient.resources.events.stats.models.response

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

Module Contents

Classes

EventStatsTimeSeries	Time series data for event statistics.
EventStatsItem	Event statistics result item.
EventStatsResult	Result containing event statistics.

Data

__all__

API

gfwapiclient.resources.events.stats.models.response.__all__ = ['EventStatsItem', 'EventStatsResult']

class gfwapiclient.resources.events.stats.models.response.EventStatsTimeSeries(/, **data: typing.Any)

Bases: pydantic.BaseModel

Time series data for event statistics.

Attributes:

date (Optional[datetime.datetime]):

Date and time of the data point.

value (Optional[int]):

Number of events at the given date and time.

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.

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

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

class gfwapiclient.resources.events.stats.models.response.EventStatsItem(/, **data: typing.Any)

Bases: gfwapiclient.http.models.ResultItem

Event statistics result item.

Attributes:

num_events (Optional[int]):

Total number of events.

num_flags (Optional[int]):

Number of distinct vessel flags.

num_vessels (Optional[int]):

Number of distinct vessels.

flags (Optional[List[str]]):

List of distinct vessel flags.

timeseries (Optional[List[EventStatsTimeSeries]]):

Time series data of event counts.

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.

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

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

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

flags: Optional[List[str]] = 'Field(...)'

timeseries: Optional[List[gfwapiclient.resources.events.stats.models.response.EventStatsTimeSeries]] = 'Field(...)'

class gfwapiclient.resources.events.stats.models.response.EventStatsResult(data: gfwapiclient.resources.events.stats.models.response.EventStatsItem)

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.events.stats.models.response.EventStatsItem]

Result containing event statistics.

Initialization

Initializes a new EventStatsResult instance.

Args:

data (EventStatsItem):

The event statistics data.

_result_item_class: Type[gfwapiclient.resources.events.stats.models.response.EventStatsItem] = None

_data: gfwapiclient.resources.events.stats.models.response.EventStatsItem = None