gfwapiclient.resources.vessels.search.models.response

Global Fishing Watch (GFW) API Python Client - Vessels Search API Response Models.

This module defines response models for the Vessels API’s search vessels endpoint.

Module Contents

Classes

VesselSearchItem	Result item for the vessels search API endpoint.
VesselSearchResult	Result for the vessels search API endpoint.

Data

__all__

API

gfwapiclient.resources.vessels.search.models.response.__all__ = ['VesselSearchItem', 'VesselSearchResult']

class gfwapiclient.resources.vessels.search.models.response.VesselSearchItem(/, **data: typing.Any)

Bases: gfwapiclient.resources.vessels.base.models.response.VesselItem

Result item for the vessels search API endpoint.

This class extends VesselItem to provide a specialized result item for the vessel search endpoint.

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.vessels.search.models.response.VesselSearchResult(data: List[gfwapiclient.resources.vessels.search.models.response.VesselSearchItem])

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.vessels.search.models.response.VesselSearchItem]

Result for the vessels search API endpoint.

This class extends Result to provide a specialized result container for the vessel search endpoint.

Initialization

Initializes a new VesselSearchResult.

Args:

data (List[VesselSearchItem]):

The list of result items.

_result_item_class: Type[gfwapiclient.resources.vessels.search.models.response.VesselSearchItem] = None

_data: List[gfwapiclient.resources.vessels.search.models.response.VesselSearchItem] = None