gfwapiclient.resources.events.base.models.request

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

Module Contents

Classes

EventType	Type of event.
EventConfidence	Confidence level of the event.
EventEncounterType	Type of encounter event.
EventVesselType	Type of vessel involved in the event.
EventDataset	Dataset containing the events.
EventGeometry	GeoJSON-like region where the events occur.
EventRegion	Region where the events occur.
EventBaseBody	Base request body for retrieving all events and event statistics.

Data

__all__

API

gfwapiclient.resources.events.base.models.request.__all__ = ['EventBaseBody', 'EventConfidence', 'EventDataset', 'EventEncounterType', 'EventGeometry', 'EventRe...

class gfwapiclient.resources.events.base.models.request.EventType

Bases: str, enum.Enum

Type of event.

Initialization

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

ENCOUNTER = 'ENCOUNTER'

FISHING = 'FISHING'

GAP = 'GAP'

GAP_START = 'GAP_START'

LOITERING = 'LOITERING'

PORT = 'PORT'

PORT_VISIT = 'PORT_VISIT'

class gfwapiclient.resources.events.base.models.request.EventConfidence

Bases: str, enum.Enum

Confidence level of the event.

Initialization

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

LOW = '2'

MEDIUM = '3'

HIGH = '4'

class gfwapiclient.resources.events.base.models.request.EventEncounterType

Bases: str, enum.Enum

Type of encounter event.

Initialization

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

CARRIER_FISHING = 'CARRIER-FISHING'

FISHING_CARRIER = 'FISHING-CARRIER'

FISHING_SUPPORT = 'FISHING-SUPPORT'

SUPPORT_FISHING = 'SUPPORT-FISHING'

FISHING_BUNKER = 'FISHING-BUNKER'

BUNKER_FISHING = 'BUNKER-FISHING'

FISHING_FISHING = 'FISHING-FISHING'

FISHING_TANKER = 'FISHING-TANKER'

TANKER_FISHING = 'TANKER-FISHING'

CARRIER_BUNKER = 'CARRIER-BUNKER'

BUNKER_CARRIER = 'BUNKER-CARRIER'

SUPPORT_BUNKER = 'SUPPORT-BUNKER'

BUNKER_SUPPORT = 'BUNKER-SUPPORT'

class gfwapiclient.resources.events.base.models.request.EventVesselType

Bases: str, enum.Enum

Type of vessel involved in the event.

Initialization

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

BUNKER = 'BUNKER'

CARGO = 'CARGO'

DISCREPANCY = 'DISCREPANCY'

CARRIER = 'CARRIER'

FISHING = 'FISHING'

GEAR = 'GEAR'

OTHER = 'OTHER'

PASSENGER = 'PASSENGER'

SEISMIC_VESSEL = 'SEISMIC_VESSEL'

SUPPORT = 'SUPPORT'

class gfwapiclient.resources.events.base.models.request.EventDataset

Bases: str, enum.Enum

Dataset containing the events.

Initialization

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

ENCOUNTERS_EVENTS_LATEST = 'public-global-encounters-events:latest'

FISHING_EVENTS_LATEST = 'public-global-fishing-events:latest'

GAPS_EVENTS_LATEST = 'public-global-gaps-events:latest'

LOITERING_EVENTS_LATEST = 'public-global-loitering-events:latest'

PORT_VISITS_EVENTS_LATEST = 'public-global-port-visits-events:latest'

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

Bases: gfwapiclient.base.models.BaseModel

GeoJSON-like region where the events occur.

Attributes:

type (str):

The GeoJSON geometry type (e.g., “Polygon”).

coordinates (Any):

The GeoJSON coordinates.

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.

type: str = 'Field(...)'

coordinates: Any = 'Field(...)'

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

Bases: gfwapiclient.base.models.BaseModel

Region where the events occur.

Attributes:

dataset (str):

The dataset containing the region.

id (str):

The region ID.

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.

dataset: str = 'Field(...)'

id: str = 'Field(...)'

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

Bases: gfwapiclient.http.models.request.RequestBody

Base request body for retrieving all events and event statistics.

Attributes:

datasets (List[EventDataset]):

Datasets to use for searching vessel events.

vessels (Optional[List[str]]):

List of vessel IDs to filter by.

types (Optional[List[EventType]]):

Event types to filter by.

start_date (Optional[datetime.date]):

Start date of the events (inclusive).

end_date (Optional[datetime.date]):

End date of the events (exclusive).

confidences (Optional[List[EventConfidence]]):

Confidence levels of the events.

encounter_types (Optional[List[EventEncounterType]]):

Encounter types to filter by.

duration (Optional[int]):

Minimum duration (in minutes) of the events.

vessel_groups (Optional[List[str]]):

IDs of the vessel groups to filter by.

flags (Optional[List[str]]):

Flags (in ISO3 format) of the vessels involved in the events.

geometry (Optional[EventGeometry]):

Region where the events occur (GeoJSON).

region (Optional[EventRegion]):

Region where the events occur (by dataset and ID).

vessel_types (Optional[List[EventVesselType]]):

Vessel types to filter by.

gap_intentional_disabling (Optional[bool]):

Whether to retrieve AIS off events (gaps) that were potentially intentional.

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.

datasets: List[gfwapiclient.resources.events.base.models.request.EventDataset] = 'Field(...)'

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

types: Optional[List[gfwapiclient.resources.events.base.models.request.EventType]] = 'Field(...)'

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

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

confidences: Optional[List[gfwapiclient.resources.events.base.models.request.EventConfidence]] = 'Field(...)'

encounter_types: Optional[List[gfwapiclient.resources.events.base.models.request.EventEncounterType]] = 'Field(...)'

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

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

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

geometry: Optional[gfwapiclient.resources.events.base.models.request.EventGeometry] = 'Field(...)'

region: Optional[gfwapiclient.resources.events.base.models.request.EventRegion] = 'Field(...)'

vessel_types: Optional[List[gfwapiclient.resources.events.base.models.request.EventVesselType]] = 'Field(...)'

gap_intentional_disabling: Optional[bool] = 'Field(...)'