fetchAuthSchema method

Future<FetchAuthSchemaResponse> fetchAuthSchema(
  1. String name, {
  2. String? view,
  3. String? $fields,
})

fetch and return the list of auth config variables required to override the connection backend auth.

Request parameters:

name - Required. Parent resource of the Connector Version, of the form: projects / * /locations / * /providers / * /connectors / * /versions / * Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/providers/\[^/\]+/connectors/\[^/\]+/versions/\[^/\]+$.

view - Optional. View of the AuthSchema. The default value is BASIC. Possible string values are:

  • "AUTH_SCHEMA_VIEW_UNSPECIFIED" : Default value.
  • "BASIC" : Basic view of the AuthSchema.
  • "JSON_SCHEMA" : JSON schema view of the AuthSchema.
  • "EUA_SCHEMA" : EUA Schema view of the AuthSchema.

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

Completes with a FetchAuthSchemaResponse.

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

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

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