gfwapiclient.resources.events.base.models.response

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

Module Contents

Classes

EventPosition	Position of the event.
EventRegions	Regions associated with the event.
EventDistances	Distances related to the event.
EventVesselPublicAuthorization	Public authorization details of the vessel involved in the event.
EventVessel	Vessel involved in the event.
EventEncounter	Encounter event details.
EventFishing	Fishing event details.
Gap	Gap event details.
EventLoitering	Loitering event details.
EventPortVisitAnchorage	Port visit anchorage details.
EventPortVisit	Port visit event details.
EventItem	Event item details.

Data

__all__

API

gfwapiclient.resources.events.base.models.response.__all__ = ['EventItem']

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

Bases: gfwapiclient.base.models.BaseModel

Position of the event.

Attributes:

lat (Optional[float]):

Latitude of the event.

lon (Optional[float]):

Longitude of the event.

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.

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

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

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

Bases: gfwapiclient.base.models.BaseModel

Regions associated with the event.

Attributes:

mpa (Optional[List[str]]):

Marine Protected Areas.

eez (Optional[List[str]]):

Exclusive Economic Zones.

rfmo (Optional[List[str]]):

Regional Fisheries Management Organizations.

fao (Optional[List[str]]):

Food and Agriculture Organization areas.

major_fao (Optional[List[str]]):

Major FAO areas.

eez_12_nm (Optional[List[str]]):

12 nautical mile Exclusive Economic Zones.

high_seas (Optional[List[str]]):

High seas areas.

mpa_no_take_partial (Optional[List[str]]):

Partially no-take Marine Protected Areas.

mpa_no_take (Optional[List[str]]):

Fully no-take Marine Protected Areas.

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.

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

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

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

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

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

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

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

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

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

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

Bases: gfwapiclient.base.models.BaseModel

Distances related to the event.

Attributes:

start_distance_from_shore_km (Optional[float]):

Start distance from shore in kilometers.

end_distance_from_shore_km (Optional[float]):

End distance from shore in kilometers.

start_distance_from_port_km (Optional[float]):

Start distance from port in kilometers.

end_distance_from_port_km (Optional[float]):

End distance from port in kilometers.

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.

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

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

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

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

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

Bases: gfwapiclient.base.models.BaseModel

Public authorization details of the vessel involved in the event.

Attributes:

has_publicly_listed_authorization (Optional[str]):

Whether the vessel has publicly listed authorization.

rfmo (Optional[str]):

Regional Fisheries Management Organization.

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.

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

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

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

Bases: gfwapiclient.base.models.BaseModel

Vessel involved in the event.

Attributes:

id (Optional[str]):

Vessel ID.

name (Optional[str]):

Vessel name.

ssvid (Optional[str]):

Vessel SSVID.

flag (Optional[str]):

Vessel flag.

type (Optional[str]):

Vessel type.

public_authorizations (Optional[List[EventVesselPublicAuthorization]]):

Public authorization details.

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.

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

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

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

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

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

public_authorizations: Optional[List[gfwapiclient.resources.events.base.models.response.EventVesselPublicAuthorization]] = 'Field(...)'

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

Bases: gfwapiclient.base.models.BaseModel

Encounter event details.

Attributes:

vessel (Optional[EventVessel]):

Encountered vessel details.

median_distance_kilometers (Optional[float]):

Median distance in kilometers.

median_speed_knots (Optional[float]):

Median speed in knots.

type (Optional[str]):

Encounter type.

potential_risk (Optional[bool]):

Potential risk indicator.

main_vessel_public_authorization_status (Optional[str]):

Public authorization status of the main vessel.

encountered_vessel_public_authorization_status (Optional[str]):

Public authorization status of the encountered vessel.

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.

vessel: Optional[gfwapiclient.resources.events.base.models.response.EventVessel] = 'Field(...)'

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

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

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

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

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

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

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

Bases: gfwapiclient.base.models.BaseModel

Fishing event details.

Attributes:

total_distance_km (Optional[float]):

Total distance in kilometers.

average_speed_knots (Optional[float]):

Average speed in knots.

average_duration_hours (Optional[float]):

Average duration in hours.

potential_risk (Optional[bool]):

Potential risk indicator.

vessel_public_authorization_status (Optional[str]):

Public authorization status of the vessel.

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.

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

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

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

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

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

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

Bases: gfwapiclient.base.models.BaseModel

Gap event details.

Attributes:

intentional_disabling (Optional[bool]):

Whether the gap was due to intentional disabling.

distance_km (Optional[str]):

Distance in kilometers.

duration_hours (Optional[float]):

Duration in hours.

implied_speed_knots (Optional[str]):

Implied speed in knots.

positions_12_hours_before_sat (Optional[str]):

Positions 12 hours before satellite detection.

positions_per_day_sat_reception (Optional[float]):

Positions per day of satellite reception.

off_position (Optional[EventPosition]):

Position where the gap started.

on_position (Optional[EventPosition]):

Position where the gap ended.

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.

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

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

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

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

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

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

off_position: Optional[gfwapiclient.resources.events.base.models.response.EventPosition] = 'Field(...)'

on_position: Optional[gfwapiclient.resources.events.base.models.response.EventPosition] = 'Field(...)'

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

Bases: gfwapiclient.base.models.BaseModel

Loitering event details.

Attributes:

total_time_hours (Optional[float]):

Total time in hours.

total_distance_km (Optional[float]):

Total distance in kilometers.

average_speed_knots (Optional[float]):

Average speed in knots.

average_distance_from_shore_km (Optional[float]):

Average distance from shore in kilometers.

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.

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

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

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

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

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

Bases: gfwapiclient.base.models.BaseModel

Port visit anchorage details.

Attributes:

anchorage_id (Optional[str]):

Anchorage ID.

at_dock (Optional[bool]):

Whether the vessel was at dock.

distance_from_shore_km (Optional[float]):

Distance from shore in kilometers.

flag (Optional[str]):

Flag of the anchorage.

id (Optional[str]):

Anchorage ID.

lat (Optional[float]):

Latitude of the anchorage.

lon (Optional[float]):

Longitude of the anchorage.

name (Optional[str]):

Name of the anchorage.

top_destination (Optional[str]):

Top destination from the anchorage.

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.

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

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

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

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

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

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

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

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

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

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

Bases: gfwapiclient.base.models.BaseModel

Port visit event details.

Attributes:

visit_id (Optional[str]):

Port visit ID.

confidence (Optional[str]):

Confidence level of the port visit.

duration_hrs (Optional[float]):

Duration of the port visit in hours.

start_anchorage (Optional[EventPortVisitAnchorage]):

Start anchorage details.

intermediate_anchorage (Optional[EventPortVisitAnchorage]):

Intermediate anchorage details.

end_anchorage (Optional[EventPortVisitAnchorage]):

End anchorage details.

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.

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

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

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

start_anchorage: Optional[gfwapiclient.resources.events.base.models.response.EventPortVisitAnchorage] = 'Field(...)'

intermediate_anchorage: Optional[gfwapiclient.resources.events.base.models.response.EventPortVisitAnchorage] = 'Field(...)'

end_anchorage: Optional[gfwapiclient.resources.events.base.models.response.EventPortVisitAnchorage] = 'Field(...)'

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

Bases: gfwapiclient.http.models.ResultItem

Event item details.

Attributes:

start (Optional[datetime.datetime]):

Start time of the event.

end (Optional[datetime.datetime]):

End time of the event.

id (Optional[str]):

Event ID.

type (Optional[str]):

Event type.

position (Optional[EventPosition]):

Position of the event.

regions (Optional[EventRegions]):

Regions associated with the event.

bounding_box (Optional[List[float]]):

Bounding box of the event.

distances (Optional[EventDistances]):

Distances related to the event.

vessel (Optional[EventVessel]):

Vessel involved in the event.

encounter (Optional[EventEncounter]):

Encounter event details.

fishing (Optional[EventFishing]):

Fishing event details.

gap (Optional[Gap]):

Gap event details.

loitering (Optional[EventLoitering]):

Loitering event details.

port_visit (Optional[EventPortVisit]):

Port visit event details.

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.

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

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

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

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

position: Optional[gfwapiclient.resources.events.base.models.response.EventPosition] = 'Field(...)'

regions: Optional[gfwapiclient.resources.events.base.models.response.EventRegions] = 'Field(...)'

bounding_box: Optional[List[float]] = 'Field(...)'

distances: Optional[gfwapiclient.resources.events.base.models.response.EventDistances] = 'Field(...)'

vessel: Optional[gfwapiclient.resources.events.base.models.response.EventVessel] = 'Field(...)'

encounter: Optional[gfwapiclient.resources.events.base.models.response.EventEncounter] = 'Field(...)'

fishing: Optional[gfwapiclient.resources.events.base.models.response.EventFishing] = 'Field(...)'

gap: Optional[gfwapiclient.resources.events.base.models.response.Gap] = 'Field(...)'

loitering: Optional[gfwapiclient.resources.events.base.models.response.EventLoitering] = 'Field(...)'

port_visit: Optional[gfwapiclient.resources.events.base.models.response.EventPortVisit] = 'Field(...)'

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

Convert any empty datetime string to None.

Args:

value (Any): The value to validate.

Returns:

Optional[Any]:

The validated value, or None if it was an empty string.