gfwapiclient.resources.insights.models.request

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

Module Contents

Classes

VesselInsightInclude

Enumeration of vessel insight types.

VesselInsightDatasetVessel

Dataset and Vessel ID to use to get vessel insights.

VesselInsightBody

Vessel insight request body.

Data

__all__

VESSEL_INSIGHT_REQUEST_BODY_VALIDATION_ERROR_MESSAGE

API

gfwapiclient.resources.insights.models.request.__all__ = ['VesselInsightBody', 'VesselInsightDatasetVessel', 'VesselInsightInclude']
gfwapiclient.resources.insights.models.request.VESSEL_INSIGHT_REQUEST_BODY_VALIDATION_ERROR_MESSAGE: Final[str] = 'Vessel insights request body validation failed.'
class gfwapiclient.resources.insights.models.request.VesselInsightInclude

Bases: str, enum.Enum

Enumeration of vessel insight types.

This enum defines the possible values for the includes parameter in the vessel insights request, specifying the types of insights to retrieve.

Attributes:
FISHING (str):

Insights related to fishing activity.

GAP (str):

Insights related to AIS gaps.

COVERAGE (str):

Insights related to AIS coverage.

VESSEL_IDENTITY_IUU_VESSEL_LIST (str):

Insights related to vessels listed in IUU lists.

Initialization

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

FISHING = 'FISHING'
GAP = 'GAP'
COVERAGE = 'COVERAGE'
VESSEL_IDENTITY_IUU_VESSEL_LIST = 'VESSEL-IDENTITY-IUU-VESSEL-LIST'
class gfwapiclient.resources.insights.models.request.VesselInsightDatasetVessel(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

Dataset and Vessel ID to use to get vessel insights.

This model represents the structure for identifying a vessel in the vessel insights request.

Attributes:
dataset_id (str):

The dataset identifier. Default to “public-global-vessel-identity:latest”.

vessel_id:

The vessel identifier.

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_id: str = 'Field(...)'
vessel_id: str = 'Field(...)'
class gfwapiclient.resources.insights.models.request.VesselInsightBody(/, **data: typing.Any)

Bases: gfwapiclient.http.models.RequestBody

Vessel insight request body.

This model represents the request body for retrieving vessel insights.

Attributes:
includes (List[VesselInsightInclude]):

List of requested insights. Default to [VesselInsightInclude.FISHING].

start_date (datetime.date):

Start date of the request.

end_date (datetime.date):

End date of the request.

vessels List[VesselInsightIdBody]:

List of Dataset and Vessel ID to use to get vessel 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.

includes: List[gfwapiclient.resources.insights.models.request.VesselInsightInclude] = 'Field(...)'
start_date: datetime.date = 'Field(...)'
end_date: datetime.date = 'Field(...)'
vessels: List[gfwapiclient.resources.insights.models.request.VesselInsightDatasetVessel] = 'Field(...)'