GetBucketResult class

Result data returned by getBucket.

Constructors

GetBucketResult({required List<BucketAccessControlResponse> acl, required BucketAutoclassResponse autoclass, required BucketBillingResponse billing, required List<BucketCorsItemResponse> cors, required BucketCustomPlacementConfigResponse customPlacementConfig, required bool defaultEventBasedHold, required List<ObjectAccessControlResponse> defaultObjectAcl, required BucketEncryptionResponse encryption, required String etag, required BucketIamConfigurationResponse iamConfiguration, required String kind, required Map<String, String> labels, required BucketLifecycleResponse lifecycle, required String location, required String locationType, required BucketLoggingResponse logging, required String metageneration, required String name, required BucketObjectRetentionResponse objectRetention, required BucketOwnerResponse owner, required String projectNumber, required BucketRetentionPolicyResponse retentionPolicy, required String rpo, required bool satisfiesPZS, required String selfLink, required BucketSoftDeletePolicyResponse softDeletePolicy, required String storageClass, required String timeCreated, required String updated, required BucketVersioningResponse versioning, required BucketWebsiteResponse website})
Creates a new GetBucketResult. 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. encryption Encryption configuration for a bucket. etag HTTP 1.1 Entity tag for the bucket. iamConfiguration The bucket's IAM configuration. 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. projectNumber The project number of the project the bucket belongs to. 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. 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.
const
GetBucketResult.fromMap(Map<String, dynamic> map)
factory

Properties

acl → List<BucketAccessControlResponse>
Access controls on the bucket.
final
autoclass → BucketAutoclassResponse
The bucket's Autoclass configuration.
final
billing → BucketBillingResponse
The bucket's billing configuration.
final
cors → List<BucketCorsItemResponse>
The bucket's Cross-Origin Resource Sharing (CORS) configuration.
final
customPlacementConfig → BucketCustomPlacementConfigResponse
The bucket's custom placement configuration for Custom Dual Regions.
final
defaultEventBasedHold → 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.
final
defaultObjectAcl → List<ObjectAccessControlResponse>
Default access controls to apply to new objects when no ACL is provided.
final
encryption → BucketEncryptionResponse
Encryption configuration for a bucket.
final
etag → String
HTTP 1.1 Entity tag for the bucket.
final
hashCode → int
The hash code for this object.
no setterinherited
iamConfiguration → BucketIamConfigurationResponse
The bucket's IAM configuration.
final
kind → String
The kind of item this is. For buckets, this is always storage#bucket.
final
labels → Map<String, String>
User-provided labels, in key/value pairs.
final
lifecycle → BucketLifecycleResponse
The bucket's lifecycle configuration. See lifecycle management for more information.
final
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 developer's guide for the authoritative list.
final
locationType → String
The type of the bucket location.
final
logging → BucketLoggingResponse
The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
final
metageneration → String
The metadata generation of this bucket.
final
name → String
The name of the bucket.
final
objectRetention → BucketObjectRetentionResponse
The bucket's object retention config.
final
owner → BucketOwnerResponse
The owner of the bucket. This is always the project team's owner group.
final
projectNumber → String
The project number of the project the bucket belongs to.
final
retentionPolicy → BucketRetentionPolicyResponse
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.
final
rpo → String
The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPZS → bool
Reserved for future use.
final
The URI of this bucket.
final
softDeletePolicy → BucketSoftDeletePolicyResponse
The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted.
final
storageClass → 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. 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.
final
timeCreated → String
The creation time of the bucket in RFC 3339 format.
final
updated → String
The modification time of the bucket in RFC 3339 format.
final
versioning → BucketVersioningResponse
The bucket's versioning configuration.
final
website → BucketWebsiteResponse
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited