gfwapiclient.resources.fourwings.report.models.request

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

Module Contents

Classes

FourWingsReportFormat	4Wings report 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 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.

Low means at 10th degree resolution and High means at 100th degree resolution.

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.

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.

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.

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.

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.

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'

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-like geometry object used to filter the report data.

Attributes:

type (str):

Geometry type (e.g., Polygon).

coordinates (Any):

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

Bases: gfwapiclient.base.models.BaseModel

4Wings report region of interest.

Represents a region of interest used to filter the report data.

Attributes:

dataset (Optional[str]):

Dataset containing the region.

id (Optional[str]):

Region ID.

buffer_operation (Optional[FourWingsReportBufferOperation]):

Buffer operation.

buffer_unit (Optional[FourWingsReportBufferUnit]):

Buffer unit.

buffer_value (Optional[str]):

Buffer value.

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.

Attributes:

spatial_resolution (Optional[FourWingsReportSpatialResolution]):

Spatial resolution.

format (Optional[FourWingsReportFormat]):

Report result format.

group_by (Optional[FourWingsReportGroupBy]):

Grouped by criteria.

temporal_resolution (Optional[FourWingsReportTemporalResolution]):

Temporal resolution.

datasets (Optional[List[FourWingsReportDataset]]):

Datasets that will be used to create the report.

filters (Optional[List[str]]):

Filters are applied to the dataset.

date_range (Optional[str]):

Start date and end date to filter the data.

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.

Attributes:

geojson (Optional[FourWingsGeometry]): Geometry to filter the data. region (Optional[FourWingsReportRegion]): Region information.

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(...)'