GetBucketObjectResult class

Result data returned by getBucketObject.

Constructors

GetBucketObjectResult({required List<ObjectAccessControlResponse> acl, required String bucket, required String cacheControl, required int componentCount, required String contentDisposition, required String contentEncoding, required String contentLanguage, required String contentType, required String crc32c, required String customTime, required BucketObjectCustomerEncryptionResponse customerEncryption, required String etag, required bool eventBasedHold, required String generation, required String hardDeleteTime, required String kind, required String kmsKeyName, required String md5Hash, required String mediaLink, required Map<String, String> metadata, required String metageneration, required String name, required BucketObjectOwnerResponse owner, required BucketObjectRetentionResponse retention, required String retentionExpirationTime, required String selfLink, required String size, required String softDeleteTime, required String storageClass, required bool temporaryHold, required String timeCreated, required String timeDeleted, required String timeStorageClassUpdated, required String updated})
Creates a new GetBucketObjectResult. acl Access controls on the object. bucket The name of the bucket containing this object. cacheControl Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600. componentCount Number of underlying components that make up this object. Components are accumulated by compose operations. contentDisposition Content-Disposition of the object data. contentEncoding Content-Encoding of the object data. contentLanguage Content-Language of the object data. contentType Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream. crc32c CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. customTime A timestamp in RFC 3339 format specified by the user for an object. customerEncryption Metadata of customer-supplied encryption key, if the object is encrypted by such a key. etag HTTP 1.1 Entity tag for the object. eventBasedHold Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), 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 the 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. generation The content generation of this object. Used for object versioning. hardDeleteTime This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket. kind The kind of item this is. For objects, this is always storage#object. kmsKeyName Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request. md5Hash MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. mediaLink Media download link. metadata User-provided metadata, in key/value pairs. metageneration The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. name The name of the object. Required if not specified by URL parameter. owner The owner of the object. This will always be the uploader of the object. retention A collection of object level retention parameters. retentionExpirationTime A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold). selfLink The link to this object. size Content-Length of the data in bytes. softDeleteTime The time at which the object became soft-deleted in RFC 3339 format. storageClass Storage class of the object. temporaryHold Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object. timeCreated The creation time of the object in RFC 3339 format. timeDeleted The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. timeStorageClassUpdated The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. updated The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
const
GetBucketObjectResult.fromMap(Map<String, dynamic> map)
factory

Properties

acl → List<ObjectAccessControlResponse>
Access controls on the object.
final
bucket → String
The name of the bucket containing this object.
final
cacheControl → String
Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
final
componentCount → int
Number of underlying components that make up this object. Components are accumulated by compose operations.
final
contentDisposition → String
Content-Disposition of the object data.
final
contentEncoding → String
Content-Encoding of the object data.
final
contentLanguage → String
Content-Language of the object data.
final
contentType → String
Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
final
crc32c → String
CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
final
customerEncryption → BucketObjectCustomerEncryptionResponse
Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
final
customTime → String
A timestamp in RFC 3339 format specified by the user for an object.
final
etag → String
HTTP 1.1 Entity tag for the object.
final
eventBasedHold → bool
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), 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 the 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.
final
generation → String
The content generation of this object. Used for object versioning.
final
hardDeleteTime → String
This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
final
hashCode → int
The hash code for this object.
no setterinherited
kind → String
The kind of item this is. For objects, this is always storage#object.
final
kmsKeyName → String
Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
final
md5Hash → String
MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
final
Media download link.
final
metadata → Map<String, String>
User-provided metadata, in key/value pairs.
final
metageneration → String
The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
final
name → String
The name of the object. Required if not specified by URL parameter.
final
owner → BucketObjectOwnerResponse
The owner of the object. This will always be the uploader of the object.
final
retention → BucketObjectRetentionResponse
A collection of object level retention parameters.
final
retentionExpirationTime → String
A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
The link to this object.
final
size → String
Content-Length of the data in bytes.
final
softDeleteTime → String
The time at which the object became soft-deleted in RFC 3339 format.
final
storageClass → String
Storage class of the object.
final
temporaryHold → bool
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
final
timeCreated → String
The creation time of the object in RFC 3339 format.
final
timeDeleted → String
The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
final
timeStorageClassUpdated → String
The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
final
updated → String
The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
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