get method
Retrieves a NetworkPeering
resource by its resource name.
The resource contains details of the network peering, such as peered networks, import and export custom route configurations, and peering state. NetworkPeering is a global resource and location can only be global.
Request parameters:
name
- Required. The resource name of the network peering to retrieve.
Resource names are schemeless URIs that follow the conventions in
https://cloud.google.com/apis/design/resource_names. For example:
projects/my-project/locations/global/networkPeerings/my-peering
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/networkPeerings/\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a NetworkPeering.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<NetworkPeering> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return NetworkPeering.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}