gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response

Global Fishing Watch (GFW) API Python Client - Query Bulk Fixed Infrastructure Data Response Models.

Module Contents

Classes

BulkFixedInfrastructureDataQueryItem	Result item for the fixed infrastructure data dataset.
BulkFixedInfrastructureDataQueryResult	Result for the Query Bulk fixed infrastructure data.

Data

__all__

API

gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.__all__ = ['BulkFixedInfrastructureDataQueryItem', 'BulkFixedInfrastructureDataQueryResult']

class gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem(/, **data: typing.Any)

Bases: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryItem

Result item for the fixed infrastructure data dataset.

Represents a data record of a previously created fixed infrastructure data (i.e., public-fixed-infrastructure-data:latest dataset) bulk report.

For more details on the Query Bulk Report API endpoint supported response bodies, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#get-data-in-json-format

See: https://globalfishingwatch.org/our-apis/documentation#get-data-in-json-format-http-response

Attributes:

detection_id (Optional[str]):

Unique identifier (ID) of the satellite detection (e.g., “1AB_AD_MEDIAN_COMP”).

detection_date (Optional[datetime.datetime]):

Date of the detection (e.g., “2021-07-01”).

structure_id (Optional[Union[str, int]]):

Unique identifier (ID) for all detections of the same structure (e.g., “162013”).

lat (Optional[float]):

Latitude of the structure (e.g., -151.608786096245).

lon (Optional[float]):

Longitude of the structure (e.g., 60.8646485096125).

structure_start_date (Optional[datetime.datetime]):

The first date the structure was detected (e.g., “2017-01-01”).

structure_end_date (Optional[datetime.datetime]):

The last date the structure was detected (e.g., “2021-10-01”).

label (Optional[str]):

Predicted structure type: oil, wind, or unknown (e.g., “oil”).

label_confidence (Optional[str]):

Label classification confidence level: high, medium, or low (e.g., “high”).

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.

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

detection_date: Optional[datetime.datetime] = 'Field(...)'

structure_id: Optional[Union[str, int]] = 'Field(...)'

lat: Optional[float] = 'Field(...)'

lon: Optional[float] = 'Field(...)'

structure_start_date: Optional[datetime.datetime] = 'Field(...)'

structure_end_date: Optional[datetime.datetime] = 'Field(...)'

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

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

classmethod empty_datetime_str_to_none(value: Any) → Optional[Any]

Convert any empty datetime string to None.

Args:

value (Any):

The value to validate.

Returns:

Optional[Any]:

The validated datetime object or None if input is empty.

class gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryResult(data: List[gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem])

Bases: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryResult[gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem]

Result for the Query Bulk fixed infrastructure data.

Represents data records of a previously created fixed infrastructure data (i.e., public-fixed-infrastructure-data:latest dataset) bulk report.

For more details on the Query Bulk Report API endpoint supported response bodies, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#get-data-in-json-format

Attributes:

_result_item_class (Type[BulkFixedInfrastructureDataQueryItem]):

The model used for individual result items.

_data (List[BulkFixedInfrastructureDataQueryItem]):

The bulk fixed infrastructure data report items returned in the response.

Initialization

Initializes a new FixedInfrastructureDataResult.

Args:

data (List[BulkFixedInfrastructureDataQueryItem]):

The list of bulk fixed infrastructure data report items.

_result_item_class: Type[gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem] = None

_data: List[gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem] = None