Package google.research.floodforecasting.v1

색인

• FloodsApi(인터페이스)
• BatchGetGaugeModelsRequest(메시지)
• BatchGetGaugeModelsResponse(메시지)
• BatchGetGaugesRequest(메시지)
• BatchGetGaugesResponse(메시지)
• FloodStatus(메시지)
• FloodStatus.ForecastChange(메시지)
• FloodStatus.ForecastChange.ValueChange(메시지)
• FloodStatus.ForecastTrend(열거형)
• FloodStatus.InundationMap(메시지)
• FloodStatus.InundationMap.InundationLevel(열거형)
• FloodStatus.InundationMapSet(메시지)
• FloodStatus.InundationMapType(열거형)
• FloodStatus.MapInferenceType(열거형)
• FloodStatus.Severity(열거형)
• Forecast(메시지)
• ForecastSet(메시지)
• ForecastTimedValue(메시지)
• Gauge(메시지)
• GaugeModel(메시지)
• GaugeModel.GaugeValueUnit(열거형)
• GetGaugeModelRequest(메시지)
• GetGaugeRequest(메시지)
• GetSerializedPolygonRequest(메시지)
• Loop(메시지)
• QueryGaugeForecastsRequest(메시지)
• QueryGaugeForecastsResponse(메시지)
• QueryLatestFloodStatusByGaugeIdsRequest(메시지)
• QueryLatestFloodStatusByGaugeIdsResponse(메시지)
• SearchGaugesByAreaRequest(메시지)
• SearchGaugesByAreaResponse(메시지)
• SearchLatestFloodStatusByAreaRequest(메시지)
• SearchLatestFloodStatusByAreaResponse(메시지)
• SerializedPolygon(메시지)
• Thresholds(메시지)
• TimeRange(메시지)

FloodsApi

홍수 예측을 위한 외부 API 서비스입니다.

BatchGetGaugeModels
rpc BatchGetGaugeModels(BatchGetGaugeModelsRequest) returns (BatchGetGaugeModelsResponse) 여러 게이지의 현재 수문학 모델 메타데이터를 가져옵니다.

BatchGetGauges
rpc BatchGetGauges(BatchGetGaugesRequest) returns (BatchGetGaugesResponse) 여러 게이지에 관한 메타데이터를 가져옵니다.

GetGauge
rpc GetGauge(GetGaugeRequest) returns (Gauge) 게이지에 관한 메타데이터를 가져옵니다.

GetGaugeModel
rpc GetGaugeModel(GetGaugeModelRequest) returns (GaugeModel) 지정된 게이지의 현재 수문 모델 메타데이터를 가져옵니다.

GetSerializedPolygon
rpc GetSerializedPolygon(GetSerializedPolygonRequest) returns (SerializedPolygon) 직렬화된 다각형을 가져옵니다. 이러한 ID는 다른 API 응답에 표시되며 여기에서 이러한 ID를 사용할 수 있습니다. 예를 들어 FloodStatus의 InundationMap를 참고하세요.

QueryGaugeForecasts
rpc QueryGaugeForecasts(QueryGaugeForecastsRequest) returns (QueryGaugeForecastsResponse) 게이지 예측을 쿼리합니다.

QueryLatestFloodStatusByGaugeIds
rpc QueryLatestFloodStatusByGaugeIds(QueryLatestFloodStatusByGaugeIdsRequest) returns (QueryLatestFloodStatusByGaugeIdsResponse) 게이지 ID로 최신 홍수 상태를 쿼리합니다.

SearchGaugesByArea
rpc SearchGaugesByArea(SearchGaugesByAreaRequest) returns (SearchGaugesByAreaResponse) 지역별로 게이지를 검색합니다. 참고: 게이지는 가끔 추가되거나 삭제되므로 이 API의 결과를 캐시하거나 장기간 저장하면 안 됩니다. 하루 정도는 비교적 안전하다고 볼 수 있습니다.

SearchLatestFloodStatusByArea
rpc SearchLatestFloodStatusByArea(SearchLatestFloodStatusByAreaRequest) returns (SearchLatestFloodStatusByAreaResponse) 지리적 지역별 최신 홍수 상태를 검색합니다. 참고: 영향을 받는 지역이 지정된 지역과 교차하는 것이 아니라 게이지가 지정된 지역 내에 있는 홍수 상태를 반환합니다. 이 내용은 향후 변경될 수 있습니다.

BatchGetGaugeModelsRequest

BatchGetGaugeModels 요청입니다.

필드
names[]	string 필수입니다. 가져올 게이지 모델 이름입니다. 이름 형식: gaugeModels/{gauge_id} 지원되는 목록 크기는 20,000개로 제한됩니다. 20,000보다 큰 목록이 제공되면 INVALID_REQUEST 오류와 함께 실패합니다.

BatchGetGaugeModelsResponse

BatchGetGaugeModels의 응답입니다.

필드
gauge_models[]	GaugeModel 요청된 게이지 모델입니다.

BatchGetGaugesRequest

BatchGetGauges 요청입니다.

필드
names[]	string 필수입니다. 가져올 게이지 이름입니다. 이름 형식: gauges/{gauge_id} 지원되는 목록 크기는 100,000개로 제한됩니다. 100,000개를 초과하는 목록이 제공되면 INVALID_REQUEST 오류와 함께 실패합니다.

BatchGetGaugesResponse

BatchGetGauges의 응답입니다.

필드
gauges[]	Gauge 요청된 게이지입니다.

FloodStatus

시스템에서 발행한 홍수 상태입니다. 심각도, 예측 변경, 침수 지도 등의 속성을 사용하여 시스템에서 특정 지역에 대해 예측한 홍수 상태를 나타냅니다. 자세한 내용은 아래를 참조하세요.

필드
gauge_id	string 이 상태가 발급된 게이지의 ID입니다.
quality_verified	bool 이 홍수 상태가 발급된 게이지에 모델이 없거나 모델이 있고 모델의 품질이 검증된 경우 True입니다. 이 값이 false로 설정된 경우 주의해서 사용하세요.
gauge_location	LatLng 이 상태가 발급된 게이지의 위치입니다.
issued_time	string 이 상태가 발급된 시간입니다 (문자열, ISO 8601). 예를 들면 다음과 같습니다. "2023-06-17T10:34:00Z".
forecast_time_range	TimeRange 예측이 예측하는 기간입니다.
forecast_change	ForecastChange 마지막으로 알려진 상태에서 예측으로의 예측 값 변경입니다. 현재 수위 모델에서만 사용할 수 있습니다.
forecast_trend	ForecastTrend 예측의 추세입니다.
map_inference_type	MapInferenceType 이 지도가 생성된 추론 유형입니다.
severity	Severity 상태의 심각도입니다.
inundation_map_set	InundationMapSet 추론된 침수 지도 세트입니다.
source	string 이 게이지의 데이터를 담당하는 조직입니다(예: GRDC, CWC 등
serialized_notification_polygon_id	string 직렬화된 알림 다각형의 ID입니다. Google에서 사용자를 대상으로 알림을 전송할 시점을 결정하는 데 사용하는 지리적 영역을 나타냅니다. GetSerializedPolygon를 사용하여 직렬화된 다각형 자체를 가져옵니다.

ForecastChange

마지막으로 알려진 상태에서 예측까지의 예측 값 변경입니다. 현재 수위 모델에서만 사용할 수 있습니다.

필드
value_change	ValueChange 예측된 값의 변화입니다.
reference_time_range	TimeRange 마지막으로 알려진 상태의 시간 범위로, 이 상태에서 값 변경을 예측합니다. 예를 들어 참조 시간 범위가 어제로 설정되어 있고 값 변경이 25~30cm일 수 있습니다. 즉, 현재 값이 아닌 어제 값과 비교하여 수위가 25~30cm 상승했음을 의미합니다.

ValueChange

예측된 값의 변화(상한 및 하한)입니다.

필드
lower_bound	double 예측 변경의 하한(미터)입니다. 변경사항이 20~30인 경우 이 값은 20이 됩니다. 변경사항이 -30에서 -20 사이인 경우 이 값은 -30이 됩니다.
upper_bound	double 예측 변화의 상한(미터)입니다. 변경사항이 20~30인 경우 이 값은 30이 됩니다. 변경사항이 -30과 -20 사이인 경우 이 값은 -20이 됩니다.

ForecastTrend

예측의 추세를 나타내는 열거형입니다.

열거형
FORECAST_TREND_UNSPECIFIED	기본값 이 값은 사용되지 않습니다.
RISE	예측 값이 상승했음을 나타냅니다.
FALL	예측 값이 감소했음을 나타냅니다.
NO_CHANGE	예측 값이 변경되지 않았음을 나타냅니다.

InundationMap

침수 지도 1개

필드
level	InundationLevel 침수 지도 수준입니다. InundationMapType에 따라 문서를 참고하세요.
serialized_polygon_id	string 이 침수 위험 지도를 나타내는 직렬화된 다각형의 ID입니다. GetSerializedPolygon를 사용하여 직렬화된 다각형 자체를 가져옵니다.

InundationLevel

침수 수준을 나타내는 enum입니다.

열거형
INUNDATION_LEVEL_UNSPECIFIED	기본값 이 값은 사용되지 않습니다.
HIGH	InundationMapType에 따라 문서를 참고하세요.
MEDIUM	InundationMapType에 따라 문서를 참고하세요.
LOW	InundationMapType에 따라 문서를 참고하세요.

InundationMapSet

침수 지도 세트입니다.

필드
inundation_maps[]	InundationMap 침수 지도(침수 수준별로 하나씩)
inundation_maps_time_range	TimeRange 침수 지도가 참조하는 상태의 시간 범위입니다.
inundation_map_type	InundationMapType 침수 지도 유형입니다.

InundationMapType

침수 지도 유형을 나타내는 열거형입니다.

열거형
INUNDATION_MAP_TYPE_UNSPECIFIED	기본값 이 값은 사용되지 않습니다.
PROBABILITY	유형 확률 지도입니다. InundationLevel은 지도 확률(범람 가능성이 높음/중간/낮음)을 나타냅니다. 확률이 높은 다각형은 확률이 중간인 다각형 내에 포함되고 확률이 중간인 다각형은 확률이 낮은 다각형 내에 포함됩니다.
DEPTH	깊이 유형의 지도입니다. InundationLevel은 위치별 지도 깊이(높음/중간/낮음)를 나타냅니다. 깊이가 높은 다각형은 깊이가 중간인 다각형 내에 포함되고 깊이가 중간인 다각형은 깊이가 낮은 다각형 내에 포함됩니다.

MapInferenceType

지도 추론 유형을 나타내는 열거형입니다.

열거형
MAP_INFERENCE_TYPE_UNSPECIFIED	기본값 이 값은 사용되지 않습니다.
MODEL	이는 이 추론이 모델을 사용하여 생성되었음을 나타냅니다.
IMAGE_CLASSIFICATION	이는 이 추론이 이미지 분류를 사용하여 생성되었음을 나타냅니다.

심각도

상태의 심각도를 나타내는 열거형입니다.

열거형
SEVERITY_UNSPECIFIED	기본값 이 값은 사용되지 않습니다.
EXTREME	예상되는 극심한 상태를 나타냅니다.
SEVERE	예상되는 심각한 상태를 나타냅니다.
ABOVE_NORMAL	이는 예상되는 상태가 정상보다 높음을 나타냅니다.
NO_FLOODING	홍수가 없을 것으로 예측됨을 나타냅니다.
UNKNOWN	이는 심각도를 판단하기에 정보가 충분하지 않음을 나타냅니다.

예측

여러 리드 타임에 대한 단일 게이지의 예측입니다. 예를 들어 예측의 문제 시간이 오후 5시이고 오후 6시, 오후 7시, 오후 8시 등의 예측이 포함될 수 있습니다.

참고: 일부 예측 범위는 발급 시간보다 빠를 수 있습니다. 이는 모델의 입력 데이터 지연 등으로 인해 발생할 수 있습니다. 위의 예시에서 문제 시간은 오후 5시이고 예측 범위는 오후 4시, 오후 5시, 오후 6시 등일 수 있습니다.

참고: 범위의 길이와 범위 간 거리는 다양합니다. 가능한 범위의 예는 다음과 같습니다.

1. [오후 5시~오후 5시], [오후 6시~오후 6시], [오후 7시~오후 7시]

2. [3월 1일 오전 12시~3월 2일 오전 12시], [3월 2일 오전 12시~3월 3일 오전 12시], [3월 3일 오전 12시~3월 4일 오전 12시]

필드
forecast_ranges[]	ForecastTimedValue 예측은 여러 '예측 범위'로 구성되며, 이는 서로 다른 시간 범위와 관련된 서로 다른 예측 값입니다. 범위의 시작과 끝이 같으면 시간 순간을 의미합니다.
gauge_id	string 이 예측의 게이지 ID입니다.
issued_time	string 예보가 발표된 시간입니다 (ISO 8601). 예를 들어 '2023-06-17T10:34:00Z'입니다. 발급 시간은 예측이 생성된 시간입니다.

ForecastSet

게이지의 예측 집합입니다.

필드
forecasts[]	Forecast 예측입니다.

ForecastTimedValue

시간 범위와 관련된 예측 값입니다. 단위는 연결된 GaugeModel에 의해 정의됩니다. 시작과 끝이 같으면 시간 순간을 의미합니다.

필드
value	double 예측 값입니다.
forecast_start_time	string 간격의 시작입니다.
forecast_end_time	string 간격의 끝입니다.

게이지

게이지의 메타데이터입니다.

필드
location	LatLng 게이지의 실제 위치입니다.
site_name	string 이 게이지가 있는 사이트의 이름입니다(영어로). 고유 식별자가 아닙니다. 근처 위치에 동일한 사이트 이름의 게이지가 여러 개 있을 수 있습니다. 항상 존재하는 값은 아닙니다.
source	string 이 게이지의 데이터를 담당하는 조직입니다(예: GRDC, CWC 등).
river	string 게이지의 강 이름(영어)입니다. 항상 존재하는 값은 아닙니다.
country_code	string 게이지 국가의 국가 코드 (ISO 3166 Alpha-2)입니다.
gauge_id	string 게이지의 ID입니다.
quality_verified	bool 게이지에 모델이 없거나 모델이 있고 모델의 품질이 검증된 경우 이 필드는 true입니다. 이 값이 false로 설정된 경우 주의해서 사용하세요.
has_model	bool 게이지에 모델이 있으면 이 필드는 true입니다. 게이지에 모델이 있는 경우 GetGaugeModel 또는 BatchGetGaugeModels를 사용하여 이 게이지의 GaugeModel를 가져올 수 있습니다. QueryGaugeForecasts를 사용하여 일기 예보를 가져옵니다.

GaugeModel

게이지 모델의 메타데이터입니다.

필드
gauge_id	string 게이지의 ID입니다.
gauge_model_id	string 게이지 모델의 ID입니다. 게이지 모델이 변경되는 경우가 있으며, 이 경우 새 모델에 새 ID와 새 기준점이 할당됩니다. 오래된 예측과 새로운 예측을 비교할 때 서로 다른 모델로 생성된 경우 주의하세요.
thresholds	Thresholds 게이지의 기준점입니다.
gauge_value_unit	GaugeValueUnit 게이지 모델의 값 단위입니다.
quality_verified	bool 이 모델이 품질 검증을 거쳤는지 여부입니다. 이 값이 false로 설정된 경우 주의해서 사용하세요.

GaugeValueUnit

가능한 게이지 값 단위입니다.

열거형
GAUGE_VALUE_UNIT_UNSPECIFIED	기본값 이 값은 사용되지 않습니다.
METERS	미터
CUBIC_METERS_PER_SECOND	초당 입방미터입니다.

GetGaugeModelRequest

GetGaugeModel의 요청입니다.

필드
name	string 필수입니다. 가져올 게이지 모델 이름입니다. 이름 형식: gaugeModels/{gauge_id}

GetGaugeRequest

GetGauge 요청입니다.

필드
name	string 필수입니다. 가져올 게이지의 이름입니다. 이름 형식: gauges/{gauge_id}

GetSerializedPolygonRequest

GetSerializedPolygon의 요청입니다.

필드
name	string 필수입니다. 검색할 직렬화된 다각형의 이름입니다. 이름 형식: serializedPolygons/{polygon_id}

연속 재생

지도상의 루프입니다. 단순 구면 다각형을 나타냅니다. 첫 번째 꼭짓점이 마지막 꼭짓점에 암시적으로 연결된 단일 꼭짓점 체인으로 구성됩니다.

필드
vertices[]	LatLng 필수입니다. 루프의 꼭짓점입니다.

QueryGaugeForecastsRequest

QueryGaugeForecasts의 요청입니다.

필드
gauge_ids[]	string 필수입니다. 게이지 ID 목록입니다. 지원되는 목록 크기는 500으로 제한됩니다. 500보다 큰 목록이 제공되면 INVALID_REQUEST 오류와 함께 실패합니다.
issued_time_start	string 선택사항입니다. 가장 빠른 예측 발급 시간(문자열, ISO 8601)(예: '2023-06-17T10:34:00Z') 또는 날짜 문자열(예: '2023-10-13')입니다. 시작 시간은 '2023-10-01'보다 이전일 수 없습니다. 기본값은 1주일 전입니다.
issued_time_end	string 선택사항입니다. 문자열(ISO 8601)로 표시된 최신 일기예보 발급 시간입니다(예: '2023-06-17T10:34:00Z' 또는 날짜 문자열 '2023-10-13'). 기본값은 현재입니다.

QueryGaugeForecastsResponse

QueryGaugeForecasts의 응답입니다.

필드
forecasts	map<string, ForecastSet> 게이지 ID에서 예측 세트로의 맵입니다.

QueryLatestFloodStatusByGaugeIdsRequest

QueryLatestFloodStatusByGaugeIds 요청입니다.

필드
gauge_ids[]	string 필수입니다. 게이지 ID 목록입니다. 지원되는 목록 크기는 20,000개로 제한됩니다. 20,000보다 큰 목록이 제공되면 INVALID_REQUEST 오류와 함께 실패합니다.

QueryLatestFloodStatusByGaugeIdsResponse

QueryLatestFloodStatusByGaugeIds의 응답입니다.

필드
flood_statuses[]	FloodStatus 요청된 게이지의 최신 홍수 상태입니다.

SearchGaugesByAreaRequest

SearchGaugesByArea의 요청입니다.

필드
page_size	int32 선택사항입니다. 반환할 최대 게이지 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 50,000개의 게이지가 반환됩니다. 최댓값은 50,000이며, 50,000을 초과하는 값은 50,000으로 변환됩니다.
page_token	string 선택사항입니다. 이전 SearchGauges 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우, SearchGauges에 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다.
통합 필드 search_by. search_by는 다음 중 하나여야 합니다.
region_code	string 지역 코드로 지역 내 모든 게이지를 검색합니다. https://cldr.unicode.org/ (https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) 목록)을 사용합니다.
loop	Loop 루프 내의 모든 게이지를 검색합니다 (간단한 구형 다각형, Loop 참고).
include_non_quality_verified	bool 선택사항입니다. 품질이 검증되지 않은 게이지를 결과에 포함합니다. 주의해서 사용하세요. 기본값은 false입니다.
include_gauges_without_hydro_model	bool 선택사항입니다. Google 자체 수력 모델이 없는 결과 게이지에 포함합니다. 기본값은 false입니다.

SearchGaugesByAreaResponse

SearchGaugesByArea의 응답입니다.

필드
gauges[]	Gauge 요청된 지역에서 발견된 게이지입니다.
next_page_token	string 선택사항입니다. 다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

SearchLatestFloodStatusByAreaRequest

SearchLatestFloodStatusByArea의 요청입니다.

필드
page_token	string 선택사항입니다. 이전 SearchLatestFloodStatusByArea 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다. 페이지로 나누는 경우, SearchLatestFloodStatusByArea에 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다.
page_size	int32 선택사항입니다. 반환할 최대 플러드 상태 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 20,000개의 플러드 상태가 반환됩니다. 최댓값은 20,000이며, 20,000 이상의 값은 20,000으로 변환됩니다.
통합 필드 area_type. area_type는 다음 중 하나여야 합니다.
region_code	string 홍수 상태를 쿼리할 리전입니다. CLDR 사용(예: 'US'
loop	Loop 플러드 상태를 쿼리할 루프입니다.
include_non_quality_verified	bool 선택사항입니다. 품질이 검증되지 않은 게이지를 결과에 포함합니다. 주의해서 사용하세요. 기본값은 false입니다.

SearchLatestFloodStatusByAreaResponse

SearchLatestFloodStatusByArea의 응답입니다.

필드
flood_statuses[]	FloodStatus 요청된 지역의 최신 홍수 상태입니다. 현재는 게이지의 위치에 따라 결정되지만 향후 변경될 수 있습니다.
next_page_token	string 선택사항입니다. 다음 페이지를 검색하기 위해 page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

SerializedPolygon

직렬화된 다각형입니다.

필드
polygon_id	string 폴리곤의 ID입니다.
kml	string 다각형의 KML 문자열 표현입니다.

기준

게이지 모델의 기준점입니다.

필드
warning_level	double 경고 수준입니다.
danger_level	double 위험 수준입니다.
extreme_danger_level	double 매우 위험한 수준입니다. 항상 존재하는 값은 아닙니다.

TimeRange

기간입니다.

필드
start	string 기간의 시작입니다. ISO 8601로 표현됩니다(예: "2023-06-17T10:34:00Z".
end	string 기간의 종료입니다. ISO 8601로 표현됩니다(예: "2023-06-17T10:34:00Z".