checkStatus method

Future<CheckStatusResponse> checkStatus(
  1. String name, {
  2. String? $fields,
})

Reports the status of the connection.

Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed.

Request parameters:

name - null Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/connections/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a CheckStatusResponse.

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<CheckStatusResponse> checkStatus(
  core.String name, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':checkStatus';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return CheckStatusResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}