testIamPermissions method

Future<TestIamPermissionsResponse> testIamPermissions(
  1. String bucket,
  2. List<String> permissions, {
  3. String? userProject,
  4. String? $fields,
})

Tests a set of permissions on the given bucket to see which, if any, are held by the caller.

Request parameters:

bucket - Name of a bucket.

permissions - Permissions to test.

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 TestIamPermissionsResponse.

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<TestIamPermissionsResponse> testIamPermissions(
  core.String bucket,
  core.List<core.String> permissions, {
  core.String? userProject,
  core.String? $fields,
}) async {
  if (permissions.isEmpty) {
    throw core.ArgumentError('Parameter permissions cannot be empty.');
  }
  final queryParams_ = <core.String, core.List<core.String>>{
    'permissions': permissions,
    if (userProject != null) 'userProject': [userProject],
    if ($fields != null) 'fields': [$fields],
  };

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

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