gfwapiclient.resources.bulk_downloads.base.models.request

Global Fishing Watch (GFW) API Python Client - Bulk Download API Base Request Models.

This module defines base Pydantic request models, parameters and enumerations for various Bulk Download API endpoints.

Module Contents

Classes

BulkReportDataset	Bulk report dataset.
BulkReportFormat	Bulk report result format.
BulkReportGeometry	Bulk report GeoJSON-like geometry input.
BulkReportRegion	Bulk report region of interest.
BulkReportFileType	Bulk report file type.

Data

__all__

API

gfwapiclient.resources.bulk_downloads.base.models.request.__all__ = ['BulkReportDataset', 'BulkReportFileType', 'BulkReportFormat', 'BulkReportGeometry', 'BulkReportReg...

class gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset

Bases: str, enum.Enum

Bulk report dataset.

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

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

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

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

Attributes:

FIXED_INFRASTRUCTURE_DATA_LATEST (str):

Latest public fixed infrastructure data dataset. See data caveats: https://globalfishingwatch.org/our-apis/documentation#sar-fixed-infrastructure-data-caveats

Initialization

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

FIXED_INFRASTRUCTURE_DATA_LATEST = 'public-fixed-infrastructure-data:latest'

class gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat

Bases: str, enum.Enum

Bulk report result format.

For more details on the Bulk Download API supported result formats, please refer to the official Global Fishing Watch API documentation:

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

Attributes:

CSV (str):

CSV (Comma Separated Values) result format.

JSON (str):

JSON (JavaScript Object Notation) result format.

Initialization

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

CSV = 'CSV'

JSON = 'JSON'

class gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

Bulk report GeoJSON-like geometry input.

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

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

See: https://globalfishingwatch.org/our-apis/documentation#bulk-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.bulk_downloads.base.models.request.BulkReportRegion(/, **data: typing.Any)

Bases: gfwapiclient.base.models.BaseModel

Bulk report region of interest.

Represents a predefined area of interest used for filtering bulk report data.

For more details on the Bulk Download API supported regions, please refer to the official Global Fishing Watch API documentation:

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

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

Attributes:

dataset (Optional[str]):

Dataset containing the region of interest (e.g. “public-eez-areas”).

id (Optional[Union[str, int]]):

Region of interest identifier (ID) (e.g. 8466).

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[Union[str, int]] = 'Field(...)'

class gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType

Bases: str, enum.Enum

Bulk report file type.

For more details on the Bulk Download API supported file types, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#download-bulk-report-url-parameters-for-get-requests

Attributes:

DATA (str):

Bulk report dataset file.

README (str):

Bulk report metadata documentation file.

GEOM (str):

Bulk report region geometry (in GeoJSON format) file.

Initialization

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

DATA = 'DATA'

README = 'README'

GEOM = 'GEOM'