lockRetentionPolicy method

Future<Bucket> lockRetentionPolicy(String bucket, String ifMetagenerationMatch, { String? userProject, String? $fields, })

Locks retention policy on a bucket.

Request parameters:

bucket - Name of a bucket.

ifMetagenerationMatch - Makes the operation conditional on whether bucket's current metageneration matches the given value.

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

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

  final _url =
      'b/' + commons.escapeVariable('$bucket') + '/lockRetentionPolicy';

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