Managed Service for YDB API, gRPC: LocationService
Written by
Updated at December 13, 2022
Call | Description |
---|---|
Get | Returns the specified location. |
List | Returns the list of available locations. |
Calls LocationService
Get
Returns the specified location.
rpc Get (GetLocationRequest) returns (Location)
GetLocationRequest
Field | Description |
---|---|
location_id | string Required. Required. ID of the location to return. |
Location
Field | Description |
---|---|
id | string |
description | string |
List
Returns the list of available locations.
rpc List (ListLocationsRequest) returns (ListLocationsResponse)
ListLocationsRequest
Field | Description |
---|---|
page_size | int64 The maximum number of results per page that should be returned. If the number of available results is larger than page_size , the service returns a next_page_token that can be used to get the next page of results in subsequent ListLocations requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. Set page_token to the next_page_token returned by a previous ListLocations request to get the next page of results. The maximum string length in characters is 100. |
ListLocationsResponse
Field | Description |
---|---|
locations[] | Location Requested list of locations. |
next_page_token | string This token allows you to get the next page of results for ListLocations requests, if the number of results is larger than page_size specified in the request. To get the next page, specify the value of next_page_token as a value for the page_token parameter in the next ListLocations request. Subsequent ListLocations requests will have their own next_page_token to continue paging through the results. |
Location
Field | Description |
---|---|
id | string |
description | string |