Package google.research.floodforecasting.v1

Indeks

FloodsApi

Layanan API eksternal untuk Prakiraan Banjir.

BatchGetGaugeModels

rpc BatchGetGaugeModels(BatchGetGaugeModelsRequest) returns (BatchGetGaugeModelsResponse)

Mendapatkan metadata model hidrologi saat ini untuk beberapa pengukur.
BatchGetGauges

rpc BatchGetGauges(BatchGetGaugesRequest) returns (BatchGetGaugesResponse)

Mendapatkan metadata tentang beberapa alat pengukur.
GetGauge

rpc GetGauge(GetGaugeRequest) returns (Gauge)

Mendapatkan metadata tentang pengukur.
GetGaugeModel

rpc GetGaugeModel(GetGaugeModelRequest) returns (GaugeModel)

Mendapatkan metadata model hidrologi saat ini untuk alat pengukur tertentu.
GetSerializedPolygon

rpc GetSerializedPolygon(GetSerializedPolygonRequest) returns (SerializedPolygon)

Mendapatkan poligon berseri. ID untuk ini akan muncul di Respons API lainnya, dan Anda akan dapat menggunakan ID ini di sini. Misalnya, lihat InundationMap di FloodStatus.
QueryGaugeForecasts

rpc QueryGaugeForecasts(QueryGaugeForecastsRequest) returns (QueryGaugeForecastsResponse)

Kueri perkiraan pengukur.
QueryLatestFloodStatusByGaugeIds

rpc QueryLatestFloodStatusByGaugeIds(QueryLatestFloodStatusByGaugeIdsRequest) returns (QueryLatestFloodStatusByGaugeIdsResponse)

Kueri status banjir terbaru menurut ID alat pengukur.
SearchGaugesByArea

rpc SearchGaugesByArea(SearchGaugesByAreaRequest) returns (SearchGaugesByAreaResponse)

Telusuri indikator menurut area geografis.

Catatan: Pengukur terkadang ditambahkan atau dihapus, sehingga hasil API ini tidak boleh di-cache atau disimpan dalam jangka waktu yang lama. Pertimbangkan tidak lebih dari satu hari agar relatif aman.
SearchLatestFloodStatusByArea

rpc SearchLatestFloodStatusByArea(SearchLatestFloodStatusByAreaRequest) returns (SearchLatestFloodStatusByAreaResponse)

Telusuri status banjir terbaru menurut area geografis. Catatan: Menampilkan status banjir yang pengukurnya berada dalam area tertentu, bukan misalnya, area yang terpengaruh beririsan dengan area tertentu. Hal ini sewaktu-waktu dapat berubah pada masa mendatang.

BatchGetGaugeModelsRequest

Permintaan BatchGetGaugeModels.

Kolom
names[]

string

Wajib. Nama model pengukur yang akan diambil. Format nama: gaugeModels/{gauge_id}. Ukuran daftar yang didukung dibatasi hingga 20.000. Jika daftar yang lebih besar dari 20.000 diberikan,permintaan akan gagal dengan error INVALID_REQUEST.

BatchGetGaugeModelsResponse

Respons BatchGetGaugeModels.

Kolom
gauge_models[]

GaugeModel

Model alat pengukur yang diminta.

BatchGetGaugesRequest

Permintaan BatchGetGauges.

Kolom
names[]

string

Wajib. Nama pengukur yang akan diambil. Format nama: gauges/{gauge_id}. Ukuran daftar yang didukung dibatasi hingga 100.000. Jika daftar yang lebih besar dari 100.000 diberikan,daftar tersebut akan gagal dengan error INVALID_REQUEST.

BatchGetGaugesResponse

Respons BatchGetGauges.

Kolom
gauges[]

Gauge

Pengukur yang diminta.

FloodStatus

Status Banjir yang dikeluarkan oleh sistem. Mewakili status banjir yang diperkirakan oleh sistem untuk suatu area, dengan atribut seperti tingkat keparahan, perubahan perkiraan, peta banjir, dan lainnya. Lihat di bawah untuk mengetahui detail selengkapnya.

Kolom
gauge_id

string

ID pengukur yang statusnya dikeluarkan.
quality_verified

bool

Benar (True) jika alat pengukur yang mengeluarkan status banjir ini tidak memiliki model, atau jika memiliki model dan model tersebut telah diverifikasi kualitasnya. Gunakan dengan hati-hati jika nilai ini ditetapkan ke salah (false).
gauge_location

LatLng

Lokasi alat pengukur yang mengeluarkan status ini.
issued_time

string

Waktu status ini dikeluarkan sebagai string (ISO 8601), misalnya, "2023-06-17T10:34:00Z".
forecast_time_range

TimeRange

Rentang waktu yang diprediksi oleh perkiraan.
forecast_change

ForecastChange

Perubahan nilai perkiraan dari status terakhir yang diketahui ke perkiraan. Saat ini hanya tersedia untuk model Level Air.
forecast_trend

ForecastTrend

Tren perkiraan.
map_inference_type

MapInferenceType

Jenis inferensi yang digunakan untuk membuat peta ini.
severity

Severity

Tingkat keparahan status.
inundation_map_set

InundationMapSet

Kumpulan peta banjir yang disimpulkan.
source

string

Organisasi yang bertanggung jawab atas data pengukur ini, misalnya, GRDC, CWC, dll.
serialized_notification_polygon_id

string

ID poligon notifikasi berserial, yang merepresentasikan area geografis yang digunakan Google untuk menentukan kapan harus memberi tahu penggunanya. Gunakan GetSerializedPolygon untuk mendapatkan poligon yang diserialisasi itu sendiri.

ForecastChange

Perubahan nilai yang diperkirakan dari status terakhir yang diketahui hingga perkiraan. Saat ini hanya tersedia untuk model Level Air.

Kolom
value_change

ValueChange

Perkiraan perubahan nilai.
reference_time_range

TimeRange

Rentang waktu status terakhir yang diketahui, yang digunakan untuk memprediksi perubahan nilai. Misalnya, kita mungkin memiliki rentang waktu rujukan yang ditetapkan ke kemarin, dan perubahan nilai 25-30 cm. Artinya, kenaikan permukaan air sebesar 25-30 cm dibandingkan dengan nilainya kemarin, bukan dari nilainya sekarang.

ValueChange

Perkiraan perubahan nilai - batas atas dan bawah.

Kolom
lower_bound

double

Batas bawah perubahan perkiraan dalam meter. Jika perubahannya antara 20 dan 30, nilai ini adalah 20. Jika perubahannya antara -30 dan -20, nilai ini akan menjadi -30.
upper_bound

double

Batas atas perubahan perkiraan dalam meter. Jika perubahannya antara 20 dan 30, nilai ini adalah 30. Jika perubahannya antara -30 dan -20, nilai ini akan menjadi -20.

ForecastTrend

Enum yang merepresentasikan tren perkiraan.

Enum
FORECAST_TREND_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
RISE Hal ini menunjukkan peningkatan nilai yang diperkirakan.
FALL Hal ini menunjukkan penurunan nilai yang diperkirakan.
NO_CHANGE Hal ini menunjukkan tidak ada perubahan pada nilai perkiraan.

InundationMap

Satu peta banjir.

Kolom
level

InundationLevel

Tingkat peta banjir - Lihat dokumentasi berdasarkan InundationMapType.
serialized_polygon_id

string

ID poligon berserial yang merepresentasikan peta risiko banjir ini. Gunakan GetSerializedPolygon untuk mendapatkan poligon yang diserialisasi itu sendiri.

InundationLevel

Enum yang merepresentasikan tingkat genangan.

Enum
INUNDATION_LEVEL_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
HIGH Lihat dokumentasi berdasarkan InundationMapType.
MEDIUM Lihat dokumentasi berdasarkan InundationMapType.
LOW Lihat dokumentasi berdasarkan InundationMapType.

InundationMapSet

Kumpulan peta banjir.

Kolom
inundation_maps[]

InundationMap

Peta banjir, satu untuk setiap tingkat banjir.
inundation_maps_time_range

TimeRange

Rentang waktu keadaan yang dirujuk oleh peta banjir.
inundation_map_type

InundationMapType

Jenis peta banjir.

InundationMapType

Enum yang merepresentasikan jenis peta banjir.

Enum
INUNDATION_MAP_TYPE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
PROBABILITY Peta probabilitas jenis. InundationLevel mewakili probabilitas peta - probabilitas banjir tinggi/sedang/rendah. Poligon probabilitas tinggi berada di dalam poligon probabilitas sedang dan poligon probabilitas sedang berada di dalam poligon probabilitas rendah.
DEPTH Peta jenis kedalaman. InundationLevel mewakili kedalaman peta - kedalaman tinggi/sedang/rendah per lokasi. Poligon kedalaman tinggi berada dalam poligon kedalaman sedang dan poligon kedalaman sedang berada dalam poligon kedalaman rendah.

MapInferenceType

Enum yang merepresentasikan jenis inferensi peta.

Enum
MAP_INFERENCE_TYPE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
MODEL Hal ini menunjukkan bahwa inferensi ini dibuat menggunakan model.
IMAGE_CLASSIFICATION Hal ini menunjukkan bahwa inferensi ini dibuat menggunakan klasifikasi gambar.

Keparahan

Enum yang merepresentasikan tingkat keparahan status.

Enum
SEVERITY_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
EXTREME Hal ini menunjukkan status ekstrem yang diperkirakan.
SEVERE Hal ini menunjukkan status berat yang diperkirakan.
ABOVE_NORMAL Hal ini menunjukkan status yang diperkirakan di atas normal.
NO_FLOODING Hal ini menunjukkan prakiraan tidak ada banjir.
UNKNOWN Hal ini menunjukkan bahwa kami tidak memiliki cukup informasi untuk menentukan tingkat keparahan.

Perkiraan

Prakiraan satu pengukur untuk beberapa waktu tunggu. Misalnya, perkiraan cuaca dapat memiliki waktu penerbitan pukul 17.00, dan mencakup perkiraan cuaca untuk pukul 18.00, 19.00, 20.00, dll.

Catatan: Beberapa rentang perkiraan berpotensi lebih awal dari waktu penerbitan. Hal ini dapat terjadi karena, misalnya, keterlambatan dalam data input untuk model. Dengan contoh di atas, masalahnya mungkin terjadi pada pukul 17.00, dan rentang perkiraan adalah untuk pukul 16.00, 17.00, 18.00, dll.

Catatan: Rentang bervariasi dalam panjang, dan dalam jarak di antara keduanya. Beberapa contoh kemungkinan rentang adalah:

  1. [17.00 - 17.00], [18.00 - 18.00], [19.00 - 19.00]

  2. [1 Mar 00.00 - 2 Mar 00.00], [2 Mar 00.00 - 3 Mar 00.00], [3 Mar 00.00 - 4 Mar 00.00]

Kolom
forecast_ranges[]

ForecastTimedValue

Perkiraan terdiri dari beberapa "rentang perkiraan", yang merupakan nilai perkiraan berbeda yang berkaitan dengan rentang waktu yang berbeda. Jika awal dan akhir rentang sama, berarti itu adalah waktu instan.
gauge_id

string

ID alat pengukur yang digunakan untuk perkiraan ini.
issued_time

string

Waktu penerbitan perkiraan cuaca (ISO 8601), misalnya "2023-06-17T10:34:00Z". Waktu penerbitan adalah waktu saat perkiraan dibuat.

ForecastSet

Kumpulan perkiraan untuk alat pengukur.

Kolom
forecasts[]

Forecast

Perkiraan.

ForecastTimedValue

Nilai perkiraan yang berkaitan dengan rentang waktu. Unitnya ditentukan oleh GaugeModel yang terkait dengannya. Jika awal dan akhir sama, berarti ini adalah waktu instan.

Kolom
value

double

Nilai perkiraan.
forecast_start_time

string

Awal interval.
forecast_end_time

string

Akhir interval.

Meteran

Metadata pengukur.

Kolom
location

LatLng

Lokasi fisik pengukur.
site_name

string

Nama situs tempat pengukur ini berada, dalam bahasa Inggris. Ini bukan pengidentifikasi unik; mungkin ada beberapa pengukur di lokasi terdekat dengan nama situs yang sama. Tidak selalu ada.
source

string

Organisasi yang bertanggung jawab atas data pengukur ini, misalnya GRDC, CWC, dll.
river

string

Nama sungai pengukur dalam bahasa Inggris. Tidak selalu ada.
country_code

string

Kode negara dari negara pengukur (ISO 3166 Alpha-2).
gauge_id

string

ID pengukur.
quality_verified

bool

Kolom ini bernilai benar (true) jika alat pengukur tidak memiliki model, atau jika alat pengukur memiliki model dan model tersebut telah diverifikasi kualitasnya. Gunakan dengan hati-hati jika nilai ini ditetapkan ke salah (false).
has_model

bool

Kolom ini benar jika pengukur memiliki model. Jika memiliki model, pengukur dapat memperoleh GaugeModel pengukur ini menggunakan GetGaugeModel atau BatchGetGaugeModels. Dan juga mendapatkan perkiraannya menggunakan QueryGaugeForecasts.

GaugeModel

Metadata model pengukur.

Kolom
gauge_id

string

ID pengukur.
gauge_model_id

string

ID model pengukur. Dari waktu ke waktu, model untuk pengukur dapat berubah, dan dalam hal ini kami akan menetapkan ID baru dan nilai minimum baru ke model baru. Berhati-hatilah saat membandingkan perkiraan lama dengan perkiraan baru jika perkiraan tersebut dibuat oleh model yang berbeda.
thresholds

Thresholds

Nilai minimum pengukur.
gauge_value_unit

GaugeValueUnit

Unit nilai model pengukur.
quality_verified

bool

Apakah model ini diverifikasi kualitasnya. Gunakan dengan hati-hati jika nilai ini ditetapkan ke salah (false).

GaugeValueUnit

Kemungkinan satuan nilai pengukur.

Enum
GAUGE_VALUE_UNIT_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
METERS Meter.
CUBIC_METERS_PER_SECOND Meter kubik per detik.

GetGaugeModelRequest

Permintaan GetGaugeModel.

Kolom
name

string

Wajib. Nama model pengukur yang akan diambil. Format nama: gaugeModels/{gauge_id}.

GetGaugeRequest

Permintaan GetGauge.

Kolom
name

string

Wajib. Nama pengukur yang akan diambil. Format nama: gauges/{gauge_id}.

GetSerializedPolygonRequest

Permintaan GetSerializedPolygon.

Kolom
name

string

Wajib. Nama poligon berserial yang akan diambil. Format nama: serializedPolygons/{polygon_id}

Loop

Loop di peta. Mewakili poligon bola sederhana. Terdiri dari satu rantai verteks yang verteks pertamanya terhubung secara implisit ke verteks terakhir.

Kolom
vertices[]

LatLng

Wajib. Verteks loop.

QueryGaugeForecastsRequest

Permintaan QueryGaugeForecasts.

Kolom
gauge_ids[]

string

Wajib. Daftar ID pengukur. Ukuran daftar yang didukung dibatasi hingga 500. Jika daftar yang diberikan lebih besar dari 500, permintaan akan gagal dengan error INVALID_REQUEST.
issued_time_start

string

Opsional. Waktu penerbitan perkiraan paling awal sebagai string (ISO 8601), misalnya "2023-06-17T10:34:00Z" atau string tanggal, misalnya "2023-10-13". Waktu mulai tidak boleh lebih awal dari "2023-10-01". Defaultnya adalah satu minggu yang lalu.
issued_time_end

string

Opsional. Waktu penerbitan perkiraan terbaru sebagai string (ISO 8601), misalnya "2023-06-17T10:34:00Z" atau string tanggal, misalnya "2023-10-13". Default-nya adalah sekarang.

QueryGaugeForecastsResponse

Respons QueryGaugeForecasts.

Kolom
forecasts

map<string, ForecastSet>

Peta dari ID pengukur ke set perkiraan.

QueryLatestFloodStatusByGaugeIdsRequest

Permintaan QueryLatestFloodStatusByGaugeIds.

Kolom
gauge_ids[]

string

Wajib. Daftar ID pengukur. Ukuran daftar yang didukung dibatasi hingga 20.000. Jika daftar yang lebih besar dari 20.000 diberikan,permintaan akan gagal dengan error INVALID_REQUEST.

QueryLatestFloodStatusByGaugeIdsResponse

Respons QueryLatestFloodStatusByGaugeIds.

Kolom
flood_statuses[]

FloodStatus

Status banjir terbaru untuk alat pengukur yang diminta.

SearchGaugesByAreaRequest

Permintaan SearchGaugesByArea.

Kolom
page_size

int32

Opsional. Jumlah maksimum kartu yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 50.000 pengukur akan ditampilkan. Nilai maksimumnya adalah 50.000; nilai di atas 50.000 akan dikonversi menjadi 50.000.
page_token

string

Opsional. Token halaman, diterima dari panggilan SearchGauges sebelumnya. Berikan ini untuk mengambil halaman selanjutnya. Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk SearchGauges harus sesuai dengan panggilan yang menyediakan token halaman.

Kolom union search_by.

search_by hanya dapat berupa salah satu dari hal berikut:
region_code

string

Telusuri semua pengukur dalam suatu wilayah berdasarkan kode wilayah. Gunakan https://cldr.unicode.org/ (daftar https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

Loop

Telusuri semua pengukur dalam loop (poligon bola sederhana, lihat Loop).
include_non_quality_verified

bool

Opsional. Sertakan dalam hasil alat pengukur yang tidak diverifikasi kualitasnya. Gunakan dengan hati-hati. Defaultnya adalah false.
include_gauges_without_hydro_model

bool

Opsional. Sertakan dalam alat pengukur hasil yang tidak memiliki model hidro in-house Google. Defaultnya adalah false.

SearchGaugesByAreaResponse

Respons SearchGaugesByArea.

Kolom
gauges[]

Gauge

Pengukur yang ditemukan di area yang diminta.
next_page_token

string

Opsional. Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

SearchLatestFloodStatusByAreaRequest

Permintaan SearchLatestFloodStatusByArea.

Kolom
page_token

string

Opsional. Token halaman, diterima dari panggilan SearchLatestFloodStatusByArea sebelumnya. Berikan ini untuk mengambil halaman selanjutnya. Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk SearchLatestFloodStatusByArea harus sesuai dengan panggilan yang menyediakan token halaman.
page_size

int32

Opsional. Jumlah maksimum status banjir yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 20.000 status banjir akan ditampilkan. Nilai maksimum adalah 20.000; nilai di atas 20.000 akan dikonversi menjadi 20.000.

Kolom union area_type.

area_type hanya dapat berupa salah satu dari hal berikut:
region_code

string

Wilayah yang akan digunakan untuk mengkueri status banjir. Menggunakan CLDR, misalnya, 'US'.
loop

Loop

Loop untuk mengkueri status banjir.
include_non_quality_verified

bool

Opsional. Sertakan dalam hasil alat pengukur yang tidak diverifikasi kualitasnya. Gunakan dengan hati-hati. Defaultnya adalah false.

SearchLatestFloodStatusByAreaResponse

Respons SearchLatestFloodStatusByArea.

Kolom
flood_statuses[]

FloodStatus

Status banjir terbaru di area yang diminta. Saat ini, hal ini ditentukan oleh lokasi pengukur, dan dapat berubah pada masa mendatang.
next_page_token

string

Opsional. Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

SerializedPolygon

Poligon yang diserialisasi.

Kolom
polygon_id

string

ID poligon.
kml

string

Representasi string KML dari poligon.

Batas

Nilai minimum model pengukur.

Kolom
warning_level

double

Tingkat peringatan.
danger_level

double

Tingkat bahaya.
extreme_danger_level

double

Tingkat bahaya ekstrem. Tidak selalu ada.

TimeRange

Rentang waktu.

Kolom
start

string

Awal rentang waktu. Direpresentasikan sebagai ISO 8601, misalnya, "2023-06-17T10:34:00Z".
end

string

Akhir rentang waktu. Direpresentasikan sebagai ISO 8601, misalnya, "2023-06-17T10:34:00Z".