setSyncAuthorization method

Future<GoogleCloudApigeeV1SyncAuthorization> setSyncAuthorization(
  1. GoogleCloudApigeeV1SyncAuthorization request,
  2. String name, {
  3. String? $fields,
})

Sets the permissions required to allow the Synchronizer to download environment data from the control plane.

You must call this API to enable proper functioning of hybrid. Pass the ETag when calling setSyncAuthorization to ensure that you are updating the correct version. To get an ETag, call [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.

request - The metadata request object.

Request parameters:

name - Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org} Value must have pattern ^organizations/\[^/\]+$.

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

Completes with a GoogleCloudApigeeV1SyncAuthorization.

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<GoogleCloudApigeeV1SyncAuthorization> setSyncAuthorization(
  GoogleCloudApigeeV1SyncAuthorization request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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