gfwapiclient.resources.bulk_downloads.detail.models.response

Global Fishing Watch (GFW) API Python Client - Get Bulk Report by ID Response Models.

Module Contents

Classes

BulkReportDetailItem

Result item for the Get Bulk Report by ID API endpoint.

BulkReportDetailResult

Result for the Get Bulk Report by ID API endpoint.

Data

__all__

API

gfwapiclient.resources.bulk_downloads.detail.models.response.__all__ = ['BulkReportDetailItem', 'BulkReportDetailResult']
class gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem(/, **data: typing.Any)

Bases: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem

Result item for the Get Bulk Report by ID API endpoint.

Represents metadata and status of the previously created bulk report.

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

See: https://globalfishingwatch.org/our-apis/documentation#get-bulk-report-by-id-http-response

See: https://globalfishingwatch.org/our-apis/documentation#bulk-report-response

See: https://globalfishingwatch.org/our-apis/documentation#bulk-reports-get-http-response

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.

class gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult(data: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem)

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem]

Result for the Get Bulk Report by ID API endpoint.

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

See: https://globalfishingwatch.org/our-apis/documentation#get-bulk-report-by-id-http-response

Attributes:
_result_item_class (Type[BulkReportDetailItem]):

The model used for individual result items.

_data (BulkReportDetailItem):

The bulk report item returned in the response.

Initialization

Initializes a new BulkReportDetailResult.

Args:
data (BulkReportDetailItem):

The bulk report details.

_result_item_class: Type[gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem] = None
_data: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem = None