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.
See also https://cloud.google.com/storage/docs/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.
See also https://cloud.google.com/storage/docs/requester-pays
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 `default_event_based_hold()` parameter set, and you create a new object in the bucket without specifying its event-event based hold then the object gets the value set in the bucket. See also https://cloud.google.com/storage/docs/bucket-lock for generation information on retention policies. The section on Object holds is particularly relevant. https://cloud.google.com/storage/docs/holding-objects for examples of using default event-based hold policy.
bool	default_event_based_hold () const

BucketMetadata &	set_default_event_based_hold (bool v)

Get and set CORS configuration for the Bucket.
See also https://en.wikipedia.org/wiki/Cross-origin_resource_sharing for general information on CORS. https://cloud.google.com/storage/docs/cross-origin for general information about CORS in the context of Google Cloud Storage. https://cloud.google.com/storage/docs/configuring-cors for information on how to set and troubleshoot CORS settings.
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.
See also https://cloud.google.com/storage/docs/access-control/lists#default for general information of default ACLs. https://cloud.google.com/storage/docs/encryption/customer-managed-keys for information on Customer-Managed Encryption Keys.
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.
See also Before enabling Uniform Bucket Level Access please review the feature documentation, as well as "Should you use uniform bucket-level access ?".
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.
See also https://cloud.google.com/storage/docs/managing-lifecycles for general information on 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)

Detailed Description

Represents a Google Cloud Storage Bucket Metadata object.

Definition at line 506 of file bucket_metadata.h.

Constructor & Destructor Documentation

◆ BucketMetadata()

google::cloud::storage::v1::BucketMetadata::BucketMetadata ( )

default

Member Function Documentation

◆ acl()

std::vector<BucketAccessControl> const& google::cloud::storage::v1::BucketMetadata::acl ( ) const

inline

Definition at line 518 of file bucket_metadata.h.

◆ billing()

BucketBilling const& google::cloud::storage::v1::BucketMetadata::billing ( ) const

inline

Definition at line 533 of file bucket_metadata.h.

◆ billing_as_optional()

absl::optional<BucketBilling> const& google::cloud::storage::v1::BucketMetadata::billing_as_optional ( ) const

inline

Definition at line 534 of file bucket_metadata.h.

◆ cors()

std::vector<CorsEntry> const& google::cloud::storage::v1::BucketMetadata::cors ( ) const

inline

Definition at line 585 of file bucket_metadata.h.

◆ default_acl()

std::vector<ObjectAccessControl> const& google::cloud::storage::v1::BucketMetadata::default_acl ( ) const

inline

Definition at line 604 of file bucket_metadata.h.

◆ default_event_based_hold()

bool google::cloud::storage::v1::BucketMetadata::default_event_based_hold ( ) const

inline

Definition at line 565 of file bucket_metadata.h.

◆ delete_label()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::delete_label ( std::string const & key )

inline

Delete a label. This is a no-op if the key does not exist.

Definition at line 687 of file bucket_metadata.h.

◆ disable_versioning()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::disable_versioning ( )

inline

Definition at line 824 of file bucket_metadata.h.

◆ enable_versioning()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::enable_versioning ( )

inline

Definition at line 820 of file bucket_metadata.h.

◆ encryption()

BucketEncryption const& google::cloud::storage::v1::BucketMetadata::encryption ( ) const

inline

Definition at line 628 of file bucket_metadata.h.

◆ encryption_as_optional()

absl::optional<BucketEncryption> const& google::cloud::storage::v1::BucketMetadata::encryption_as_optional ( ) const

inline

Definition at line 629 of file bucket_metadata.h.

◆ has_billing()

bool google::cloud::storage::v1::BucketMetadata::has_billing ( ) const

inline

Definition at line 532 of file bucket_metadata.h.

◆ has_encryption()

bool google::cloud::storage::v1::BucketMetadata::has_encryption ( ) const

inline

Definition at line 627 of file bucket_metadata.h.

◆ has_iam_configuration()

bool google::cloud::storage::v1::BucketMetadata::has_iam_configuration ( ) const

inline

Definition at line 657 of file bucket_metadata.h.

◆ has_label()

bool google::cloud::storage::v1::BucketMetadata::has_label ( std::string const & key ) const

inline

Delete a label. This is a no-op if the key does not exist.

Definition at line 680 of file bucket_metadata.h.

◆ has_lifecycle()

bool google::cloud::storage::v1::BucketMetadata::has_lifecycle ( ) const

inline

Definition at line 718 of file bucket_metadata.h.

◆ has_logging()

bool google::cloud::storage::v1::BucketMetadata::has_logging ( ) const

inline

Definition at line 743 of file bucket_metadata.h.

◆ has_retention_policy()

bool google::cloud::storage::v1::BucketMetadata::has_retention_policy ( ) const

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.

◆ has_versioning()

bool google::cloud::storage::v1::BucketMetadata::has_versioning ( ) const

inline

Definition at line 819 of file bucket_metadata.h.

◆ has_website()

bool google::cloud::storage::v1::BucketMetadata::has_website ( ) const

inline

Definition at line 840 of file bucket_metadata.h.

◆ iam_configuration()

BucketIamConfiguration const& google::cloud::storage::v1::BucketMetadata::iam_configuration ( ) const

inline

Definition at line 658 of file bucket_metadata.h.

◆ iam_configuration_as_optional()

absl::optional<BucketIamConfiguration> const& google::cloud::storage::v1::BucketMetadata::iam_configuration_as_optional ( ) const

inline

Definition at line 661 of file bucket_metadata.h.

◆ label()

std::string const& google::cloud::storage::v1::BucketMetadata::label ( std::string const & key ) const

inline

Delete a label. This is a no-op if the key does not exist.

Definition at line 683 of file bucket_metadata.h.

◆ labels()

std::map<std::string, std::string> const& google::cloud::storage::v1::BucketMetadata::labels ( ) const

inline

Delete a label. This is a no-op if the key does not exist.

Definition at line 707 of file bucket_metadata.h.

◆ lifecycle()

BucketLifecycle const& google::cloud::storage::v1::BucketMetadata::lifecycle ( ) const

inline

Definition at line 719 of file bucket_metadata.h.

◆ lifecycle_as_optional()

absl::optional<BucketLifecycle> const& google::cloud::storage::v1::BucketMetadata::lifecycle_as_optional ( ) const

inline

Definition at line 720 of file bucket_metadata.h.

◆ location()

std::string const& google::cloud::storage::v1::BucketMetadata::location ( ) const

inline

Definition at line 733 of file bucket_metadata.h.

◆ location_type()

std::string const& google::cloud::storage::v1::BucketMetadata::location_type ( ) const

inline

Definition at line 739 of file bucket_metadata.h.

◆ logging()

BucketLogging const& google::cloud::storage::v1::BucketMetadata::logging ( ) const

inline

Definition at line 744 of file bucket_metadata.h.

◆ logging_as_optional()

absl::optional<BucketLogging> const& google::cloud::storage::v1::BucketMetadata::logging_as_optional ( ) const

inline

Definition at line 745 of file bucket_metadata.h.

◆ mutable_acl()

std::vector<BucketAccessControl>& google::cloud::storage::v1::BucketMetadata::mutable_acl ( )

inline

Definition at line 519 of file bucket_metadata.h.

◆ mutable_cors()

std::vector<CorsEntry>& google::cloud::storage::v1::BucketMetadata::mutable_cors ( )

inline

Definition at line 586 of file bucket_metadata.h.

◆ mutable_default_acl()

std::vector<ObjectAccessControl>& google::cloud::storage::v1::BucketMetadata::mutable_default_acl ( )

inline

Definition at line 607 of file bucket_metadata.h.

◆ mutable_labels()

std::map<std::string, std::string>& google::cloud::storage::v1::BucketMetadata::mutable_labels ( )

inline

Delete a label. This is a no-op if the key does not exist.

Definition at line 708 of file bucket_metadata.h.

◆ project_number()

std::int64_t const& google::cloud::storage::v1::BucketMetadata::project_number ( ) const

inline

Definition at line 768 of file bucket_metadata.h.

◆ reset_billing()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::reset_billing ( )

inline

Definition at line 541 of file bucket_metadata.h.

◆ reset_encryption()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::reset_encryption ( )

inline

Definition at line 636 of file bucket_metadata.h.

◆ reset_iam_configuration()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::reset_iam_configuration ( )

inline

Definition at line 669 of file bucket_metadata.h.

◆ reset_lifecycle()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::reset_lifecycle ( )

inline

Definition at line 727 of file bucket_metadata.h.

◆ reset_logging()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::reset_logging ( )

inline

Definition at line 752 of file bucket_metadata.h.

◆ reset_retention_policy()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::reset_retention_policy ( )

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.

◆ reset_versioning()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::reset_versioning ( )

inline

Definition at line 828 of file bucket_metadata.h.

◆ reset_website()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::reset_website ( )

inline

Definition at line 849 of file bucket_metadata.h.

◆ retention_policy()

BucketRetentionPolicy const& google::cloud::storage::v1::BucketMetadata::retention_policy ( ) const

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.

◆ retention_policy_as_optional()

absl::optional<BucketRetentionPolicy> const& google::cloud::storage::v1::BucketMetadata::retention_policy_as_optional ( ) const

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.

◆ set_acl()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_acl ( std::vector< BucketAccessControl > acl )

inline

Definition at line 520 of file bucket_metadata.h.

◆ set_billing()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_billing ( BucketBilling const & v )

inline

Definition at line 537 of file bucket_metadata.h.

◆ set_cors()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_cors ( std::vector< CorsEntry > cors )

inline

Definition at line 587 of file bucket_metadata.h.

◆ set_default_acl()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_default_acl ( std::vector< ObjectAccessControl > acl )

inline

Definition at line 610 of file bucket_metadata.h.

◆ set_default_event_based_hold()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_default_event_based_hold ( bool v )

inline

Definition at line 566 of file bucket_metadata.h.

◆ set_encryption()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_encryption ( BucketEncryption v )

inline

Definition at line 632 of file bucket_metadata.h.

◆ set_iam_configuration()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_iam_configuration ( BucketIamConfiguration v )

inline

Definition at line 665 of file bucket_metadata.h.

◆ set_lifecycle()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_lifecycle ( BucketLifecycle v )

inline

Definition at line 723 of file bucket_metadata.h.

◆ set_location()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_location ( std::string v )

inline

Definition at line 734 of file bucket_metadata.h.

◆ set_logging()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_logging ( BucketLogging v )

inline

Definition at line 748 of file bucket_metadata.h.

◆ set_name()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_name ( std::string v )

inline

Definition at line 760 of file bucket_metadata.h.

◆ set_retention_policy() [1/2]

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_retention_policy ( BucketRetentionPolicy v )

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.

◆ set_retention_policy() [2/2]

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_retention_policy ( std::chrono::seconds retention_period )

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.

◆ set_storage_class()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_storage_class ( std::string v )

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.

◆ set_versioning()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_versioning ( absl::optional< BucketVersioning > v )

inline

Definition at line 832 of file bucket_metadata.h.

◆ set_website()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::set_website ( BucketWebsite v )

inline

Definition at line 845 of file bucket_metadata.h.

◆ upsert_label()

BucketMetadata& google::cloud::storage::v1::BucketMetadata::upsert_label	(	std::string	key,
		std::string	value
	)

inline

Insert or update the label entry.

Definition at line 697 of file bucket_metadata.h.

◆ versioning()

absl::optional<BucketVersioning> const& google::cloud::storage::v1::BucketMetadata::versioning ( ) const

inline

Definition at line 816 of file bucket_metadata.h.

◆ website()

BucketWebsite const& google::cloud::storage::v1::BucketMetadata::website ( ) const

inline

Definition at line 841 of file bucket_metadata.h.

◆ website_as_optional()

absl::optional<BucketWebsite> const& google::cloud::storage::v1::BucketMetadata::website_as_optional ( ) const

inline

Definition at line 842 of file bucket_metadata.h.

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	BucketMetadata const &	lhs,
		BucketMetadata const &	rhs
	)

friend

Definition at line 856 of file bucket_metadata.h.

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		BucketMetadata const &	rhs
	)

friend

Definition at line 91 of file bucket_metadata.cc.

◆ operator==

bool operator==	(	BucketMetadata const &	lhs,
		BucketMetadata const &	rhs
	)

friend

Definition at line 74 of file bucket_metadata.cc.

Public Member Functions

Accessors and modifiers for website configuration.

Detailed Description

Constructor & Destructor Documentation

◆ BucketMetadata()

Member Function Documentation

◆ acl()

◆ billing()

◆ billing_as_optional()

◆ cors()

◆ default_acl()

◆ default_event_based_hold()

◆ delete_label()

◆ disable_versioning()

◆ enable_versioning()

◆ encryption()

◆ encryption_as_optional()

◆ has_billing()

◆ has_encryption()

◆ has_iam_configuration()

◆ has_label()

◆ has_lifecycle()

◆ has_logging()

◆ has_retention_policy()

◆ has_versioning()

◆ has_website()

◆ iam_configuration()

◆ iam_configuration_as_optional()

◆ label()

◆ labels()

◆ lifecycle()

◆ lifecycle_as_optional()

◆ location()

◆ location_type()

◆ logging()

◆ logging_as_optional()

◆ mutable_acl()

◆ mutable_cors()

◆ mutable_default_acl()

◆ mutable_labels()

◆ project_number()

◆ reset_billing()

◆ reset_encryption()

◆ reset_iam_configuration()

◆ reset_lifecycle()

◆ reset_logging()

◆ reset_retention_policy()

◆ reset_versioning()

◆ reset_website()

◆ retention_policy()

◆ retention_policy_as_optional()

◆ set_acl()

◆ set_billing()

◆ set_cors()

◆ set_default_acl()

◆ set_default_event_based_hold()

◆ set_encryption()

◆ set_iam_configuration()

◆ set_lifecycle()

◆ set_location()

◆ set_logging()

◆ set_name()

◆ set_retention_policy() [1/2]

◆ set_retention_policy() [2/2]

◆ set_storage_class()

◆ set_versioning()

◆ set_website()

◆ upsert_label()

◆ versioning()

◆ website()

◆ website_as_optional()

Friends And Related Function Documentation

◆ operator!=

◆ operator<<

◆ operator==