Class Bucket

A bucket.

Inheritance

object

Bucket

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

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
IList<BucketAccessControl>

Autoclass

The bucket's Autoclass configuration.

Declaration

[JsonProperty("autoclass")]
public virtual Bucket.AutoclassData Autoclass { get; set; }

Property Value

Type	Description
Bucket.AutoclassData

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
IList<Bucket.CorsData>

CustomPlacementConfig

The bucket's custom placement configuration for Custom Dual Regions.

Declaration

[JsonProperty("customPlacementConfig")]
public virtual Bucket.CustomPlacementConfigData CustomPlacementConfig { get; set; }

Property Value

Type	Description
Bucket.CustomPlacementConfigData

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
bool?

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
IList<ObjectAccessControl>

ETag

HTTP 1.1 Entity tag for the bucket.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

Encryption

Encryption configuration for a bucket.

Declaration

[JsonProperty("encryption")]
public virtual Bucket.EncryptionData Encryption { get; set; }

Property Value

Type	Description
Bucket.EncryptionData

Generation

The generation of this bucket.

Declaration

[JsonProperty("generation")]
public virtual long? Generation { get; set; }

Property Value

Type	Description
long?

HardDeleteTime

DateTime representation of HardDeleteTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use HardDeleteTimeDateTimeOffset instead.")]
public virtual DateTime? HardDeleteTime { get; set; }

Property Value

Type	Description
DateTime?

HardDeleteTimeDateTimeOffset

DateTimeOffset representation of HardDeleteTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? HardDeleteTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

HardDeleteTimeRaw

The hard delete time of the bucket in RFC 3339 format.

Declaration

[JsonProperty("hardDeleteTime")]
public virtual string HardDeleteTimeRaw { get; set; }

Property Value

Type	Description
string

HierarchicalNamespace

The bucket's hierarchical namespace configuration.

Declaration

[JsonProperty("hierarchicalNamespace")]
public virtual Bucket.HierarchicalNamespaceData HierarchicalNamespace { get; set; }

Property Value

Type	Description
Bucket.HierarchicalNamespaceData

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
string

IpFilter

The bucket's IP filter configuration. Specifies the network sources that are allowed to access the operations on the bucket, as well as its underlying objects. Only enforced when the mode is set to 'Enabled'.

Declaration

[JsonProperty("ipFilter")]
public virtual Bucket.IpFilterData IpFilter { get; set; }

Property Value

Type	Description
Bucket.IpFilterData

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
string

Labels

User-provided labels, in key/value pairs.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, 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
string

LocationType

The type of the bucket location.

Declaration

[JsonProperty("locationType")]
public virtual string LocationType { get; set; }

Property Value

Type	Description
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
long?

Name

The name of the bucket.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

ObjectRetention

The bucket's object retention config.

Declaration

[JsonProperty("objectRetention")]
public virtual Bucket.ObjectRetentionData ObjectRetention { get; set; }

Property Value

Type	Description
Bucket.ObjectRetentionData

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
ulong?

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

Rpo

The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.

Declaration

[JsonProperty("rpo")]
public virtual string Rpo { get; set; }

Property Value

Type	Description
string

SatisfiesPZI

Reserved for future use.

Declaration

[JsonProperty("satisfiesPZI")]
public virtual bool? SatisfiesPZI { get; set; }

Property Value

Type	Description
bool?

SatisfiesPZS

Reserved for future use.

Declaration

[JsonProperty("satisfiesPZS")]
public virtual bool? SatisfiesPZS { get; set; }

Property Value

Type	Description
bool?

SelfLink

The URI of this bucket.

Declaration

[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }

Property Value

Type	Description
string

SoftDeletePolicy

The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.

Declaration

[JsonProperty("softDeletePolicy")]
public virtual Bucket.SoftDeletePolicyData SoftDeletePolicy { get; set; }

Property Value

Type	Description
Bucket.SoftDeletePolicyData

SoftDeleteTime

DateTime representation of SoftDeleteTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use SoftDeleteTimeDateTimeOffset instead.")]
public virtual DateTime? SoftDeleteTime { get; set; }

Property Value

Type	Description
DateTime?

SoftDeleteTimeDateTimeOffset

DateTimeOffset representation of SoftDeleteTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? SoftDeleteTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

SoftDeleteTimeRaw

The soft delete time of the bucket in RFC 3339 format.

Declaration

[JsonProperty("softDeleteTime")]
public virtual string SoftDeleteTimeRaw { get; set; }

Property Value

Type	Description
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
string

TimeCreated

DateTime representation of TimeCreatedRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use TimeCreatedDateTimeOffset instead.")]
public virtual DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?

TimeCreatedDateTimeOffset

DateTimeOffset representation of TimeCreatedRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? TimeCreatedDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

TimeCreatedRaw

The creation time of the bucket in RFC 3339 format.

Declaration

[JsonProperty("timeCreated")]
public virtual string TimeCreatedRaw { get; set; }

Property Value

Type	Description
string

Updated

DateTime representation of UpdatedRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdatedDateTimeOffset instead.")]
public virtual DateTime? Updated { get; set; }

Property Value

Type	Description
DateTime?

UpdatedDateTimeOffset

DateTimeOffset representation of UpdatedRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdatedDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdatedRaw

The modification time of the bucket in RFC 3339 format.

Declaration

[JsonProperty("updated")]
public virtual string UpdatedRaw { get; set; }

Property Value

Type	Description
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

Implements

IDirectResponseSchema