getIamPolicy method

Future<Policy> getIamPolicy(String project, String resource, { int? optionsRequestedPolicyVersion, String? $fields, })

Gets the access control policy for a resource.

May be empty if no such policy or resource exists.

Request parameters:

project - Project ID for this request. Value must have pattern (?:(?:\[-a-z0-9\]{1,63}\.)*(?:\[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?):)?(?:\[0-9\]{1,19}|(?:\[a-z0-9\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?)).

resource - Name or id of the resource for this request. Value must have pattern \[a-z\](?:\[-a-z0-9_\]{0,61}\[a-z0-9\])?|\[1-9\]\[0-9\]{0,19}.

optionsRequestedPolicyVersion - Requested IAM Policy version.

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

Completes with a Policy.

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<Policy> getIamPolicy(
  core.String project,
  core.String resource, {
  core.int? optionsRequestedPolicyVersion,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (optionsRequestedPolicyVersion != null)
      'optionsRequestedPolicyVersion': ['${optionsRequestedPolicyVersion}'],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'projects/' +
      commons.escapeVariable('$project') +
      '/global/snapshots/' +
      commons.escapeVariable('$resource') +
      '/getIamPolicy';

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