BucketArgs constructor
- Input<
List< ? acl,BucketAccessControlStorageV1> > - Input<
BucketAutoclass> ? autoclass, - Input<
BucketBilling> ? billing, - Input<
List< ? cors,BucketCorsItem> > - Input<
BucketCustomPlacementConfig> ? customPlacementConfig, - Input<
bool> ? defaultEventBasedHold, - Input<
List< ? defaultObjectAcl,ObjectAccessControlStorageV1> > - Input<
bool> ? enableObjectRetention, - Input<
BucketEncryption> ? encryption, - Input<
String> ? etag, - Input<
BucketIamConfiguration> ? iamConfiguration, - Input<
String> ? id, - Input<
String> ? kind, - Input<
Map< ? labels,String, String> > - Input<
BucketLifecycle> ? lifecycle, - Input<
String> ? location, - Input<
String> ? locationType, - Input<
BucketLogging> ? logging, - Input<
String> ? metageneration, - Input<
String> ? name, - Input<
BucketObjectRetention> ? objectRetention, - Input<
BucketOwner> ? owner, - Input<
String> ? predefinedAcl, - Input<
String> ? predefinedDefaultObjectAcl, - Input<
String> ? project, - Input<
String> ? projectNumber, - Input<
String> ? projection, - Input<
BucketRetentionPolicy> ? retentionPolicy, - Input<
String> ? rpo, - Input<
bool> ? satisfiesPZS, - Input<
String> ? selfLink, - Input<
BucketSoftDeletePolicy> ? softDeletePolicy, - Input<
String> ? storageClass, - Input<
String> ? timeCreated, - Input<
String> ? updated, - Input<
String> ? userProject, - Input<
BucketVersioning> ? versioning, - Input<
BucketWebsite> ? website,
Creates a new BucketArgs.
acl Access controls on the bucket.
autoclass The bucket's Autoclass configuration.
billing The bucket's billing configuration.
cors The bucket's Cross-Origin Resource Sharing (CORS) configuration.
customPlacementConfig The bucket's custom placement configuration for Custom Dual Regions.
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.
defaultObjectAcl Default access controls to apply to new objects when no ACL is provided.
enableObjectRetention When set to true, object retention is enabled for this bucket.
encryption Encryption configuration for a bucket.
etag HTTP 1.1 Entity tag for the bucket.
iamConfiguration The bucket's IAM configuration.
id The ID of the bucket. For buckets, the id and name properties are the same.
kind The kind of item this is. For buckets, this is always storage#bucket.
labels User-provided labels, in key/value pairs.
lifecycle The bucket's lifecycle configuration. See lifecycle management for more information.
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.
locationType The type of the bucket location.
logging The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
metageneration The metadata generation of this bucket.
name The name of the bucket.
objectRetention The bucket's object retention config.
owner The owner of the bucket. This is always the project team's owner group.
predefinedAcl Apply a predefined set of access controls to this bucket.
predefinedDefaultObjectAcl Apply a predefined set of default object access controls to this bucket.
project A valid API project identifier.
projectNumber The project number of the project the bucket belongs to.
projection Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
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.
rpo The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
satisfiesPZS Reserved for future use.
selfLink The URI of this bucket.
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.
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.
timeCreated The creation time of the bucket in RFC 3339 format.
updated The modification time of the bucket in RFC 3339 format.
userProject The project to be billed for this request.
versioning The bucket's versioning configuration.
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.
Implementation
const BucketArgs({
this.acl,
this.autoclass,
this.billing,
this.cors,
this.customPlacementConfig,
this.defaultEventBasedHold,
this.defaultObjectAcl,
this.enableObjectRetention,
this.encryption,
this.etag,
this.iamConfiguration,
this.id,
this.kind,
this.labels,
this.lifecycle,
this.location,
this.locationType,
this.logging,
this.metageneration,
this.name,
this.objectRetention,
this.owner,
this.predefinedAcl,
this.predefinedDefaultObjectAcl,
this.project,
this.projectNumber,
this.projection,
this.retentionPolicy,
this.rpo,
this.satisfiesPZS,
this.selfLink,
this.softDeletePolicy,
this.storageClass,
this.timeCreated,
this.updated,
this.userProject,
this.versioning,
this.website,
});