Object

import type { Object } from "https://googleapis.deno.dev/v1/storage:v1.ts";

An object.

interface Object {

acl?: ObjectAccessControl[];

bucket?: string;

cacheControl?: string;

componentCount?: number;

contentDisposition?: string;

contentEncoding?: string;

contentLanguage?: string;

contentType?: string;

crc32c?: string;

customerEncryption?: {

encryptionAlgorithm?: string;

keySha256?: string;

};

customTime?: Date;

etag?: string;

eventBasedHold?: boolean;

generation?: bigint;

hardDeleteTime?: Date;

id?: string;

kind?: string;

kmsKeyName?: string;

md5Hash?: string;

mediaLink?: string;

metadata?: {

[key: string]: string;

};

metageneration?: bigint;

name?: string;

owner?: {

entity?: string;

entityId?: string;

};

retention?: {

mode?: string;

retainUntilTime?: Date;

};

retentionExpirationTime?: Date;

selfLink?: string;

size?: bigint;

softDeleteTime?: Date;

storageClass?: string;

temporaryHold?: boolean;

timeCreated?: Date;

timeDeleted?: Date;

timeStorageClassUpdated?: Date;

updated?: Date;

}

§Properties

acl?: ObjectAccessControl[]

[src]

Access controls on the object.

bucket?: string

[src]

The name of the bucket containing this object.

cacheControl?: string

[src]

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

[src]

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

contentDisposition?: string

[src]

Content-Disposition of the object data.

contentEncoding?: string

[src]

Content-Encoding of the object data.

contentLanguage?: string

[src]

Content-Language of the object data.

contentType?: string

[src]

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

crc32c?: string

[src]

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?: {

encryptionAlgorithm?: string;

keySha256?: string;

}

[src]

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

customTime?: Date

[src]

A timestamp in RFC 3339 format specified by the user for an object.

etag?: string

[src]

HTTP 1.1 Entity tag for the object.

eventBasedHold?: boolean

[src]

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?: bigint

[src]

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

hardDeleteTime?: Date

[src]

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.

id?: string

[src]

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

kind?: string

[src]

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

kmsKeyName?: string

[src]

Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.

md5Hash?: string

[src]

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

mediaLink?: string

[src]

Media download link.

metadata?: {

[key: string]: string;

}

[src]

User-provided metadata, in key/value pairs.

metageneration?: bigint

[src]

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?: string

[src]

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

owner?: {

entity?: string;

entityId?: string;

}

[src]

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

retention?: {

mode?: string;

retainUntilTime?: Date;

}

[src]

A collection of object level retention parameters.

retentionExpirationTime?: Date

[src]

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?: string

[src]

The link to this object.

size?: bigint

[src]

Content-Length of the data in bytes.

softDeleteTime?: Date

[src]

The time at which the object became soft-deleted in RFC 3339 format.

storageClass?: string

[src]

Storage class of the object.

temporaryHold?: boolean

[src]

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?: Date

[src]

The creation time of the object in RFC 3339 format.

timeDeleted?: Date

[src]

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?: Date

[src]

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?: Date

[src]

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.