Class Object
An object.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Storage.v1.Data
Assembly: Google.Apis.Storage.v1.dll
Syntax
public class Object : IDirectResponseSchema
Properties
Acl
Access controls on the object.
Declaration
[JsonProperty("acl")]
public virtual IList<ObjectAccessControl> Acl { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<ObjectAccessControl> |
Bucket
The name of the bucket containing this object.
Declaration
[JsonProperty("bucket")]
public virtual string Bucket { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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.
Declaration
[JsonProperty("cacheControl")]
public virtual string CacheControl { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ComponentCount
Number of underlying components that make up this object. Components are accumulated by compose operations.
Declaration
[JsonProperty("componentCount")]
public virtual int? ComponentCount { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int32> |
ContentDisposition
Content-Disposition of the object data.
Declaration
[JsonProperty("contentDisposition")]
public virtual string ContentDisposition { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ContentEncoding
Content-Encoding of the object data.
Declaration
[JsonProperty("contentEncoding")]
public virtual string ContentEncoding { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ContentLanguage
Content-Language of the object data.
Declaration
[JsonProperty("contentLanguage")]
public virtual string ContentLanguage { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ContentType
Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
Declaration
[JsonProperty("contentType")]
public virtual string ContentType { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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.
Declaration
[JsonProperty("crc32c")]
public virtual string Crc32c { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CustomerEncryption
Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
Declaration
[JsonProperty("customerEncryption")]
public virtual Object.CustomerEncryptionData CustomerEncryption { get; set; }
Property Value
Type | Description |
---|---|
Object.CustomerEncryptionData |
CustomTime
System.DateTime representation of CustomTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTime? CustomTime { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTime> |
CustomTimeRaw
A timestamp in RFC 3339 format specified by the user for an object.
Declaration
[JsonProperty("customTime")]
public virtual string CustomTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ETag
HTTP 1.1 Entity tag for the object.
Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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.
Declaration
[JsonProperty("eventBasedHold")]
public virtual bool? EventBasedHold { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
Generation
The content generation of this object. Used for object versioning.
Declaration
[JsonProperty("generation")]
public virtual long? Generation { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> |
Id
The ID of the object, including the bucket name, object name, and generation number.
Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Kind
The kind of item this is. For objects, this is always storage#object.
Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type | Description |
---|---|
System.String |
KmsKeyName
Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
Declaration
[JsonProperty("kmsKeyName")]
public virtual string KmsKeyName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Md5Hash
MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
Declaration
[JsonProperty("md5Hash")]
public virtual string Md5Hash { get; set; }
Property Value
Type | Description |
---|---|
System.String |
MediaLink
Media download link.
Declaration
[JsonProperty("mediaLink")]
public virtual string MediaLink { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Metadata
User-provided metadata, in key/value pairs.
Declaration
[JsonProperty("metadata")]
public virtual IDictionary<string, string> Metadata { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IDictionary<System.String, System.String> |
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.
Declaration
[JsonProperty("metageneration")]
public virtual long? Metageneration { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> |
Name
The name of the object. Required if not specified by URL parameter.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Owner
The owner of the object. This will always be the uploader of the object.
Declaration
[JsonProperty("owner")]
public virtual Object.OwnerData Owner { get; set; }
Property Value
Type | Description |
---|---|
Object.OwnerData |
RetentionExpirationTime
System.DateTime representation of RetentionExpirationTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTime? RetentionExpirationTime { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTime> |
RetentionExpirationTimeRaw
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).
Declaration
[JsonProperty("retentionExpirationTime")]
public virtual string RetentionExpirationTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SelfLink
The link to this object.
Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Size
Content-Length of the data in bytes.
Declaration
[JsonProperty("size")]
public virtual ulong? Size { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.UInt64> |
StorageClass
Storage class of the object.
Declaration
[JsonProperty("storageClass")]
public virtual string StorageClass { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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.
Declaration
[JsonProperty("temporaryHold")]
public virtual bool? TemporaryHold { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
TimeCreated
System.DateTime representation of TimeCreatedRaw.
Declaration
[JsonIgnore]
public virtual DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTime> |
TimeCreatedRaw
The creation time of the object in RFC 3339 format.
Declaration
[JsonProperty("timeCreated")]
public virtual string TimeCreatedRaw { get; set; }
Property Value
Type | Description |
---|---|
System.String |
TimeDeleted
System.DateTime representation of TimeDeletedRaw.
Declaration
[JsonIgnore]
public virtual DateTime? TimeDeleted { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTime> |
TimeDeletedRaw
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.
Declaration
[JsonProperty("timeDeleted")]
public virtual string TimeDeletedRaw { get; set; }
Property Value
Type | Description |
---|---|
System.String |
TimeStorageClassUpdated
System.DateTime representation of TimeStorageClassUpdatedRaw.
Declaration
[JsonIgnore]
public virtual DateTime? TimeStorageClassUpdated { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTime> |
TimeStorageClassUpdatedRaw
The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
Declaration
[JsonProperty("timeStorageClassUpdated")]
public virtual string TimeStorageClassUpdatedRaw { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Updated
System.DateTime representation of UpdatedRaw.
Declaration
[JsonIgnore]
public virtual DateTime? Updated { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTime> |
UpdatedRaw
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.
Declaration
[JsonProperty("updated")]
public virtual string UpdatedRaw { get; set; }
Property Value
Type | Description |
---|---|
System.String |