gfwapiclient.resources.bulk_downloads.create.models.response

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

Module Contents

Classes

BulkReportCreateItem	Result item for the Create a Bulk Report API endpoint.
BulkReportCreateResult	Result for the Create a Bulk Report API endpoint.

Data

__all__

API

gfwapiclient.resources.bulk_downloads.create.models.response.__all__ = ['BulkReportCreateItem', 'BulkReportCreateResult']

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

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

Result item for the Create a Bulk Report API endpoint.

Represents metadata and status of the created bulk report.

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

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.create.models.response.BulkReportCreateResult(data: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem)

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem]

Result for the Create a Bulk Report API endpoint.

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

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

Attributes:

_result_item_class (Type[BulkReportFileItem]):

The model used for individual result items.

_data (BulkReportCreateItem):

The bulk report item returned in the response.

Initialization

Initializes a new BulkReportCreateResult.

Args:

data (BulkReportCreateItem):

The created bulk report details.

_result_item_class: Type[gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem] = None

_data: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem = None