gfwapiclient.resources.vessels.detail.models.request

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

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

Module Contents

Classes

VesselDetailParams

Request query parameters for the get vessel by ID API endpoint.

Data

__all__
VESSEL_DETAIL_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE

API

gfwapiclient.resources.vessels.detail.models.request.__all__ = ['VesselDetailParams']

gfwapiclient.resources.vessels.detail.models.request.VESSEL_DETAIL_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE: Final[str] = 'Get vessel by ID request parameters validation failed.'

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

Bases: gfwapiclient.resources.vessels.base.models.request.VesselBaseDetailParams

Request query parameters for the get vessel by ID API endpoint.

Attributes:

dataset (VesselDataset):

Dataset that will be used to search the vessel.

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.

indexed_fields: ClassVar[Optional[List[str]]] = ['includes', 'match-fields']

dataset: gfwapiclient.resources.vessels.base.models.request.VesselDataset = 'Field(...)'