Google Cloud Storage C++ Client  1.31.1
A C++ Client Library for Google Cloud Storage
Public Member Functions | List of all members
google::cloud::storage::v1::BucketMetadataPatchBuilder Class Reference

Prepares a patch for the Bucket resource. More...

#include <google/cloud/storage/bucket_metadata.h>

Public Member Functions

 BucketMetadataPatchBuilder ()=default
 
std::string BuildPatch () const
 
BucketMetadataPatchBuilderSetAcl (std::vector< BucketAccessControl > const &v)
 
BucketMetadataPatchBuilderResetAcl ()
 Clears the ACL for the Bucket. More...
 
BucketMetadataPatchBuilderSetBilling (BucketBilling const &v)
 
BucketMetadataPatchBuilderResetBilling ()
 
BucketMetadataPatchBuilderSetCors (std::vector< CorsEntry > const &v)
 
BucketMetadataPatchBuilderResetCors ()
 
BucketMetadataPatchBuilderSetDefaultEventBasedHold (bool v)
 
BucketMetadataPatchBuilderResetDefaultEventBasedHold ()
 
BucketMetadataPatchBuilderSetDefaultAcl (std::vector< ObjectAccessControl > const &v)
 
BucketMetadataPatchBuilderResetDefaultAcl ()
 Clears the default object ACL for the Bucket. More...
 
BucketMetadataPatchBuilderSetIamConfiguration (BucketIamConfiguration const &v)
 
BucketMetadataPatchBuilderResetIamConfiguration ()
 
BucketMetadataPatchBuilderSetEncryption (BucketEncryption const &v)
 
BucketMetadataPatchBuilderResetEncryption ()
 
BucketMetadataPatchBuilderSetLabel (std::string const &label, std::string const &value)
 
BucketMetadataPatchBuilderResetLabel (std::string const &label)
 
BucketMetadataPatchBuilderResetLabels ()
 
BucketMetadataPatchBuilderSetLifecycle (BucketLifecycle const &v)
 
BucketMetadataPatchBuilderResetLifecycle ()
 
BucketMetadataPatchBuilderSetLogging (BucketLogging const &v)
 
BucketMetadataPatchBuilderResetLogging ()
 
BucketMetadataPatchBuilderSetName (std::string const &v)
 
BucketMetadataPatchBuilderResetName ()
 
BucketMetadataPatchBuilderSetRetentionPolicy (BucketRetentionPolicy const &v)
 
BucketMetadataPatchBuilderSetRetentionPolicy (std::chrono::seconds retention_period)
 
BucketMetadataPatchBuilderResetRetentionPolicy ()
 
BucketMetadataPatchBuilderSetStorageClass (std::string const &v)
 
BucketMetadataPatchBuilderResetStorageClass ()
 
BucketMetadataPatchBuilderSetVersioning (BucketVersioning const &v)
 
BucketMetadataPatchBuilderResetVersioning ()
 
BucketMetadataPatchBuilderSetWebsite (BucketWebsite const &v)
 
BucketMetadataPatchBuilderResetWebsite ()
 

Detailed Description

Prepares a patch for the Bucket resource.

The Bucket resource has many modifiable fields. The application may send a patch request to change (or delete) a small fraction of these fields by using this object.

See also
https://cloud.google.com/storage/docs/json_api/v1/how-tos/performance#patch for general information on PATCH requests for the Google Cloud Storage JSON API.

Definition at line 908 of file bucket_metadata.h.

Constructor & Destructor Documentation

◆ BucketMetadataPatchBuilder()

google::cloud::storage::v1::BucketMetadataPatchBuilder::BucketMetadataPatchBuilder ( )
default

Member Function Documentation

◆ BuildPatch()

std::string google::cloud::storage::v1::BucketMetadataPatchBuilder::BuildPatch ( ) const

Definition at line 192 of file bucket_metadata.cc.

◆ ResetAcl()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetAcl ( )

Clears the ACL for the Bucket.

Warning
Currently the server ignores requests to reset the full ACL.

Definition at line 220 of file bucket_metadata.cc.

◆ ResetBilling()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetBilling ( )

Definition at line 232 of file bucket_metadata.cc.

◆ ResetCors()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetCors ( )

Definition at line 263 of file bucket_metadata.cc.

◆ ResetDefaultAcl()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetDefaultAcl ( )

Clears the default object ACL for the Bucket.

Warning
Currently the server ignores requests to reset the full ACL.

Definition at line 296 of file bucket_metadata.cc.

◆ ResetDefaultEventBasedHold()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetDefaultEventBasedHold ( )

Definition at line 275 of file bucket_metadata.cc.

◆ ResetEncryption()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetEncryption ( )

Definition at line 309 of file bucket_metadata.cc.

◆ ResetIamConfiguration()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetIamConfiguration ( )

Definition at line 338 of file bucket_metadata.cc.

◆ ResetLabel()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetLabel ( std::string const &  label)

Definition at line 350 of file bucket_metadata.cc.

◆ ResetLabels()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetLabels ( )

Definition at line 357 of file bucket_metadata.cc.

◆ ResetLifecycle()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetLifecycle ( )

Definition at line 407 of file bucket_metadata.cc.

◆ ResetLogging()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetLogging ( )

Definition at line 421 of file bucket_metadata.cc.

◆ ResetName()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetName ( )

Definition at line 435 of file bucket_metadata.cc.

◆ ResetRetentionPolicy()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetRetentionPolicy ( )

Definition at line 451 of file bucket_metadata.cc.

◆ ResetStorageClass()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetStorageClass ( )

Definition at line 465 of file bucket_metadata.cc.

◆ ResetVersioning()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetVersioning ( )

Definition at line 477 of file bucket_metadata.cc.

◆ ResetWebsite()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::ResetWebsite ( )

Definition at line 491 of file bucket_metadata.cc.

◆ SetAcl()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetAcl ( std::vector< BucketAccessControl > const &  v)

Definition at line 204 of file bucket_metadata.cc.

◆ SetBilling()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetBilling ( BucketBilling const &  v)

Definition at line 225 of file bucket_metadata.cc.

◆ SetCors()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetCors ( std::vector< CorsEntry > const &  v)

Definition at line 237 of file bucket_metadata.cc.

◆ SetDefaultAcl()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetDefaultAcl ( std::vector< ObjectAccessControl > const &  v)

Definition at line 280 of file bucket_metadata.cc.

◆ SetDefaultEventBasedHold()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetDefaultEventBasedHold ( bool  v)

Definition at line 269 of file bucket_metadata.cc.

◆ SetEncryption()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetEncryption ( BucketEncryption const &  v)

Definition at line 301 of file bucket_metadata.cc.

◆ SetIamConfiguration()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetIamConfiguration ( BucketIamConfiguration const &  v)

Definition at line 314 of file bucket_metadata.cc.

◆ SetLabel()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetLabel ( std::string const &  label,
std::string const &  value 
)

Definition at line 343 of file bucket_metadata.cc.

◆ SetLifecycle()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetLifecycle ( BucketLifecycle const &  v)

Definition at line 363 of file bucket_metadata.cc.

◆ SetLogging()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetLogging ( BucketLogging const &  v)

Definition at line 412 of file bucket_metadata.cc.

◆ SetName()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetName ( std::string const &  v)

Definition at line 426 of file bucket_metadata.cc.

◆ SetRetentionPolicy() [1/2]

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetRetentionPolicy ( BucketRetentionPolicy const &  v)

Definition at line 440 of file bucket_metadata.cc.

◆ SetRetentionPolicy() [2/2]

BucketMetadataPatchBuilder& google::cloud::storage::v1::BucketMetadataPatchBuilder::SetRetentionPolicy ( std::chrono::seconds  retention_period)
inline

Definition at line 965 of file bucket_metadata.h.

◆ SetStorageClass()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetStorageClass ( std::string const &  v)

Definition at line 456 of file bucket_metadata.cc.

◆ SetVersioning()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetVersioning ( BucketVersioning const &  v)

Definition at line 470 of file bucket_metadata.cc.

◆ SetWebsite()

BucketMetadataPatchBuilder & google::cloud::storage::v1::BucketMetadataPatchBuilder::SetWebsite ( BucketWebsite const &  v)

Definition at line 482 of file bucket_metadata.cc.