testIamPermissions method

Future<TestIamPermissionsResponse> testIamPermissions(String bucket, String object, List<String> permissions, { String? generation, String? userProject, String? $fields, })

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

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.

permissions - Permissions to test.

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 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.String object,
  core.List<core.String> permissions, {
  core.String? generation,
  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 (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/testPermissions';

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