Struct gcp_client::google::storage::v1::Bucket

pub struct Bucket {
    pub acl: Vec<BucketAccessControl>,
    pub default_object_acl: Vec<ObjectAccessControl>,
    pub lifecycle: Option<Lifecycle>,
    pub time_created: Option<Timestamp>,
    pub id: String,
    pub name: String,
    pub project_number: i64,
    pub metageneration: i64,
    pub cors: Vec<Cors>,
    pub location: String,
    pub storage_class: String,
    pub etag: String,
    pub updated: 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 location_type: String,
    pub iam_configuration: Option<IamConfiguration>,
    pub zone_affinity: Vec<String>,
}

A bucket.

Fields

acl: Vec<BucketAccessControl>

Access controls on the bucket.

default_object_acl: Vec<ObjectAccessControl>

Default access controls to apply to new objects when no ACL is provided.

lifecycle: Option<Lifecycle>

The bucket's lifecycle configuration. See [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management] for more information.

time_created: Option<Timestamp>

The creation time of the bucket in [https://tools.ietf.org/html/rfc3339][RFC 3339] format. Attempting to set this field will result in an error.

id: String

The ID of the bucket. For buckets, the id and name properties are the same. Attempting to update this field after the bucket is created will result in an error.

name: String

The name of the bucket. Attempting to update this field after the bucket is created will result in an error.

project_number: i64

The project number of the project the bucket belongs to. Attempting to set this field will result in an error.

metageneration: i64

The metadata generation of this bucket. Attempting to set this field will result in an error.

cors: Vec<Cors>

The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) configuration.

location: String

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the [https://developers.google.com/storage/docs/concepts-techniques#specifyinglocations"][developer's guide] for the authoritative list. Attempting to update this field after the bucket is created will result in an error.

storage_class: String

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 will default to STANDARD. For more information, see https://developers.google.com/storage/docs/storage-classes.

etag: String

HTTP 1.1 [https://tools.ietf.org/html/rfc7232#section-2.3"]Entity tag] for the bucket. Attempting to set this field will result in an error.

updated: Option<Timestamp>

The modification time of the bucket. Attempting to set this field will result in an error.

default_event_based_hold: bool

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 will be 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 will be 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>

User-provided labels, in key/value pairs.

website: Option<Website>

The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the [https://cloud.google.com/storage/docs/static-website][Static Website Examples] for more information.

versioning: Option<Versioning>

The bucket's versioning configuration.

logging: Option<Logging>

The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.

owner: Option<Owner>

The owner of the bucket. This is always the project team's owner group.

encryption: Option<Encryption>

Encryption configuration for a bucket.

billing: Option<Billing>

The bucket's billing configuration.

retention_policy: Option<RetentionPolicy>

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 will result 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 will result in a PERMISSION_DENIED error.

location_type: String

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

iam_configuration: Option<IamConfiguration>

The bucket's IAM configuration.

zone_affinity: Vec<String>

The zone or zones from which the bucket is intended to use zonal quota. Requests for data from outside the specified affinities are still allowed but won’t be able to use zonal quota. The values are case-insensitive. Attempting to update this field after bucket is created will result in an error.

Trait Implementations

impl Clone for Bucket

fn clone(&self) -> Bucket

Returns a copy 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 encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Bucket> for Bucket

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Bucket