gfwapiclient.resources.vessels.detail.models.response

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

This module defines response models for the Vessels API’s get vessel by ID endpoint.

Module Contents

Classes

VesselDetailItem	Result item for the get vessel by ID API endpoint.
VesselDetailResult	Result for the get vessel by ID API endpoint.

Data

__all__

API

gfwapiclient.resources.vessels.detail.models.response.__all__ = ['VesselDetailItem', 'VesselDetailResult']

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

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

Result item for the get vessel by ID API endpoint.

This class extends VesselItem to provide a specialized result item for the vessel detail 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.detail.models.response.VesselDetailResult(data: gfwapiclient.resources.vessels.detail.models.response.VesselDetailItem)

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.vessels.detail.models.response.VesselDetailItem]

Result for the get vessel by ID API endpoint.

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

Initialization

Initializes a new VesselDetailResult.

Args:

data (VesselDetailItem):

The data of the result.

_result_item_class: Type[gfwapiclient.resources.vessels.detail.models.response.VesselDetailItem] = None

_data: gfwapiclient.resources.vessels.detail.models.response.VesselDetailItem = None