getAuthString method

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

Gets the AUTH string for a Redis instance.

If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

Request parameters:

name - Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$.

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

Completes with a InstanceAuthString.

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<InstanceAuthString> getAuthString(
  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') + '/authString';

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