IPWorks Cloud 2020 PHP Edition

Questions / Feedback?

UpdateBucket Method

Updates a bucket's kind and/or metadata.

Object Oriented Interface

public function doUpdateBucket($bucketid, $newkind, $newmetadata);

Procedural Interface

ipworkscloud_backblazeb2_do_updatebucket($res, $bucketid, $newkind, $newmetadata);

Remarks

This method updates the kind and/or metadata of the bucket specified by BucketId.

If NewKind is non-empty, it must be allPrivate or allPublic. If NewKind is empty, the bucket's kind remains unchanged.

If NewMetadata is true, the bucket's current metadata items are replaced with those in the Metadata* properties (or cleared, if said properties are empty). If NewMetadata is false, the bucket's current metadata remains unchanged. Keep in mind that the server enforces a limit of 10 metadata items per bucket.

If NewKind is empty and NewMetadata is false, this method does nothing.

The IfRevision setting can optionally be set before calling this method to ensure that the requested changes are only made if the bucket's current revision matches the given one.

The currently-authenticated application key must have the writeBuckets capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 PHP Edition - Version 20.0 [Build 8265]