gfwapiclient.resources.insights.models.response

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

Module Contents

Classes

Period	Vessel insights period.
PeriodicCounters	Periodic counters.
Gap	AIS off insights.
Coverage	Coverage insights.
ApparentFishing	Apparent fishing insights.
IuuListPeriod	IUU list period.
IuuVesselList	IUU vessel list.
VesselIdentity	IUU (Illegal, Unreported, or Unregulated) insights.
VesselInsightItem	Vessel insight item.
VesselInsightResult	Result for Vessel Insights API endpoint.

Data

__all__

API

gfwapiclient.resources.insights.models.response.__all__ = ['VesselInsightItem', 'VesselInsightResult']

class gfwapiclient.resources.insights.models.response.Period(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

Vessel insights period.

Attributes:

start_date (Optional[datetime.date], default=None):

The start date of the period.

end_date (Optional[datetime.date], default=None):

The end date of the period.

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_date: Optional[datetime.date] = 'Field(...)'

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

class gfwapiclient.resources.insights.models.response.PeriodicCounters(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

Periodic counters.

Attributes:

events (Optional[int], default=None):

The total number of events.

events_gap_off (Optional[int], default=None):

The number of events with AIS gaps.

events_in_rfmo_without_known_authorization (Optional[int], default=None):

The number of events in RFMOs without known authorization.

events_in_no_take_mpas (Optional[int], default=None):

The number of events in no-take MPAs.

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.

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

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

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

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

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

Bases: gfwapiclient.base.models.BaseModel

AIS off insights.

Attributes:

datasets ( Optional[List[str]], default=None):

The datasets used for AIS off insights.

historical_counters (Optional[PeriodicCounters], default=None):

The historical counters for AIS off events.

period_selected_counters (Optional[PeriodicCounters], default=None):

The counters for AIS off events in the selected period.

ais_off (Optional[List[str]], default=None):

The list of AIS off event IDs.

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: Optional[List[str]] = 'Field(...)'

historical_counters: Optional[gfwapiclient.resources.insights.models.response.PeriodicCounters] = 'Field(...)'

period_selected_counters: Optional[gfwapiclient.resources.insights.models.response.PeriodicCounters] = 'Field(...)'

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

class gfwapiclient.resources.insights.models.response.Coverage(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

Coverage insights.

Attributes:

blocks (Optional[str], default=None):

The number of blocks covered.

blocks_with_positions (Optional[str], default=None):

The number of blocks with positions.

percentage (Optional[float], default=None):

The percentage of coverage.

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.

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

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

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

class gfwapiclient.resources.insights.models.response.ApparentFishing(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

Apparent fishing insights.

Attributes:

datasets (Optional[List[str]], default=None):

The datasets used for apparent fishing insights.

historical_counters (Optional[PeriodicCounters], default=None):

The historical counters for apparent fishing events.

period_selected_counters (Optional[PeriodicCounters], default=None):

The counters for apparent fishing events in the selected period.

events_in_rfmo_without_known_authorization (Optional[List[str]], default=None):

The list of apparent fishing event IDs in RFMOs without known authorization.

events_in_no_take_mpas (Optional[List[str]], default=None):

The list of apparent fishing event IDs in no-take MPAs.

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: Optional[List[str]] = 'Field(...)'

historical_counters: Optional[gfwapiclient.resources.insights.models.response.PeriodicCounters] = 'Field(...)'

period_selected_counters: Optional[gfwapiclient.resources.insights.models.response.PeriodicCounters] = 'Field(...)'

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

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

class gfwapiclient.resources.insights.models.response.IuuListPeriod(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

IUU list period.

Attributes:

from_ (Optional[datetime.datetime], default=None):

The start date of the period.

to (Optional[datetime.datetime], default=None):

The end date of the period.

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.

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

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

class gfwapiclient.resources.insights.models.response.IuuVesselList(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

IUU vessel list.

Attributes:

values_in_the_period (Optional[List[IuuListPeriod]], default=None):

The values in the period.

total_times_listed (Optional[int], default=None):

The total times listed.

total_times_listed_in_the_period (Optional[int], default=None):

The total times listed in the period.

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.

values_in_the_period: Optional[List[gfwapiclient.resources.insights.models.response.IuuListPeriod]] = 'Field(...)'

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

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

class gfwapiclient.resources.insights.models.response.VesselIdentity(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

IUU (Illegal, Unreported, or Unregulated) insights.

Attributes:

datasets (Optional[List[str]], default=None):

The datasets used for IUU insights.

iuu_vessel_list (Optional[IuuVesselList], default=None):

The IUU vessel list.

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: Optional[List[str]] = 'Field(...)'

iuu_vessel_list: Optional[gfwapiclient.resources.insights.models.response.IuuVesselList] = 'Field(...)'

class gfwapiclient.resources.insights.models.response.VesselInsightItem(/, **data: typing.Any)

Bases: gfwapiclient.http.models.ResultItem

Vessel insight item.

Attributes:

period (Optional[Period], default=None):

The period of the insights.

vessel_ids_without_identity (Optional[List[str]], default=None):

The list of vessel IDs without identity.

gap (Optional[Gap], default=None): The AIS off insights.

coverage (Optional[Coverage], default=None):

The coverage insights.

apparent_fishing (Optional[ApparentFishing], default=None):

The apparent fishing insights.

vessel_identity (Optional[VesselIdentity], default=None):

The IUU insights.

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.

period: Optional[gfwapiclient.resources.insights.models.response.Period] = 'Field(...)'

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

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

coverage: Optional[gfwapiclient.resources.insights.models.response.Coverage] = 'Field(...)'

apparent_fishing: Optional[gfwapiclient.resources.insights.models.response.ApparentFishing] = 'Field(...)'

vessel_identity: Optional[gfwapiclient.resources.insights.models.response.VesselIdentity] = 'Field(...)'

class gfwapiclient.resources.insights.models.response.VesselInsightResult(data: gfwapiclient.resources.insights.models.response.VesselInsightItem)

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.insights.models.response.VesselInsightItem]

Result for Vessel Insights API endpoint.

Initialization

Initializes a new VesselInsightResult.

Args:

data (VesselInsightItem):

The vessel insight item data.

_result_item_class: Type[gfwapiclient.resources.insights.models.response.VesselInsightItem] = None

_data: gfwapiclient.resources.insights.models.response.VesselInsightItem = None