getIamPolicy method

Future<Policy> getIamPolicy(
  1. String bucket, {
  2. int? optionsRequestedPolicyVersion,
  3. String? userProject,
  4. String? $fields,
})

Returns an IAM policy for the specified bucket.

Request parameters:

bucket - Name of a bucket.

optionsRequestedPolicyVersion - The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.

userProject - The project to be billed for this request. Required for Requester Pays buckets.

$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 bucket, {
  core.int? optionsRequestedPolicyVersion,
  core.String? userProject,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'optionsRequestedPolicyVersion': ?optionsRequestedPolicyVersion == null
        ? null
        : ['${optionsRequestedPolicyVersion}'],
    'userProject': ?userProject == null ? null : [userProject],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'b/' + commons.escapeVariable('$bucket') + '/iam';

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