storage  v1
Classes | Properties | List of all members
Google.Apis.Storage.v1.Data.Bucket Class Reference

A bucket. More...

Inheritance diagram for Google.Apis.Storage.v1.Data.Bucket:
Google::Apis::Requests::IDirectResponseSchema

Classes

class  BillingData
 The bucket's billing configuration. More...
 
class  CorsData
 
class  EncryptionData
 Encryption configuration for a bucket. More...
 
class  IamConfigurationData
 The bucket's IAM configuration. More...
 
class  LifecycleData
 The bucket's lifecycle configuration. See lifecycle management for more information. More...
 
class  LoggingData
 The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. More...
 
class  OwnerData
 The owner of the bucket. This is always the project team's owner group. More...
 
class  RetentionPolicyData
 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. More...
 
class  VersioningData
 The bucket's versioning configuration. More...
 
class  WebsiteData
 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. More...
 

Properties

virtual System.Collections.Generic.IList< BucketAccessControlAcl [get, set]
 Access controls on the bucket. More...
 
virtual Bucket.BillingData Billing [get, set]
 The bucket's billing configuration. More...
 
virtual System.Collections.Generic.IList< Bucket.CorsDataCors [get, set]
 The bucket's Cross-Origin Resource Sharing (CORS) configuration. More...
 
virtual System.Nullable< bool > DefaultEventBasedHold [get, set]
 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. More...
 
virtual System.Collections.Generic.IList< ObjectAccessControlDefaultObjectAcl [get, set]
 Default access controls to apply to new objects when no ACL is provided. More...
 
virtual Bucket.EncryptionData Encryption [get, set]
 Encryption configuration for a bucket. More...
 
virtual string ETag [get, set]
 HTTP 1.1 Entity tag for the bucket. More...
 
virtual Bucket.IamConfigurationData IamConfiguration [get, set]
 The bucket's IAM configuration. More...
 
virtual string Id [get, set]
 The ID of the bucket. For buckets, the id and name properties are the same. More...
 
virtual string Kind [get, set]
 The kind of item this is. For buckets, this is always storage::bucket. More...
 
virtual System.Collections.Generic.IDictionary< string, string > Labels [get, set]
 User-provided labels, in key/value pairs. More...
 
virtual Bucket.LifecycleData Lifecycle [get, set]
 The bucket's lifecycle configuration. See lifecycle management for more information. More...
 
virtual string Location [get, set]
 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. More...
 
virtual string LocationType [get, set]
 The type of the bucket location. More...
 
virtual Bucket.LoggingData Logging [get, set]
 The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. More...
 
virtual System.Nullable< long > Metageneration [get, set]
 The metadata generation of this bucket. More...
 
virtual string Name [get, set]
 The name of the bucket. More...
 
virtual Bucket.OwnerData Owner [get, set]
 The owner of the bucket. This is always the project team's owner group. More...
 
virtual System.Nullable< ulong > ProjectNumber [get, set]
 The project number of the project the bucket belongs to. More...
 
virtual Bucket.RetentionPolicyData RetentionPolicy [get, set]
 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. More...
 
virtual string SelfLink [get, set]
 The URI of this bucket. More...
 
virtual string StorageClass [get, set]
 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. More...
 
virtual string TimeCreatedRaw [get, set]
 The creation time of the bucket in RFC 3339 format. More...
 
virtual System.Nullable< System.DateTime > TimeCreated [get, set]
 
See also
System.DateTime

representation of TimeCreatedRaw. More...

 
virtual string UpdatedRaw [get, set]
 The modification time of the bucket in RFC 3339 format. More...
 
virtual System.Nullable< System.DateTime > Updated [get, set]
 
See also
System.DateTime

representation of UpdatedRaw. More...

 
virtual Bucket.VersioningData Versioning [get, set]
 The bucket's versioning configuration. More...
 
virtual Bucket.WebsiteData Website [get, set]
 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. More...
 
virtual System.Collections.Generic.IList< string > ZoneAffinity [get, set]
 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. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Detailed Description

A bucket.

Property Documentation

◆ Acl

virtual System.Collections.Generic.IList<BucketAccessControl> Google.Apis.Storage.v1.Data.Bucket.Acl
getset

Access controls on the bucket.

◆ Billing

virtual Bucket.BillingData Google.Apis.Storage.v1.Data.Bucket.Billing
getset

The bucket's billing configuration.

◆ Cors

virtual System.Collections.Generic.IList<Bucket.CorsData> Google.Apis.Storage.v1.Data.Bucket.Cors
getset

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

◆ DefaultEventBasedHold

virtual System.Nullable<bool> Google.Apis.Storage.v1.Data.Bucket.DefaultEventBasedHold
getset

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.

◆ DefaultObjectAcl

virtual System.Collections.Generic.IList<ObjectAccessControl> Google.Apis.Storage.v1.Data.Bucket.DefaultObjectAcl
getset

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

◆ Encryption

virtual Bucket.EncryptionData Google.Apis.Storage.v1.Data.Bucket.Encryption
getset

Encryption configuration for a bucket.

◆ ETag

virtual string Google.Apis.Storage.v1.Data.Bucket.ETag
getset

HTTP 1.1 Entity tag for the bucket.

◆ IamConfiguration

virtual Bucket.IamConfigurationData Google.Apis.Storage.v1.Data.Bucket.IamConfiguration
getset

The bucket's IAM configuration.

◆ Id

virtual string Google.Apis.Storage.v1.Data.Bucket.Id
getset

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

◆ Kind

virtual string Google.Apis.Storage.v1.Data.Bucket.Kind
getset

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

◆ Labels

virtual System.Collections.Generic.IDictionary<string,string> Google.Apis.Storage.v1.Data.Bucket.Labels
getset

User-provided labels, in key/value pairs.

◆ Lifecycle

virtual Bucket.LifecycleData Google.Apis.Storage.v1.Data.Bucket.Lifecycle
getset

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

◆ Location

virtual string Google.Apis.Storage.v1.Data.Bucket.Location
getset

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.

◆ LocationType

virtual string Google.Apis.Storage.v1.Data.Bucket.LocationType
getset

The type of the bucket location.

◆ Logging

virtual Bucket.LoggingData Google.Apis.Storage.v1.Data.Bucket.Logging
getset

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

◆ Metageneration

virtual System.Nullable<long> Google.Apis.Storage.v1.Data.Bucket.Metageneration
getset

The metadata generation of this bucket.

◆ Name

virtual string Google.Apis.Storage.v1.Data.Bucket.Name
getset

The name of the bucket.

◆ Owner

virtual Bucket.OwnerData Google.Apis.Storage.v1.Data.Bucket.Owner
getset

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

◆ ProjectNumber

virtual System.Nullable<ulong> Google.Apis.Storage.v1.Data.Bucket.ProjectNumber
getset

The project number of the project the bucket belongs to.

◆ RetentionPolicy

virtual Bucket.RetentionPolicyData Google.Apis.Storage.v1.Data.Bucket.RetentionPolicy
getset

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.

◆ SelfLink

virtual string Google.Apis.Storage.v1.Data.Bucket.SelfLink
getset

The URI of this bucket.

◆ StorageClass

virtual string Google.Apis.Storage.v1.Data.Bucket.StorageClass
getset

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.

◆ TimeCreated

virtual System.Nullable<System.DateTime> Google.Apis.Storage.v1.Data.Bucket.TimeCreated
getset

See also
System.DateTime

representation of TimeCreatedRaw.

◆ TimeCreatedRaw

virtual string Google.Apis.Storage.v1.Data.Bucket.TimeCreatedRaw
getset

The creation time of the bucket in RFC 3339 format.

◆ Updated

virtual System.Nullable<System.DateTime> Google.Apis.Storage.v1.Data.Bucket.Updated
getset

See also
System.DateTime

representation of UpdatedRaw.

◆ UpdatedRaw

virtual string Google.Apis.Storage.v1.Data.Bucket.UpdatedRaw
getset

The modification time of the bucket in RFC 3339 format.

◆ Versioning

virtual Bucket.VersioningData Google.Apis.Storage.v1.Data.Bucket.Versioning
getset

The bucket's versioning configuration.

◆ Website

virtual Bucket.WebsiteData Google.Apis.Storage.v1.Data.Bucket.Website
getset

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.

◆ ZoneAffinity

virtual System.Collections.Generic.IList<string> Google.Apis.Storage.v1.Data.Bucket.ZoneAffinity
getset

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.


The documentation for this class was generated from the following file: