gfwapiclient.resources.vessels.list.models.response

Global Fishing Watch (GFW) API Python Client - Get Vessels by IDs API Response Models.

This module defines response models for the Vessels API’s get vessels by IDs endpoint.

Module Contents

Classes

VesselListItem	Result item for the get vessels by IDs API endpoint.
VesselListResult	Result for the get vessels by IDs API endpoint.

Data

__all__

API

gfwapiclient.resources.vessels.list.models.response.__all__ = ['VesselListItem', 'VesselListResult']

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

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

Result item for the get vessels by IDs API endpoint.

This class extends VesselItem to provide a specialized result item for the vessel list 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.list.models.response.VesselListResult(data: List[gfwapiclient.resources.vessels.list.models.response.VesselListItem])

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.vessels.list.models.response.VesselListItem]

Result for the get vessels by IDs API endpoint.

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

Initialization

Initializes a new VesselListResult.

Args:

data (List[VesselListItem]):

The list of result items.

_result_item_class: Type[gfwapiclient.resources.vessels.list.models.response.VesselListItem] = None

_data: List[gfwapiclient.resources.vessels.list.models.response.VesselListItem] = None