Google Cloud Storage C++ Client
1.24.0
A C++ Client Library for Google Cloud Storage
|
Represents a Google Cloud Storage Bucket Metadata object. More...
#include <google/cloud/storage/bucket_metadata.h>
Public Member Functions | |
BucketMetadata ()=default | |
Get and set Bucket Access Control Lists. | |
std::vector< BucketAccessControl > const & | acl () const |
std::vector< BucketAccessControl > & | mutable_acl () |
BucketMetadata & | set_acl (std::vector< BucketAccessControl > acl) |
Get and set billing configuration for the Bucket. | |
bool | has_billing () const |
BucketBilling const & | billing () const |
absl::optional< BucketBilling > const & | billing_as_optional () const |
BucketMetadata & | set_billing (BucketBilling const &v) |
BucketMetadata & | reset_billing () |
Get and set the default event based hold for the Bucket. | |
Objects may have an event-based hold associated with them. If a Bucket has the
| |
bool | default_event_based_hold () const |
BucketMetadata & | set_default_event_based_hold (bool v) |
Get and set CORS configuration for the Bucket. | |
| |
std::vector< CorsEntry > const & | cors () const |
std::vector< CorsEntry > & | mutable_cors () |
BucketMetadata & | set_cors (std::vector< CorsEntry > cors) |
Get and set the Default Object Access Control Lists. | |
| |
std::vector< ObjectAccessControl > const & | default_acl () const |
std::vector< ObjectAccessControl > & | mutable_default_acl () |
BucketMetadata & | set_default_acl (std::vector< ObjectAccessControl > acl) |
bool | has_encryption () const |
BucketEncryption const & | encryption () const |
absl::optional< BucketEncryption > const & | encryption_as_optional () const |
BucketMetadata & | set_encryption (BucketEncryption v) |
BucketMetadata & | reset_encryption () |
Get and set the IAM configuration. | |
| |
bool | has_iam_configuration () const |
BucketIamConfiguration const & | iam_configuration () const |
absl::optional< BucketIamConfiguration > const & | iam_configuration_as_optional () const |
BucketMetadata & | set_iam_configuration (BucketIamConfiguration v) |
BucketMetadata & | reset_iam_configuration () |
Accessors and modifiers to the <tt>labels</tt>. | |
bool | has_label (std::string const &key) const |
Delete a label. This is a no-op if the key does not exist. More... | |
std::string const & | label (std::string const &key) const |
Delete a label. This is a no-op if the key does not exist. More... | |
BucketMetadata & | delete_label (std::string const &key) |
Delete a label. This is a no-op if the key does not exist. More... | |
BucketMetadata & | upsert_label (std::string key, std::string value) |
Insert or update the label entry. More... | |
std::map< std::string, std::string > const & | labels () const |
Delete a label. This is a no-op if the key does not exist. More... | |
std::map< std::string, std::string > & | mutable_labels () |
Delete a label. This is a no-op if the key does not exist. More... | |
Accessors and modifiers for object lifecycle rules. | |
| |
bool | has_lifecycle () const |
BucketLifecycle const & | lifecycle () const |
absl::optional< BucketLifecycle > const & | lifecycle_as_optional () const |
BucketMetadata & | set_lifecycle (BucketLifecycle v) |
BucketMetadata & | reset_lifecycle () |
std::string const & | location () const |
BucketMetadata & | set_location (std::string v) |
std::string const & | location_type () const |
Accessors and modifiers for logging configuration. | |
bool | has_logging () const |
BucketLogging const & | logging () const |
absl::optional< BucketLogging > const & | logging_as_optional () const |
BucketMetadata & | set_logging (BucketLogging v) |
BucketMetadata & | reset_logging () |
BucketMetadata & | set_name (std::string v) |
std::int64_t const & | project_number () const |
Accessors and modifiers for retention policy configuration. | |
bool | has_retention_policy () const |
Sets the retention period. More... | |
BucketRetentionPolicy const & | retention_policy () const |
Sets the retention period. More... | |
absl::optional< BucketRetentionPolicy > const & | retention_policy_as_optional () const |
Sets the retention period. More... | |
BucketMetadata & | set_retention_policy (BucketRetentionPolicy v) |
Sets the retention period. More... | |
BucketMetadata & | set_retention_policy (std::chrono::seconds retention_period) |
Sets the retention period. More... | |
BucketMetadata & | reset_retention_policy () |
Sets the retention period. More... | |
BucketMetadata & | set_storage_class (std::string v) |
Sets the retention period. More... | |
Accessors and modifiers for versioning configuration. | |
absl::optional< BucketVersioning > const & | versioning () const |
bool | has_versioning () const |
BucketMetadata & | enable_versioning () |
BucketMetadata & | disable_versioning () |
BucketMetadata & | reset_versioning () |
BucketMetadata & | set_versioning (absl::optional< BucketVersioning > v) |
Accessors and modifiers for website configuration. | |
bool | has_website () const |
BucketWebsite const & | website () const |
absl::optional< BucketWebsite > const & | website_as_optional () const |
BucketMetadata & | set_website (BucketWebsite v) |
BucketMetadata & | reset_website () |
bool | operator== (BucketMetadata const &lhs, BucketMetadata const &rhs) |
bool | operator!= (BucketMetadata const &lhs, BucketMetadata const &rhs) |
std::ostream & | operator<< (std::ostream &os, BucketMetadata const &rhs) |
Represents a Google Cloud Storage Bucket Metadata object.
Definition at line 506 of file bucket_metadata.h.
|
default |
|
inline |
Definition at line 518 of file bucket_metadata.h.
|
inline |
Definition at line 533 of file bucket_metadata.h.
|
inline |
Definition at line 534 of file bucket_metadata.h.
|
inline |
Definition at line 585 of file bucket_metadata.h.
|
inline |
Definition at line 604 of file bucket_metadata.h.
|
inline |
Definition at line 565 of file bucket_metadata.h.
|
inline |
Delete a label. This is a no-op if the key does not exist.
Definition at line 687 of file bucket_metadata.h.
|
inline |
Definition at line 824 of file bucket_metadata.h.
|
inline |
Definition at line 820 of file bucket_metadata.h.
|
inline |
Definition at line 628 of file bucket_metadata.h.
|
inline |
Definition at line 629 of file bucket_metadata.h.
|
inline |
Definition at line 532 of file bucket_metadata.h.
|
inline |
Definition at line 627 of file bucket_metadata.h.
|
inline |
Definition at line 657 of file bucket_metadata.h.
|
inline |
Delete a label. This is a no-op if the key does not exist.
Definition at line 680 of file bucket_metadata.h.
|
inline |
Definition at line 718 of file bucket_metadata.h.
|
inline |
Definition at line 743 of file bucket_metadata.h.
|
inline |
Sets the retention period.
The retention period is the only writable attribute in a retention policy. This function makes it easier to set the retention policy when the BucketMetadata
object is used to update or patch the bucket.
Definition at line 774 of file bucket_metadata.h.
|
inline |
Definition at line 819 of file bucket_metadata.h.
|
inline |
Definition at line 840 of file bucket_metadata.h.
|
inline |
Definition at line 658 of file bucket_metadata.h.
|
inline |
Definition at line 661 of file bucket_metadata.h.
|
inline |
Delete a label. This is a no-op if the key does not exist.
Definition at line 683 of file bucket_metadata.h.
|
inline |
Delete a label. This is a no-op if the key does not exist.
Definition at line 707 of file bucket_metadata.h.
|
inline |
Definition at line 719 of file bucket_metadata.h.
|
inline |
Definition at line 720 of file bucket_metadata.h.
|
inline |
Definition at line 733 of file bucket_metadata.h.
|
inline |
Definition at line 739 of file bucket_metadata.h.
|
inline |
Definition at line 744 of file bucket_metadata.h.
|
inline |
Definition at line 745 of file bucket_metadata.h.
|
inline |
Definition at line 519 of file bucket_metadata.h.
|
inline |
Definition at line 586 of file bucket_metadata.h.
|
inline |
Definition at line 607 of file bucket_metadata.h.
|
inline |
Delete a label. This is a no-op if the key does not exist.
Definition at line 708 of file bucket_metadata.h.
|
inline |
Definition at line 768 of file bucket_metadata.h.
|
inline |
Definition at line 541 of file bucket_metadata.h.
|
inline |
Definition at line 636 of file bucket_metadata.h.
|
inline |
Definition at line 669 of file bucket_metadata.h.
|
inline |
Definition at line 727 of file bucket_metadata.h.
|
inline |
Definition at line 752 of file bucket_metadata.h.
|
inline |
Sets the retention period.
The retention period is the only writable attribute in a retention policy. This function makes it easier to set the retention policy when the BucketMetadata
object is used to update or patch the bucket.
Definition at line 799 of file bucket_metadata.h.
|
inline |
Definition at line 828 of file bucket_metadata.h.
|
inline |
Definition at line 849 of file bucket_metadata.h.
|
inline |
Sets the retention period.
The retention period is the only writable attribute in a retention policy. This function makes it easier to set the retention policy when the BucketMetadata
object is used to update or patch the bucket.
Definition at line 775 of file bucket_metadata.h.
|
inline |
Sets the retention period.
The retention period is the only writable attribute in a retention policy. This function makes it easier to set the retention policy when the BucketMetadata
object is used to update or patch the bucket.
Definition at line 778 of file bucket_metadata.h.
|
inline |
Definition at line 520 of file bucket_metadata.h.
|
inline |
Definition at line 537 of file bucket_metadata.h.
|
inline |
Definition at line 587 of file bucket_metadata.h.
|
inline |
Definition at line 610 of file bucket_metadata.h.
|
inline |
Definition at line 566 of file bucket_metadata.h.
|
inline |
Definition at line 632 of file bucket_metadata.h.
|
inline |
Definition at line 665 of file bucket_metadata.h.
|
inline |
Definition at line 723 of file bucket_metadata.h.
|
inline |
Definition at line 734 of file bucket_metadata.h.
|
inline |
Definition at line 748 of file bucket_metadata.h.
|
inline |
Definition at line 760 of file bucket_metadata.h.
|
inline |
Sets the retention period.
The retention period is the only writable attribute in a retention policy. This function makes it easier to set the retention policy when the BucketMetadata
object is used to update or patch the bucket.
Definition at line 782 of file bucket_metadata.h.
|
inline |
Sets the retention period.
The retention period is the only writable attribute in a retention policy. This function makes it easier to set the retention policy when the BucketMetadata
object is used to update or patch the bucket.
Definition at line 794 of file bucket_metadata.h.
|
inline |
Sets the retention period.
The retention period is the only writable attribute in a retention policy. This function makes it easier to set the retention policy when the BucketMetadata
object is used to update or patch the bucket.
Definition at line 806 of file bucket_metadata.h.
|
inline |
Definition at line 832 of file bucket_metadata.h.
|
inline |
Definition at line 845 of file bucket_metadata.h.
|
inline |
Insert or update the label entry.
Definition at line 697 of file bucket_metadata.h.
|
inline |
Definition at line 816 of file bucket_metadata.h.
|
inline |
Definition at line 841 of file bucket_metadata.h.
|
inline |
Definition at line 842 of file bucket_metadata.h.
|
friend |
Definition at line 856 of file bucket_metadata.h.
|
friend |
Definition at line 91 of file bucket_metadata.cc.
|
friend |
Definition at line 74 of file bucket_metadata.cc.