Class Bucket

A bucket.

Inheritance
System.Object
Bucket
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Storage.v1.Data
Assembly: Google.Apis.Storage.v1.dll
Syntax
public class Bucket : IDirectResponseSchema

Properties

Acl

Access controls on the bucket.

Declaration
[JsonProperty("acl")]
public virtual IList<BucketAccessControl> Acl { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<BucketAccessControl>

Billing

The bucket's billing configuration.

Declaration
[JsonProperty("billing")]
public virtual Bucket.BillingData Billing { get; set; }
Property Value
Type Description
Bucket.BillingData

Cors

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

Declaration
[JsonProperty("cors")]
public virtual IList<Bucket.CorsData> Cors { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<Bucket.CorsData>

DefaultEventBasedHold

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.

Declaration
[JsonProperty("defaultEventBasedHold")]
public virtual bool? DefaultEventBasedHold { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

DefaultObjectAcl

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

Declaration
[JsonProperty("defaultObjectAcl")]
public virtual IList<ObjectAccessControl> DefaultObjectAcl { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<ObjectAccessControl>

Encryption

Encryption configuration for a bucket.

Declaration
[JsonProperty("encryption")]
public virtual Bucket.EncryptionData Encryption { get; set; }
Property Value
Type Description
Bucket.EncryptionData

ETag

HTTP 1.1 Entity tag for the bucket.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
System.String

IamConfiguration

The bucket's IAM configuration.

Declaration
[JsonProperty("iamConfiguration")]
public virtual Bucket.IamConfigurationData IamConfiguration { get; set; }
Property Value
Type Description
Bucket.IamConfigurationData

Id

The ID of the bucket. For buckets, the id and name properties are the same.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
System.String

Kind

The kind of item this is. For buckets, this is always storage#bucket.

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
System.String

Labels

User-provided labels, in key/value pairs.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.String>

Lifecycle

The bucket's lifecycle configuration. See lifecycle management for more information.

Declaration
[JsonProperty("lifecycle")]
public virtual Bucket.LifecycleData Lifecycle { get; set; }
Property Value
Type Description
Bucket.LifecycleData

Location

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

Declaration
[JsonProperty("location")]
public virtual string Location { get; set; }
Property Value
Type Description
System.String

LocationType

The type of the bucket location.

Declaration
[JsonProperty("locationType")]
public virtual string LocationType { get; set; }
Property Value
Type Description
System.String

Logging

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

Declaration
[JsonProperty("logging")]
public virtual Bucket.LoggingData Logging { get; set; }
Property Value
Type Description
Bucket.LoggingData

Metageneration

The metadata generation of this bucket.

Declaration
[JsonProperty("metageneration")]
public virtual long? Metageneration { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

Name

The name of the bucket.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
System.String

Owner

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

Declaration
[JsonProperty("owner")]
public virtual Bucket.OwnerData Owner { get; set; }
Property Value
Type Description
Bucket.OwnerData

ProjectNumber

The project number of the project the bucket belongs to.

Declaration
[JsonProperty("projectNumber")]
public virtual ulong? ProjectNumber { get; set; }
Property Value
Type Description
System.Nullable<System.UInt64>

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.

Declaration
[JsonProperty("retentionPolicy")]
public virtual Bucket.RetentionPolicyData RetentionPolicy { get; set; }
Property Value
Type Description
Bucket.RetentionPolicyData

SatisfiesPZS

Reserved for future use.

Declaration
[JsonProperty("satisfiesPZS")]
public virtual bool? SatisfiesPZS { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

The URI of this bucket.

Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type Description
System.String

StorageClass

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. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.

Declaration
[JsonProperty("storageClass")]
public virtual string StorageClass { get; set; }
Property Value
Type Description
System.String

TimeCreated

System.DateTime representation of TimeCreatedRaw.

Declaration
[JsonIgnore]
public virtual DateTime? TimeCreated { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

TimeCreatedRaw

The creation time of the bucket in RFC 3339 format.

Declaration
[JsonProperty("timeCreated")]
public virtual string TimeCreatedRaw { get; set; }
Property Value
Type Description
System.String

Updated

System.DateTime representation of UpdatedRaw.

Declaration
[JsonIgnore]
public virtual DateTime? Updated { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

UpdatedRaw

The modification time of the bucket in RFC 3339 format.

Declaration
[JsonProperty("updated")]
public virtual string UpdatedRaw { get; set; }
Property Value
Type Description
System.String

Versioning

The bucket's versioning configuration.

Declaration
[JsonProperty("versioning")]
public virtual Bucket.VersioningData Versioning { get; set; }
Property Value
Type Description
Bucket.VersioningData

Website

The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

Declaration
[JsonProperty("website")]
public virtual Bucket.WebsiteData Website { get; set; }
Property Value
Type Description
Bucket.WebsiteData

ZoneAffinity

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 zone or zones need to be within the bucket location otherwise the requests will fail with a 400 Bad Request response.

Declaration
[JsonProperty("zoneAffinity")]
public virtual IList<string> ZoneAffinity { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.String>

Implements