get method
Gets the DatabaseInstance identified by the specified resource name.
Request parameters:
name
- Required. The fully qualified resource name of the database
instance, in the form:
projects/{project-number}/locations/{location-id}/instances/{database-id}
.
database-id
is a globally unique identifier across all parent
collections. For convenience, this method allows you to supply -
as a
wildcard character in place of specific collections under projects
and
locations
. The resulting wildcarding form of the method is:
projects/-/locations/-/instances/{database-id}
.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a DatabaseInstance.
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<DatabaseInstance> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1beta/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return DatabaseInstance.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}