gfwapiclient.resources.fourwings.report.models.request

Global Fishing Watch (GFW) API Python Client - 4Wings Report API Request Models.

Module Contents

Classes

FourWingsReportFormat	4Wings report result format.
FourWingsReportSpatialResolution	4Wings report spatial resolution.
FourWingsReportGroupBy	4Wings report grouped by criteria.
FourWingsReportTemporalResolution	4Wings report temporal resolution.
FourWingsReportBufferOperation	4Wings report buffer operation.
FourWingsReportBufferUnit	4Wings report buffer value unit.
FourWingsReportDataset	4Wings report dataset.
FourWingsGeometry	4Wings report GeoJSON-like geometry input.
FourWingsReportRegion	4Wings report region of interest.
FourWingsReportParams	4Wings report request parameters.
FourWingsReportBody	4Wings report request body.

Data

__all__
FOURWINGS_REPORT_REQUEST_BODY_VALIDATION_ERROR_MESSAGE
FOURWINGS_REPORT_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE
FOURWINGS_REPORT_REQUEST_PARAM_VALIDATION_ERROR_MESSAGE

API

gfwapiclient.resources.fourwings.report.models.request.__all__ = ['FourWingsReportBody', 'FourWingsReportParams']

gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_BODY_VALIDATION_ERROR_MESSAGE: Final[str] = '4Wings report request body validation failed.'

gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE: Final[str] = '4Wings report request params validation failed.'

gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_PARAM_VALIDATION_ERROR_MESSAGE: Final[str] = None

class gfwapiclient.resources.fourwings.report.models.request.FourWingsReportFormat

Bases: str, enum.Enum

4Wings report result format.

For more details on the 4Wings API supported report result formats, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#report-url-parameters-for-both-post-and-get-requests

Attributes:

JSON (str):

JSON (JavaScript Object Notation) result format.

Initialization

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

JSON = 'JSON'

class gfwapiclient.resources.fourwings.report.models.request.FourWingsReportSpatialResolution

Bases: str, enum.Enum

4Wings report spatial resolution.

For more details on the 4Wings API supported report spatial resolutions, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#report-url-parameters-for-both-post-and-get-requests

Attributes:

LOW (str):

Coarse resolution (~10th degree).

HIGH (str):

Fine resolution (~100th degree).

Initialization

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

LOW = 'LOW'

HIGH = 'HIGH'

class gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy

Bases: str, enum.Enum

4Wings report grouped by criteria.

For more details on the 4Wings API supported report grouped by criteria, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#report-url-parameters-for-both-post-and-get-requests

Attributes:

VESSEL_ID (str):

Group by vessel ID.

FLAG (str):

Group by vessel flag.

GEARTYPE (str):

Group by gear type.

FLAGANDGEARTYPE (str):

Group by both flag and gear type.

MMSI (str):

Group by MMSI (Maritime Mobile Service Identity).

Initialization

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

VESSEL_ID = 'VESSEL_ID'

FLAG = 'FLAG'

GEARTYPE = 'GEARTYPE'

FLAGANDGEARTYPE = 'FLAGANDGEARTYPE'

MMSI = 'MMSI'

class gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution

Bases: str, enum.Enum

4Wings report temporal resolution.

For more details on the 4Wings API supported report temporal resolutions, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#report-url-parameters-for-both-post-and-get-requests

Attributes:

HOURLY (str):

Aggregate by hour.

DAILY (str):

Aggregate by day.

MONTHLY (str):

Aggregate by month.

YEARLY (str):

Aggregate by year.

ENTIRE (str):

Aggregate over the entire time period.

Initialization

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

HOURLY = 'HOURLY'

DAILY = 'DAILY'

MONTHLY = 'MONTHLY'

YEARLY = 'YEARLY'

ENTIRE = 'ENTIRE'

class gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferOperation

Bases: str, enum.Enum

4Wings report buffer operation.

For more details on the 4Wings API supported report buffer operations, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#report-body-only-for-post-request

Attributes:

DIFFERENCE (str):

Compute the difference between geometries.

DISSOLVE (str):

Merge geometries into a single shape.

Initialization

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

DIFFERENCE = 'DIFFERENCE'

DISSOLVE = 'DISSOLVE'

class gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit

Bases: str, enum.Enum

4Wings report buffer value unit.

For more details on the 4Wings API supported report buffer value units, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#report-body-only-for-post-request

Attributes:

MILES (str):

Miles.

NAUTICALMILES (str):

Nautical miles.

KILOMETERS (str):

Kilometers.

RADIANS (str):

Radians.

DEGREES (str):

Degrees.

Initialization

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

MILES = 'MILES'

NAUTICALMILES = 'NAUTICALMILES'

KILOMETERS = 'KILOMETERS'

RADIANS = 'RADIANS'

DEGREES = 'DEGREES'

class gfwapiclient.resources.fourwings.report.models.request.FourWingsReportDataset

Bases: str, enum.Enum

4Wings report dataset.

For more details on the 4Wings API supported datasets, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#supported-datasets

See: https://globalfishingwatch.org/our-apis/documentation#api-dataset

Attributes:

FISHING_EFFORT_LATEST (str):

Latest global fishing effort dataset. See data caveats: https://globalfishingwatch.org/our-apis/documentation#apparent-fishing-effort

SAR_PRESENCE_LATEST (str):

Latest global SAR presence dataset. See data caveats: https://globalfishingwatch.org/our-apis/documentation#sar-vessel-detections-data-caveats

PRESENCE_LATEST (str):

Latest global vessel presence dataset. See data caveats: https://globalfishingwatch.org/our-apis/documentation#ais-vessel-presence-caveats

Initialization

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

FISHING_EFFORT_LATEST = 'public-global-fishing-effort:latest'

SAR_PRESENCE_LATEST = 'public-global-sar-presence:latest'

PRESENCE_LATEST = 'public-global-presence:latest'

class gfwapiclient.resources.fourwings.report.models.request.FourWingsGeometry(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

4Wings report GeoJSON-like geometry input.

Represents a GeoJSON-compatible area of interest used for filtering report data.

For more details on the 4Wings API supported report geojson/geometries, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#report-body-only-for-post-request

Attributes:

type (str):

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

coordinates (Any):

Geometry coordinates as a list or nested lists.

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.fourwings.report.models.request.FourWingsReportRegion(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

4Wings report region of interest.

Represents a predefined region of interest used for filtering report data.

For more details on the 4Wings API supported report regions, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#report-body-only-for-post-request

Attributes:

dataset (Optional[str]):

Dataset containing the region.

id (Optional[str]):

Region identifier (ID).

buffer_operation (Optional[FourWingsReportBufferOperation]):

Operation to apply on buffer geometry.

buffer_unit (Optional[FourWingsReportBufferUnit]):

Unit used for buffer distance.

buffer_value (Optional[str]):

Value for the buffer distance.

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

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

buffer_operation: Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferOperation] = 'Field(...)'

buffer_unit: Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit] = 'Field(...)'

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

class gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams(/, **data: typing.Any)

Bases: gfwapiclient.http.models.RequestParams

4Wings report request parameters.

Represents the query parameters for the 4Wings report request.

For more details on the 4Wings API supported report request parameters, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#report-url-parameters-for-both-post-and-get-requests

Attributes:

spatial_resolution (Optional[FourWingsReportSpatialResolution]):

Spatial resolution of the report.

format (Optional[FourWingsReportFormat]):

Report result format.

group_by (Optional[FourWingsReportGroupBy]):

Grouping criteria for the report.

temporal_resolution (Optional[FourWingsReportTemporalResolution]):

Temporal resolution of the report.

datasets (Optional[List[FourWingsReportDataset]]):

Datasets that will be used to create the report.

filters (Optional[List[str]]):

Filters to apply to the report datasets.

date_range (Optional[str]):

Start date and end date to filter the data as a comma-separated string in “YYYY-MM-DD,YYYY-MM-DD” format.

spatial_aggregation (Optional[bool]):

Whether to spatially aggregate the report.

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.

indexed_fields: ClassVar[Optional[List[str]]] = ['datasets', 'filters']

spatial_resolution: Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportSpatialResolution] = 'Field(...)'

format: Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportFormat] = 'Field(...)'

group_by: Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy] = 'Field(...)'

temporal_resolution: Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution] = 'Field(...)'

datasets: Optional[List[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportDataset]] = 'Field(...)'

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

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

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

class gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBody(/, **data: typing.Any)

Bases: gfwapiclient.http.models.RequestBody

4Wings report request body.

Represents the request body for the 4Wings report request.

For more details on the 4Wings API supported report request body, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#report-body-only-for-post-request

Attributes:

geojson (Optional[FourWingsGeometry]):

Custom GeoJSON geometry to filter the report.

region (Optional[FourWingsReportRegion]):

Predefined region information to filter the report.

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.

geojson: Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsGeometry] = 'Field(...)'

region: Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion] = 'Field(...)'