gfwapiclient.resources.bulk_downloads.query.models.base.request

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

Module Contents

Classes

BulkReportQueryParams

Request query parameters for Query Bulk Report API endpoint.

Data

__all__

BULK_REPORT_QUERY_PARAMS_VALIDATION_ERROR_MESSAGE

API

gfwapiclient.resources.bulk_downloads.query.models.base.request.__all__ = ['BulkReportQueryParams']
gfwapiclient.resources.bulk_downloads.query.models.base.request.BULK_REPORT_QUERY_PARAMS_VALIDATION_ERROR_MESSAGE: Final[str] = 'Query bulk report request parameters validation failed.'
class gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams(/, **data: typing.Any)

Bases: gfwapiclient.http.models.RequestParams

Request query parameters for Query Bulk Report API endpoint.

Represents pagination, sorting, filtering parameters etc. for querying previously created bulk report data.

For more details on the Query Bulk Report API endpoint supported request parameters, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#get-data-in-json-format

Attributes:
limit (Optional[int]):

Maximum number of bulk report records to return. Defaults to 99999.

offset (Optional[int]):

Number of bulk report records to skip before returning results. Used for pagination. Defaults to 0.

sort (Optional[str]):

Property to sort the bulk report records by (e.g. “-structure_start_date”).

includes (Optional[List[str]]):

List of bulk report record fields to include in the result.

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]]] = ['includes']
limit: Optional[int] = 'Field(...)'
offset: Optional[int] = 'Field(...)'
sort: Optional[str] = 'Field(...)'
includes: Optional[List[str]] = 'Field(...)'