gfwapiclient.resources.events.stats.models.request

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

Module Contents

Classes

EventStatsTimeSeriesInterval	Granularity for time series event statistics.
EventStatsInclude	Additional information to include in event statistics.
EventStatsBody	Request body for retrieving event statistics.

Data

__all__
EVENT_STATS_REQUEST_BODY_VALIDATION_ERROR_MESSAGE

API

gfwapiclient.resources.events.stats.models.request.__all__ = ['EventStatsBody']

gfwapiclient.resources.events.stats.models.request.EVENT_STATS_REQUEST_BODY_VALIDATION_ERROR_MESSAGE: Final[str] = 'Get events statistics request body validation failed.'

class gfwapiclient.resources.events.stats.models.request.EventStatsTimeSeriesInterval

Bases: str, enum.Enum

Granularity for time series event statistics.

Initialization

Initialize self. See help(type(self)) for accurate signature.

HOUR = 'HOUR'

DAY = 'DAY'

MONTH = 'MONTH'

YEAR = 'YEAR'

class gfwapiclient.resources.events.stats.models.request.EventStatsInclude

Bases: str, enum.Enum

Additional information to include in event statistics.

Initialization

Initialize self. See help(type(self)) for accurate signature.

TOTAL_COUNT = 'TOTAL_COUNT'

TIME_SERIES = 'TIME_SERIES'

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

Bases: gfwapiclient.resources.events.base.models.request.EventBaseBody

Request body for retrieving event statistics.

Attributes:

timeseries_interval (Optional[EventStatsTimeSeriesInterval]):

Granularity of the time series data.

includes (Optional[List[EventStatsInclude]]):

List of additional information to include in the response.

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.

timeseries_interval: Optional[gfwapiclient.resources.events.stats.models.request.EventStatsTimeSeriesInterval] = 'Field(...)'

includes: Optional[List[gfwapiclient.resources.events.stats.models.request.EventStatsInclude]] = 'Field(...)'