gfwapiclient.resources.bulk_downloads.query.models.base.response

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

Module Contents

Classes

BulkReportQueryItem	Result item for the Query Bulk Report API endpoint.
BulkReportQueryResult	Result for the Query Bulk Report API endpoint.

Data

__all__
_BulkReportQueryItemT
_BulkReportQueryResultT

API

gfwapiclient.resources.bulk_downloads.query.models.base.response.__all__ = ['BulkReportQueryItem', 'BulkReportQueryResult', '_BulkReportQueryItemT', '_BulkReportQueryResultT']

class gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryItem(/, **data: typing.Any)

Bases: gfwapiclient.http.models.ResultItem

Result item for the Query Bulk Report API endpoint.

Represents a data record of a previously created bulk report.

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

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

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.

gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT = 'TypeVar(...)'

class gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryResult(data: List[gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT])

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT]

Result for the Query Bulk Report API endpoint.

Represents data records of a previously created bulk report.

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

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

Attributes:

_result_item_class (Type[_BulkReportQueryItemT]):

The model used for individual result items.

_data (List[_BulkReportQueryItemT]):

The bulk report data item returned in the response.

Initialization

Initializes a new BulkReportQueryResult.

Args:

data (List[_BulkReportQueryItemT]):

The list of bulk report data items.

_result_item_class: Type[gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT] = None

_data: List[gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT] = None

gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryResultT = 'TypeVar(...)'