gfwapiclient.resources.bulk_downloads.create.models.request

Global Fishing Watch (GFW) API Python Client - Create a Bulk Report Request Models.

Module Contents

Classes

BulkReportCreateBody

Request body for Create a Bulk Report API endpoint.

Data

__all__
BULK_REPORT_CREATE_BODY_VALIDATION_ERROR_MESSAGE

API

gfwapiclient.resources.bulk_downloads.create.models.request.__all__ = ['BulkReportCreateBody']

gfwapiclient.resources.bulk_downloads.create.models.request.BULK_REPORT_CREATE_BODY_VALIDATION_ERROR_MESSAGE: Final[str] = 'Create bulk report request body validation failed.'

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

Bases: gfwapiclient.http.models.RequestBody

Request body for Create a Bulk Report API endpoint.

Represents dataset, filters, spatial parameters etc. for creating bulk reports.

For more details on the Create a Bulk Report API endpoint supported request body, 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#create-a-bulk-report

Attributes:

name (Optional[str]):

Human-readable name of the bulk report. If not provided, it will be generate using format “{dataset}-{uuidv4}”.

dataset (Optional[BulkReportDataset]):

Dataset that will be used to create the bulk report. Defaults to “public-fixed-infrastructure-data:v1.1”.

geojson (Optional[BulkReportGeometry]):

Custom GeoJSON geometry to filter the bulk report.

format (Optional[BulkReportFormat]):

Bulk report result format.

region (Optional[BulkReportRegion]):

Predefined region information to filter the bulk report.

filters (Optional[List[str]]):

List of filters to apply when generating the bulk 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.

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

dataset: Optional[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset] = 'Field(...)'

geojson: Optional[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry] = 'Field(...)'

format: Optional[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat] = 'Field(...)'

region: Optional[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion] = 'Field(...)'

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