gfwapiclient.resources.bulk_downloads.list.models.request¶
Global Fishing Watch (GFW) API Python Client - Get All Bulk Reports Request Models.
Module Contents¶
Classes¶
Request query parameters for Get All Bulk Reports API endpoint. |
Data¶
API¶
- gfwapiclient.resources.bulk_downloads.list.models.request.__all__ = ['BulkReportListParams']¶
- gfwapiclient.resources.bulk_downloads.list.models.request.BULK_REPORT_LIST_PARAMS_VALIDATION_ERROR_MESSAGE: Final[str] = 'Get bulk reports request parameters validation failed.'¶
- class gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams(/, **data: typing.Any)¶
Bases:
gfwapiclient.http.models.RequestParamsRequest query parameters for Get All Bulk Reports API endpoint.
Represents pagination, sorting, filtering parameters etc. for retrieving previously created bulk reports.
For more details on the Get All Bulk Reports API endpoint supported request parameters, please refer to the official Global Fishing Watch API documentation:
See: https://globalfishingwatch.org/our-apis/documentation#get-all-bulk-reports-by-user
- Attributes:
- limit (Optional[int]):
Maximum number of bulk reports to return. Defaults to 99999.
- offset (Optional[int]):
Number of bulk reports to skip before returning results. Used for pagination. Defaults to 0.
- sort (Optional[str]):
Property to sort the bulk reports by (e.g., “-createdAt”).
- status (Optional[BulkReportStatus]):
Current status of the bulk report generation process (e.g., “done” etc.).
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.
- status: Optional[gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus] = 'Field(...)'¶