gfwapiclient.resources.references.regions.models.response

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

Module Contents

Classes

EEZRegionItem	Exclusive Economic Zone (EEZ) region item.
EEZRegionResult	Result for Exclusive Economic Zone (EEZ) regions API endpoint.
MPARegionItem	Marine Protected Area (MPA) region item.
MPARegionResult	Result for Marine Protected Area (MPA) regions API endpoint.
RFMORegionItem	Regional Fisheries Management Organization (RFMO) region item.
RFMORegionResult	Result for Regional Fisheries Management Organization (RFMO) regions API endpoint.

Data

__all__

API

gfwapiclient.resources.references.regions.models.response.__all__ = ['EEZRegionItem', 'EEZRegionResult', 'MPARegionItem', 'MPARegionResult', 'RFMORegionItem', 'RFMORegi...

class gfwapiclient.resources.references.regions.models.response.EEZRegionItem(/, **data: typing.Any)

Bases: gfwapiclient.http.models.ResultItem

Exclusive Economic Zone (EEZ) region item.

Attributes:

id (Optional[int]):

Region ID.

label (Optional[str]):

Region label.

iso3 (Optional[str]):

ISO3 country code.

dataset (str):

Dataset name or ID.

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.

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

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

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

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

class gfwapiclient.resources.references.regions.models.response.EEZRegionResult(data: List[gfwapiclient.resources.references.regions.models.response.EEZRegionItem])

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.references.regions.models.response.EEZRegionItem]

Result for Exclusive Economic Zone (EEZ) regions API endpoint.

This model represents the result returned by the EEZ regions API endpoint. See the API documentation for more details: https://globalfishingwatch.org/our-apis/documentation#regions

Initialization

Initializes a new EEZRegionResult.

Args:

data (List[EEZRegionItem]):

A list of EEZRegionItem objects representing the EEZ regions.

_result_item_class: Type[gfwapiclient.resources.references.regions.models.response.EEZRegionItem] = None

_data: List[gfwapiclient.resources.references.regions.models.response.EEZRegionItem] = None

class gfwapiclient.resources.references.regions.models.response.MPARegionItem(/, **data: typing.Any)

Bases: gfwapiclient.http.models.ResultItem

Marine Protected Area (MPA) region item.

Attributes:

id (Optional[str]):

Region ID.

label (Optional[str]):

Region label.

name (Optional[str]):

Region name.

dataset (str):

Dataset name or ID.

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.

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

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

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

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

class gfwapiclient.resources.references.regions.models.response.MPARegionResult(data: List[gfwapiclient.resources.references.regions.models.response.MPARegionItem])

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.references.regions.models.response.MPARegionItem]

Result for Marine Protected Area (MPA) regions API endpoint.

This model represents the result returned by the MPA regions API endpoint. See the API documentation for more details: https://globalfishingwatch.org/our-apis/documentation#regions

Initialization

Initializes a new MPARegionResult.

Args:

data (List[MPARegionItem]):

A list of MPARegionItem objects representing the MPA regions.

_result_item_class: Type[gfwapiclient.resources.references.regions.models.response.MPARegionItem] = None

_data: List[gfwapiclient.resources.references.regions.models.response.MPARegionItem] = None

class gfwapiclient.resources.references.regions.models.response.RFMORegionItem(/, **data: typing.Any)

Bases: gfwapiclient.http.models.ResultItem

Regional Fisheries Management Organization (RFMO) region item.

Attributes:

id (Optional[str]):

Region ID.

label (Optional[str]):

Region label.

rfb (Optional[str]):

Region RFB.

dataset (str):

Dataset name or ID.

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.

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

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

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

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

class gfwapiclient.resources.references.regions.models.response.RFMORegionResult(data: List[gfwapiclient.resources.references.regions.models.response.RFMORegionItem])

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.references.regions.models.response.RFMORegionItem]

Result for Regional Fisheries Management Organization (RFMO) regions API endpoint.

This model represents the result returned by the RFMO regions API endpoint. See the API documentation for more details: https://globalfishingwatch.org/our-apis/documentation#regions

Initialization

Initializes a new RFMORegionResult.

Args:

data (List[RFMORegionItem]):

A list of RFMORegionItem objects representing the RFMO regions.

_result_item_class: Type[gfwapiclient.resources.references.regions.models.response.RFMORegionItem] = None

_data: List[gfwapiclient.resources.references.regions.models.response.RFMORegionItem] = None