Struct Bucket 

#[non_exhaustive]
pub struct Bucket {

    pub name: String,
    pub bucket_id: String,
    pub etag: String,
    pub project: String,
    pub metageneration: i64,
    pub location: String,
    pub location_type: String,
    pub storage_class: String,
    pub rpo: String,
    pub acl: Vec<BucketAccessControl>,
    pub default_object_acl: Vec<ObjectAccessControl>,
    pub lifecycle: Option<Lifecycle>,
    pub create_time: Option<Timestamp>,
    pub cors: Vec<Cors>,
    pub update_time: Option<Timestamp>,
    pub default_event_based_hold: bool,
    pub labels: HashMap<String, String>,
    pub website: Option<Website>,
    pub versioning: Option<Versioning>,
    pub logging: Option<Logging>,
    pub owner: Option<Owner>,
    pub encryption: Option<Encryption>,
    pub billing: Option<Billing>,
    pub retention_policy: Option<RetentionPolicy>,
    pub iam_config: Option<IamConfig>,
    pub satisfies_pzs: bool,
    pub custom_placement_config: Option<CustomPlacementConfig>,
    pub autoclass: Option<Autoclass>,
    pub hierarchical_namespace: Option<HierarchicalNamespace>,
    pub soft_delete_policy: Option<SoftDeletePolicy>,
    pub object_retention: Option<ObjectRetention>,
    pub ip_filter: Option<IpFilter>,
    /* private fields */
}

A bucket.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Identifier. The name of the bucket. Format: projects/{project}/buckets/{bucket}

bucket_id: String

Output only. The user-chosen part of the bucket name. The {bucket} portion of the name field. For globally unique buckets, this is equal to the bucket name of other Cloud Storage APIs. Example: pub.

etag: String

The etag of the bucket. If included in the metadata of an UpdateBucketRequest, the operation is only performed if the etag matches that of the bucket.

project: String

Immutable. The project which owns this bucket, in the format of projects/{projectIdentifier}. {projectIdentifier} can be the project ID or project number. Output values are always in the project number format.

metageneration: i64

Output only. The metadata generation of this bucket.

location: String

Immutable. The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. Attempting to update this field after the bucket is created results in an error.

location_type: String

Output only. The location type of the bucket (region, dual-region, multi-region, etc).

storage_class: String

Optional. The bucket’s default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. If this value is not specified when the bucket is created, it defaults to STANDARD. For more information, see Storage classes.

rpo: String

Optional. The recovery point objective for cross-region replication of the bucket. Applicable only for dual- and multi-region buckets. DEFAULT uses default replication. ASYNC_TURBO enables turbo replication, valid for dual-region buckets only. If rpo is not specified when the bucket is created, it defaults to DEFAULT. For more information, see Turbo replication.

acl: Vec<BucketAccessControl>

Optional. Access controls on the bucket. If iam_config.uniform_bucket_level_access is enabled on this bucket, requests to set, read, or modify acl is an error.

default_object_acl: Vec<ObjectAccessControl>

Optional. Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access is enabled on this bucket, requests to set, read, or modify acl is an error.

lifecycle: Option<Lifecycle>

Optional. The bucket’s lifecycle configuration. See Lifecycle Management for more information.

create_time: Option<Timestamp>

Output only. The creation time of the bucket.

cors: Vec<Cors>

Optional. The bucket’s CORS configuration.

update_time: Option<Timestamp>

Output only. The modification time of the bucket.

default_event_based_hold: bool

Optional. The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold’s release. After being released, such objects are subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects are held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.

labels: HashMap<String, String>

Optional. User-provided labels, in key/value pairs.

website: Option<Website>

Optional. The bucket’s website config, controlling how the service behaves when accessing bucket contents as a web site. See the Static website examples for more information.

versioning: Option<Versioning>

Optional. The bucket’s versioning configuration.

logging: Option<Logging>

Optional. The bucket’s logging config, which defines the destination bucket and name prefix (if any) for the current bucket’s logs.

owner: Option<Owner>

Output only. The owner of the bucket. This is always the project team’s owner group.

encryption: Option<Encryption>

Optional. Encryption config for a bucket.

billing: Option<Billing>

Optional. The bucket’s billing configuration.

retention_policy: Option<RetentionPolicy>

Optional. The bucket’s retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period results in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy results in a PERMISSION_DENIED error.

iam_config: Option<IamConfig>

Optional. The bucket’s IAM configuration.

satisfies_pzs: bool

Optional. Reserved for future use.

custom_placement_config: Option<CustomPlacementConfig>

Optional. Configuration that, if present, specifies the data placement for a configurable dual-region.

autoclass: Option<Autoclass>

Optional. The bucket’s Autoclass configuration. If there is no configuration, the Autoclass feature is disabled and has no effect on the bucket.

hierarchical_namespace: Option<HierarchicalNamespace>

Optional. The bucket’s hierarchical namespace configuration. If there is no configuration, the hierarchical namespace feature is disabled and has no effect on the bucket.

soft_delete_policy: Option<SoftDeletePolicy>

Optional. The bucket’s soft delete policy. The soft delete policy prevents soft-deleted objects from being permanently deleted.

object_retention: Option<ObjectRetention>

Optional. The bucket’s object retention configuration. Must be enabled before objects in the bucket might have retention configured.

ip_filter: Option<IpFilter>

Optional. The bucket’s IP filter configuration.

Implementations

impl Bucket

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = Bucket::new().set_name("example");

pub fn set_bucket_id<T: Into<String>>(self, v: T) -> Self

Sets the value of bucket_id.

Example

let x = Bucket::new().set_bucket_id("example");

pub fn set_etag<T: Into<String>>(self, v: T) -> Self

Sets the value of etag.

Example

let x = Bucket::new().set_etag("example");

pub fn set_project<T: Into<String>>(self, v: T) -> Self

Sets the value of project.

Example

let x = Bucket::new().set_project("example");

pub fn set_metageneration<T: Into<i64>>(self, v: T) -> Self

Sets the value of metageneration.

Example

let x = Bucket::new().set_metageneration(42);

pub fn set_location<T: Into<String>>(self, v: T) -> Self

Sets the value of location.

Example

let x = Bucket::new().set_location("example");

pub fn set_location_type<T: Into<String>>(self, v: T) -> Self

Sets the value of location_type.

Example

let x = Bucket::new().set_location_type("example");

pub fn set_storage_class<T: Into<String>>(self, v: T) -> Self

Sets the value of storage_class.

Example

let x = Bucket::new().set_storage_class("example");

pub fn set_rpo<T: Into<String>>(self, v: T) -> Self

Sets the value of rpo.

Example

let x = Bucket::new().set_rpo("example");

pub fn set_acl<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<BucketAccessControl>,

Sets the value of acl.

Example

use google_cloud_storage::model::BucketAccessControl;
let x = Bucket::new()
    .set_acl([
        BucketAccessControl::default()/* use setters */,
        BucketAccessControl::default()/* use (different) setters */,
    ]);

pub fn set_default_object_acl<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<ObjectAccessControl>,

Sets the value of default_object_acl.

Example

use google_cloud_storage::model::ObjectAccessControl;
let x = Bucket::new()
    .set_default_object_acl([
        ObjectAccessControl::default()/* use setters */,
        ObjectAccessControl::default()/* use (different) setters */,
    ]);

pub fn set_lifecycle<T>(self, v: T) -> Self

where T: Into<Lifecycle>,

Sets the value of lifecycle.

Example

use google_cloud_storage::model::bucket::Lifecycle;
let x = Bucket::new().set_lifecycle(Lifecycle::default()/* use setters */);

pub fn set_or_clear_lifecycle<T>(self, v: Option<T>) -> Self

where T: Into<Lifecycle>,

Sets or clears the value of lifecycle.

Example

use google_cloud_storage::model::bucket::Lifecycle;
let x = Bucket::new().set_or_clear_lifecycle(Some(Lifecycle::default()/* use setters */));
let x = Bucket::new().set_or_clear_lifecycle(None::<Lifecycle>);

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = Bucket::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = Bucket::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Bucket::new().set_or_clear_create_time(None::<Timestamp>);

pub fn set_cors<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Cors>,

Sets the value of cors.

Example

use google_cloud_storage::model::bucket::Cors;
let x = Bucket::new()
    .set_cors([
        Cors::default()/* use setters */,
        Cors::default()/* use (different) setters */,
    ]);

pub fn set_update_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = Bucket::new().set_update_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = Bucket::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = Bucket::new().set_or_clear_update_time(None::<Timestamp>);

pub fn set_default_event_based_hold<T: Into<bool>>(self, v: T) -> Self

Sets the value of default_event_based_hold.

Example

let x = Bucket::new().set_default_event_based_hold(true);

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = Bucket::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_website<T>(self, v: T) -> Self

where T: Into<Website>,

Sets the value of website.

Example

use google_cloud_storage::model::bucket::Website;
let x = Bucket::new().set_website(Website::default()/* use setters */);

pub fn set_or_clear_website<T>(self, v: Option<T>) -> Self

where T: Into<Website>,

Sets or clears the value of website.

Example

use google_cloud_storage::model::bucket::Website;
let x = Bucket::new().set_or_clear_website(Some(Website::default()/* use setters */));
let x = Bucket::new().set_or_clear_website(None::<Website>);

pub fn set_versioning<T>(self, v: T) -> Self

where T: Into<Versioning>,

Sets the value of versioning.

Example

use google_cloud_storage::model::bucket::Versioning;
let x = Bucket::new().set_versioning(Versioning::default()/* use setters */);

pub fn set_or_clear_versioning<T>(self, v: Option<T>) -> Self

where T: Into<Versioning>,

Sets or clears the value of versioning.

Example

use google_cloud_storage::model::bucket::Versioning;
let x = Bucket::new().set_or_clear_versioning(Some(Versioning::default()/* use setters */));
let x = Bucket::new().set_or_clear_versioning(None::<Versioning>);

pub fn set_logging<T>(self, v: T) -> Self

where T: Into<Logging>,

Sets the value of logging.

Example

use google_cloud_storage::model::bucket::Logging;
let x = Bucket::new().set_logging(Logging::default()/* use setters */);

pub fn set_or_clear_logging<T>(self, v: Option<T>) -> Self

where T: Into<Logging>,

Sets or clears the value of logging.

Example

use google_cloud_storage::model::bucket::Logging;
let x = Bucket::new().set_or_clear_logging(Some(Logging::default()/* use setters */));
let x = Bucket::new().set_or_clear_logging(None::<Logging>);

pub fn set_owner<T>(self, v: T) -> Self

where T: Into<Owner>,

Sets the value of owner.

Example

use google_cloud_storage::model::Owner;
let x = Bucket::new().set_owner(Owner::default()/* use setters */);

pub fn set_or_clear_owner<T>(self, v: Option<T>) -> Self

where T: Into<Owner>,

Sets or clears the value of owner.

Example

use google_cloud_storage::model::Owner;
let x = Bucket::new().set_or_clear_owner(Some(Owner::default()/* use setters */));
let x = Bucket::new().set_or_clear_owner(None::<Owner>);

pub fn set_encryption<T>(self, v: T) -> Self

where T: Into<Encryption>,

Sets the value of encryption.

Example

use google_cloud_storage::model::bucket::Encryption;
let x = Bucket::new().set_encryption(Encryption::default()/* use setters */);

pub fn set_or_clear_encryption<T>(self, v: Option<T>) -> Self

where T: Into<Encryption>,

Sets or clears the value of encryption.

Example

use google_cloud_storage::model::bucket::Encryption;
let x = Bucket::new().set_or_clear_encryption(Some(Encryption::default()/* use setters */));
let x = Bucket::new().set_or_clear_encryption(None::<Encryption>);

pub fn set_billing<T>(self, v: T) -> Self

where T: Into<Billing>,

Sets the value of billing.

Example

use google_cloud_storage::model::bucket::Billing;
let x = Bucket::new().set_billing(Billing::default()/* use setters */);

pub fn set_or_clear_billing<T>(self, v: Option<T>) -> Self

where T: Into<Billing>,

Sets or clears the value of billing.

Example

use google_cloud_storage::model::bucket::Billing;
let x = Bucket::new().set_or_clear_billing(Some(Billing::default()/* use setters */));
let x = Bucket::new().set_or_clear_billing(None::<Billing>);

pub fn set_retention_policy<T>(self, v: T) -> Self

where T: Into<RetentionPolicy>,

Sets the value of retention_policy.

Example

use google_cloud_storage::model::bucket::RetentionPolicy;
let x = Bucket::new().set_retention_policy(RetentionPolicy::default()/* use setters */);

pub fn set_or_clear_retention_policy<T>(self, v: Option<T>) -> Self

where T: Into<RetentionPolicy>,

Sets or clears the value of retention_policy.

Example

use google_cloud_storage::model::bucket::RetentionPolicy;
let x = Bucket::new().set_or_clear_retention_policy(Some(RetentionPolicy::default()/* use setters */));
let x = Bucket::new().set_or_clear_retention_policy(None::<RetentionPolicy>);

pub fn set_iam_config<T>(self, v: T) -> Self

where T: Into<IamConfig>,

Sets the value of iam_config.

Example

use google_cloud_storage::model::bucket::IamConfig;
let x = Bucket::new().set_iam_config(IamConfig::default()/* use setters */);

pub fn set_or_clear_iam_config<T>(self, v: Option<T>) -> Self

where T: Into<IamConfig>,

Sets or clears the value of iam_config.

Example

use google_cloud_storage::model::bucket::IamConfig;
let x = Bucket::new().set_or_clear_iam_config(Some(IamConfig::default()/* use setters */));
let x = Bucket::new().set_or_clear_iam_config(None::<IamConfig>);

pub fn set_satisfies_pzs<T: Into<bool>>(self, v: T) -> Self

Sets the value of satisfies_pzs.

Example

let x = Bucket::new().set_satisfies_pzs(true);

pub fn set_custom_placement_config<T>(self, v: T) -> Self

where T: Into<CustomPlacementConfig>,

Sets the value of custom_placement_config.

Example

use google_cloud_storage::model::bucket::CustomPlacementConfig;
let x = Bucket::new().set_custom_placement_config(CustomPlacementConfig::default()/* use setters */);

pub fn set_or_clear_custom_placement_config<T>(self, v: Option<T>) -> Self

where T: Into<CustomPlacementConfig>,

Sets or clears the value of custom_placement_config.

Example

use google_cloud_storage::model::bucket::CustomPlacementConfig;
let x = Bucket::new().set_or_clear_custom_placement_config(Some(CustomPlacementConfig::default()/* use setters */));
let x = Bucket::new().set_or_clear_custom_placement_config(None::<CustomPlacementConfig>);

pub fn set_autoclass<T>(self, v: T) -> Self

where T: Into<Autoclass>,

Sets the value of autoclass.

Example

use google_cloud_storage::model::bucket::Autoclass;
let x = Bucket::new().set_autoclass(Autoclass::default()/* use setters */);

pub fn set_or_clear_autoclass<T>(self, v: Option<T>) -> Self

where T: Into<Autoclass>,

Sets or clears the value of autoclass.

Example

use google_cloud_storage::model::bucket::Autoclass;
let x = Bucket::new().set_or_clear_autoclass(Some(Autoclass::default()/* use setters */));
let x = Bucket::new().set_or_clear_autoclass(None::<Autoclass>);

pub fn set_hierarchical_namespace<T>(self, v: T) -> Self

where T: Into<HierarchicalNamespace>,

Sets the value of hierarchical_namespace.

Example

use google_cloud_storage::model::bucket::HierarchicalNamespace;
let x = Bucket::new().set_hierarchical_namespace(HierarchicalNamespace::default()/* use setters */);

pub fn set_or_clear_hierarchical_namespace<T>(self, v: Option<T>) -> Self

where T: Into<HierarchicalNamespace>,

Sets or clears the value of hierarchical_namespace.

Example

use google_cloud_storage::model::bucket::HierarchicalNamespace;
let x = Bucket::new().set_or_clear_hierarchical_namespace(Some(HierarchicalNamespace::default()/* use setters */));
let x = Bucket::new().set_or_clear_hierarchical_namespace(None::<HierarchicalNamespace>);

pub fn set_soft_delete_policy<T>(self, v: T) -> Self

where T: Into<SoftDeletePolicy>,

Sets the value of soft_delete_policy.

Example

use google_cloud_storage::model::bucket::SoftDeletePolicy;
let x = Bucket::new().set_soft_delete_policy(SoftDeletePolicy::default()/* use setters */);

pub fn set_or_clear_soft_delete_policy<T>(self, v: Option<T>) -> Self

where T: Into<SoftDeletePolicy>,

Sets or clears the value of soft_delete_policy.

Example

use google_cloud_storage::model::bucket::SoftDeletePolicy;
let x = Bucket::new().set_or_clear_soft_delete_policy(Some(SoftDeletePolicy::default()/* use setters */));
let x = Bucket::new().set_or_clear_soft_delete_policy(None::<SoftDeletePolicy>);

pub fn set_object_retention<T>(self, v: T) -> Self

where T: Into<ObjectRetention>,

Sets the value of object_retention.

Example

use google_cloud_storage::model::bucket::ObjectRetention;
let x = Bucket::new().set_object_retention(ObjectRetention::default()/* use setters */);

pub fn set_or_clear_object_retention<T>(self, v: Option<T>) -> Self

where T: Into<ObjectRetention>,

Sets or clears the value of object_retention.

Example

use google_cloud_storage::model::bucket::ObjectRetention;
let x = Bucket::new().set_or_clear_object_retention(Some(ObjectRetention::default()/* use setters */));
let x = Bucket::new().set_or_clear_object_retention(None::<ObjectRetention>);

pub fn set_ip_filter<T>(self, v: T) -> Self

where T: Into<IpFilter>,

Sets the value of ip_filter.

Example

use google_cloud_storage::model::bucket::IpFilter;
let x = Bucket::new().set_ip_filter(IpFilter::default()/* use setters */);

pub fn set_or_clear_ip_filter<T>(self, v: Option<T>) -> Self

where T: Into<IpFilter>,

Sets or clears the value of ip_filter.

Example

use google_cloud_storage::model::bucket::IpFilter;
let x = Bucket::new().set_or_clear_ip_filter(Some(IpFilter::default()/* use setters */));
let x = Bucket::new().set_or_clear_ip_filter(None::<IpFilter>);

Trait Implementations

impl Clone for Bucket

fn clone(&self) -> Bucket

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Bucket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Bucket

fn default() -> Bucket

Returns the “default value” for a type.

impl Message for Bucket

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Bucket

fn eq(&self, other: &Bucket) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Bucket