getEffectivePolicy method

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

Gets the effective policy on a resource.

This is the result of merging policies in the resource hierarchy and evaluating conditions. The returned policy will not have an etag or condition set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

Request parameters:

name - Required. The effective policy to compute. See Policy for naming requirements. Value must have pattern ^folders/\[^/\]+/policies/\[^/\]+$.

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

Completes with a GoogleCloudOrgpolicyV2Policy.

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

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

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