updateControlPlaneAccess method

Future<GoogleLongrunningOperation> updateControlPlaneAccess(GoogleCloudApigeeV1ControlPlaneAccess request, String name, { String? updateMask, String? $fields, })

Updates the permissions required to allow Apigee runtime-plane components access to the control plane.

Currently, the permissions required are to: 1. Allow runtime components to publish analytics data to the control plane. Note: Available to Apigee hybrid only.

request - The metadata request object.

Request parameters:

name - Identifier. The resource name of the ControlPlaneAccess. Format: "organizations/{org}/controlPlaneAccess" Value must have pattern ^organizations/\[^/\]+/controlPlaneAccess$.

updateMask - List of fields to be updated. Fields that can be updated: synchronizer_identities, publisher_identities.

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

Completes with a GoogleLongrunningOperation.

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

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

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