getIamPolicy method

Future<Policy> getIamPolicy(String bucket, String object, { String? generation, String? userProject, String? $fields, })

Returns an IAM policy for the specified object.

Request parameters:

bucket - Name of the bucket in which the object resides.

object - Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

generation - If present, selects a specific revision of this object (as opposed to the latest version, the default).

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.String object, {
  core.String? generation,
  core.String? userProject,
  core.String? $fields,
}) async {
  final _queryParams = <core.String, core.List<core.String>>{
    if (generation != null) 'generation': [generation],
    if (userProject != null) 'userProject': [userProject],
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'b/' +
      commons.escapeVariable('$bucket') +
      '/o/' +
      commons.escapeVariable('$object') +
      '/iam';

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