failover method

Future<Operation> failover(
  1. InstancesFailoverRequest request,
  2. String project,
  3. String instance, {
  4. String? $fields,
})

Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance.

Users are then rerouted to the new primary. For more information, see the Overview of high availability page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.

request - The metadata request object.

Request parameters:

project - ID of the project that contains the read replica.

instance - Cloud SQL instance ID. This does not include the project ID.

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

Completes with a Operation.

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<Operation> failover(
  InstancesFailoverRequest request,
  core.String project,
  core.String instance, {
  core.String? $fields,
}) async {
  final _body = convert.json.encode(request.toJson());
  final _queryParams = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'sql/v1beta4/projects/' +
      commons.escapeVariable('$project') +
      '/instances/' +
      commons.escapeVariable('$instance') +
      '/failover';

  final _response = await _requester.request(
    _url,
    'POST',
    body: _body,
    queryParams: _queryParams,
  );
  return Operation.fromJson(_response as core.Map<core.String, core.dynamic>);
}