gfwapiclient.resources.vessels.search.models.request

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

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

Module Contents

Classes

VesselSearchInclude	Enumeration of extra information that can be included in a vessel search.
VesselSearchParams	Request query parameters for the vessels search API endpoint.

Data

__all__
VESSEL_SEARCH_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE

API

gfwapiclient.resources.vessels.search.models.request.__all__ = ['VesselSearchParams']

gfwapiclient.resources.vessels.search.models.request.VESSEL_SEARCH_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE: Final[str] = 'Search vessels request parameters validation failed.'

class gfwapiclient.resources.vessels.search.models.request.VesselSearchInclude

Bases: str, enum.Enum

Enumeration of extra information that can be included in a vessel search.

Attributes:

OWNERSHIP (str):

Includes vessel ownership details.

AUTHORIZATIONS (str):

Includes vessel authorization details.

MATCH_CRITERIA (str):

Includes criteria used for matching vessels.

Initialization

Initialize self. See help(type(self)) for accurate signature.

OWNERSHIP = 'OWNERSHIP'

AUTHORIZATIONS = 'AUTHORIZATIONS'

MATCH_CRITERIA = 'MATCH_CRITERIA'

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

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

Request query parameters for the vessels search API endpoint.

Attributes:

since (Optional[str]):

The token to send to get more results.

limit (Optional[int]):

Amount of search results to return. Defaults to 20.

datasets (List[VesselDataset]):

Datasets that will be used to search the vessel.

query (Optional[str]):

Free form query that allows you to search a vessel by sending some identifier.

where (Optional[str]):

Advanced query that allows you to search a vessel by sending several identifiers.

includes (Optional[List[VesselSearchInclude]]):

Whether to add extra information to the 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.

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

since: Optional[str] = 'Field(...)'

limit: Optional[int] = 'Field(...)'

datasets: List[gfwapiclient.resources.vessels.base.models.request.VesselDataset] = 'Field(...)'

query: Optional[str] = 'Field(...)'

where: Optional[str] = 'Field(...)'

includes: Optional[List[gfwapiclient.resources.vessels.search.models.request.VesselSearchInclude]] = 'Field(...)'