Method: serializedPolygons.get
Stay organized with collections
Save and categorize content based on your preferences.
Get a serialized polygon. IDs for these will appear in other API Responses, and you'll be able to use these IDs here. For example, see InundationMap
in FloodStatus
.
HTTP request
GET https://floodforecasting.googleapis.com/v1/{name=serializedPolygons/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
Required. The name of the serialized polygon to retrieve. Name format: serializedPolygons/{polygonId}
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of SerializedPolygon
.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eThe webpage provides details on retrieving a serialized polygon using a \u003ccode\u003eGET\u003c/code\u003e request.\u003c/p\u003e\n"],["\u003cp\u003eThe URL structure follows gRPC Transcoding syntax, and the \u003ccode\u003ename\u003c/code\u003e parameter is required for specifying the polygon to retrieve, following the format \u003ccode\u003eserializedPolygons/{polygonId}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for retrieving a serialized polygon must be empty.\u003c/p\u003e\n"],["\u003cp\u003eA successful \u003ccode\u003eGET\u003c/code\u003e request returns an instance of \u003ccode\u003eSerializedPolygon\u003c/code\u003e in the response body.\u003c/p\u003e\n"]]],[],null,["# Method: serializedPolygons.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n\nGet a serialized polygon. IDs for these will appear in other API Responses, and you'll be able to use these IDs here. For example, see [InundationMap](/flood-forecasting/rest/v1/floodStatus#InundationMap) in [FloodStatus](/flood-forecasting/rest/v1/floodStatus#FloodStatus).\n\n### HTTP request\n\n`GET https://floodforecasting.googleapis.com/v1/{name=serializedPolygons/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|----------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the serialized polygon to retrieve. Name format: serializedPolygons/{polygonId} |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [SerializedPolygon](/flood-forecasting/rest/v1/serializedPolygons#SerializedPolygon)."]]