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

An object. More...

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

Classes

class  CustomerEncryptionData
 Metadata of customer-supplied encryption key, if the object is encrypted by such a key. More...
 
class  OwnerData
 The owner of the object. This will always be the uploader of the object. More...
 

Properties

virtual System.Collections.Generic.IList< ObjectAccessControlAcl [get, set]
 Access controls on the object. More...
 
virtual string Bucket [get, set]
 The name of the bucket containing this object. More...
 
virtual string CacheControl [get, set]
 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. More...
 
virtual System.Nullable< int > ComponentCount [get, set]
 Number of underlying components that make up this object. Components are accumulated by compose operations. More...
 
virtual string ContentDisposition [get, set]
 Content-Disposition of the object data. More...
 
virtual string ContentEncoding [get, set]
 Content-Encoding of the object data. More...
 
virtual string ContentLanguage [get, set]
 Content-Language of the object data. More...
 
virtual string ContentType [get, set]
 Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream. More...
 
virtual string Crc32c [get, set]
 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. More...
 
virtual Object.CustomerEncryptionData CustomerEncryption [get, set]
 Metadata of customer-supplied encryption key, if the object is encrypted by such a key. More...
 
virtual string ETag [get, set]
 HTTP 1.1 Entity tag for the object. More...
 
virtual System.Nullable< bool > EventBasedHold [get, set]
 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. More...
 
virtual System.Nullable< long > Generation [get, set]
 The content generation of this object. Used for object versioning. More...
 
virtual string Id [get, set]
 The ID of the object, including the bucket name, object name, and generation number. More...
 
virtual string Kind [get, set]
 The kind of item this is. For objects, this is always storage::object. More...
 
virtual string KmsKeyName [get, set]
 Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key. More...
 
virtual string Md5Hash [get, set]
 MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. More...
 
virtual string MediaLink [get, set]
 Media download link. More...
 
virtual System.Collections.Generic.IDictionary< string, string > Metadata [get, set]
 User-provided metadata, in key/value pairs. More...
 
virtual System.Nullable< long > Metageneration [get, set]
 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. More...
 
virtual string Name [get, set]
 The name of the object. Required if not specified by URL parameter. More...
 
virtual Object.OwnerData Owner [get, set]
 The owner of the object. This will always be the uploader of the object. More...
 
virtual string RetentionExpirationTimeRaw [get, set]
 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). More...
 
virtual System.Nullable< System.DateTime > RetentionExpirationTime [get, set]
 
See also
System.DateTime

representation of RetentionExpirationTimeRaw. More...

 
virtual string SelfLink [get, set]
 The link to this object. More...
 
virtual System.Nullable< ulong > Size [get, set]
 Content-Length of the data in bytes. More...
 
virtual string StorageClass [get, set]
 Storage class of the object. More...
 
virtual System.Nullable< bool > TemporaryHold [get, set]
 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. More...
 
virtual string TimeCreatedRaw [get, set]
 The creation time of the object in RFC 3339 format. More...
 
virtual System.Nullable< System.DateTime > TimeCreated [get, set]
 
See also
System.DateTime

representation of TimeCreatedRaw. More...

 
virtual string TimeDeletedRaw [get, set]
 The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. More...
 
virtual System.Nullable< System.DateTime > TimeDeleted [get, set]
 
See also
System.DateTime

representation of TimeDeletedRaw. More...

 
virtual string TimeStorageClassUpdatedRaw [get, set]
 The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. More...
 
virtual System.Nullable< System.DateTime > TimeStorageClassUpdated [get, set]
 
See also
System.DateTime

representation of TimeStorageClassUpdatedRaw. More...

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

representation of UpdatedRaw. More...

 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Detailed Description

An object.

Property Documentation

◆ Acl

virtual System.Collections.Generic.IList<ObjectAccessControl> Google.Apis.Storage.v1.Data.Object.Acl
getset

Access controls on the object.

◆ Bucket

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

The name of the bucket containing this object.

◆ CacheControl

virtual string Google.Apis.Storage.v1.Data.Object.CacheControl
getset

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

virtual System.Nullable<int> Google.Apis.Storage.v1.Data.Object.ComponentCount
getset

Number of underlying components that make up this object. Components are accumulated by compose operations.

◆ ContentDisposition

virtual string Google.Apis.Storage.v1.Data.Object.ContentDisposition
getset

Content-Disposition of the object data.

◆ ContentEncoding

virtual string Google.Apis.Storage.v1.Data.Object.ContentEncoding
getset

Content-Encoding of the object data.

◆ ContentLanguage

virtual string Google.Apis.Storage.v1.Data.Object.ContentLanguage
getset

Content-Language of the object data.

◆ ContentType

virtual string Google.Apis.Storage.v1.Data.Object.ContentType
getset

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.

◆ Crc32c

virtual string Google.Apis.Storage.v1.Data.Object.Crc32c
getset

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.

◆ CustomerEncryption

virtual Object.CustomerEncryptionData Google.Apis.Storage.v1.Data.Object.CustomerEncryption
getset

Metadata of customer-supplied encryption key, if the object is encrypted by such a key.

◆ ETag

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

HTTP 1.1 Entity tag for the object.

◆ EventBasedHold

virtual System.Nullable<bool> Google.Apis.Storage.v1.Data.Object.EventBasedHold
getset

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

virtual System.Nullable<long> Google.Apis.Storage.v1.Data.Object.Generation
getset

The content generation of this object. Used for object versioning.

◆ Id

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

The ID of the object, including the bucket name, object name, and generation number.

◆ Kind

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

The kind of item this is. For objects, this is always storage::object.

◆ KmsKeyName

virtual string Google.Apis.Storage.v1.Data.Object.KmsKeyName
getset

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.

◆ Md5Hash

virtual string Google.Apis.Storage.v1.Data.Object.Md5Hash
getset

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.

◆ MediaLink

virtual string Google.Apis.Storage.v1.Data.Object.MediaLink
getset

Media download link.

◆ Metadata

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

User-provided metadata, in key/value pairs.

◆ Metageneration

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

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

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

The name of the object. Required if not specified by URL parameter.

◆ Owner

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

The owner of the object. This will always be the uploader of the object.

◆ RetentionExpirationTime

virtual System.Nullable<System.DateTime> Google.Apis.Storage.v1.Data.Object.RetentionExpirationTime
getset

See also
System.DateTime

representation of RetentionExpirationTimeRaw.

◆ RetentionExpirationTimeRaw

virtual string Google.Apis.Storage.v1.Data.Object.RetentionExpirationTimeRaw
getset

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

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

The link to this object.

◆ Size

virtual System.Nullable<ulong> Google.Apis.Storage.v1.Data.Object.Size
getset

Content-Length of the data in bytes.

◆ StorageClass

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

Storage class of the object.

◆ TemporaryHold

virtual System.Nullable<bool> Google.Apis.Storage.v1.Data.Object.TemporaryHold
getset

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

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

See also
System.DateTime

representation of TimeCreatedRaw.

◆ TimeCreatedRaw

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

The creation time of the object in RFC 3339 format.

◆ TimeDeleted

virtual System.Nullable<System.DateTime> Google.Apis.Storage.v1.Data.Object.TimeDeleted
getset

See also
System.DateTime

representation of TimeDeletedRaw.

◆ TimeDeletedRaw

virtual string Google.Apis.Storage.v1.Data.Object.TimeDeletedRaw
getset

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.

◆ TimeStorageClassUpdated

virtual System.Nullable<System.DateTime> Google.Apis.Storage.v1.Data.Object.TimeStorageClassUpdated
getset

See also
System.DateTime

representation of TimeStorageClassUpdatedRaw.

◆ TimeStorageClassUpdatedRaw

virtual string Google.Apis.Storage.v1.Data.Object.TimeStorageClassUpdatedRaw
getset

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

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

See also
System.DateTime

representation of UpdatedRaw.

◆ UpdatedRaw

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

The modification time of the object metadata in RFC 3339 format.


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