getEffectiveOrgPolicy method

Future<OrgPolicy> getEffectiveOrgPolicy(GetEffectiveOrgPolicyRequest request, String resource, { String? $fields, })

Gets the effective Policy on a resource.

This is the result of merging Policies in the resource hierarchy. The returned Policy will not have an etagset because it is a computed Policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

request - The metadata request object.

Request parameters:

resource - The name of the resource to start computing the effective Policy. Value must have pattern ^organizations/\[^/\]+$.

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

Completes with a OrgPolicy.

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<OrgPolicy> getEffectiveOrgPolicy(
  GetEffectiveOrgPolicyRequest request,
  core.String resource, {
  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('$resource') + ':getEffectiveOrgPolicy';

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