getStorageLayout method

Future<BucketStorageLayout> getStorageLayout(
  1. String bucket, {
  2. String? prefix,
  3. String? $fields,
})

Returns the storage layout configuration for the specified bucket.

Note that this operation requires storage.objects.list permission.

Request parameters:

bucket - Name of a bucket.

prefix - An optional prefix used for permission check. It is useful when the caller only has storage.objects.list permission under a specific prefix.

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

Completes with a BucketStorageLayout.

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<BucketStorageLayout> getStorageLayout(
  core.String bucket, {
  core.String? prefix,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (prefix != null) 'prefix': [prefix],
    if ($fields != null) 'fields': [$fields],
  };

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

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