BucketObjectArgs

data class BucketObjectArgs(val acl: Output<List<ObjectAccessControlArgs>>? = null, val bucket: Output<String>? = null, val cacheControl: Output<String>? = null, val componentCount: Output<Int>? = null, val contentDisposition: Output<String>? = null, val contentEncoding: Output<String>? = null, val contentLanguage: Output<String>? = null, val contentType: Output<String>? = null, val crc32c: Output<String>? = null, val customTime: Output<String>? = null, val customerEncryption: Output<BucketObjectCustomerEncryptionArgs>? = null, val etag: Output<String>? = null, val eventBasedHold: Output<Boolean>? = null, val generation: Output<String>? = null, val id: Output<String>? = null, val ifGenerationMatch: Output<String>? = null, val ifGenerationNotMatch: Output<String>? = null, val ifMetagenerationMatch: Output<String>? = null, val ifMetagenerationNotMatch: Output<String>? = null, val kind: Output<String>? = null, val kmsKeyName: Output<String>? = null, val md5Hash: Output<String>? = null, val mediaLink: Output<String>? = null, val metadata: Output<Map<String, String>>? = null, val metageneration: Output<String>? = null, val name: Output<String>? = null, val owner: Output<BucketObjectOwnerArgs>? = null, val predefinedAcl: Output<String>? = null, val projection: Output<String>? = null, val retentionExpirationTime: Output<String>? = null, val selfLink: Output<String>? = null, val size: Output<String>? = null, val source: Output<AssetOrArchive>? = null, val storageClass: Output<String>? = null, val temporaryHold: Output<Boolean>? = null, val timeCreated: Output<String>? = null, val timeDeleted: Output<String>? = null, val timeStorageClassUpdated: Output<String>? = null, val updated: Output<String>? = null, val userProject: Output<String>? = null) : ConvertibleToJava<BucketObjectArgs>

Stores a new object and metadata.

Constructors

Link copied to clipboard
fun BucketObjectArgs(acl: Output<List<ObjectAccessControlArgs>>? = null, bucket: Output<String>? = null, cacheControl: Output<String>? = null, componentCount: Output<Int>? = null, contentDisposition: Output<String>? = null, contentEncoding: Output<String>? = null, contentLanguage: Output<String>? = null, contentType: Output<String>? = null, crc32c: Output<String>? = null, customTime: Output<String>? = null, customerEncryption: Output<BucketObjectCustomerEncryptionArgs>? = null, etag: Output<String>? = null, eventBasedHold: Output<Boolean>? = null, generation: Output<String>? = null, id: Output<String>? = null, ifGenerationMatch: Output<String>? = null, ifGenerationNotMatch: Output<String>? = null, ifMetagenerationMatch: Output<String>? = null, ifMetagenerationNotMatch: Output<String>? = null, kind: Output<String>? = null, kmsKeyName: Output<String>? = null, md5Hash: Output<String>? = null, mediaLink: Output<String>? = null, metadata: Output<Map<String, String>>? = null, metageneration: Output<String>? = null, name: Output<String>? = null, owner: Output<BucketObjectOwnerArgs>? = null, predefinedAcl: Output<String>? = null, projection: Output<String>? = null, retentionExpirationTime: Output<String>? = null, selfLink: Output<String>? = null, size: Output<String>? = null, source: Output<AssetOrArchive>? = null, storageClass: Output<String>? = null, temporaryHold: Output<Boolean>? = null, timeCreated: Output<String>? = null, timeDeleted: Output<String>? = null, timeStorageClassUpdated: Output<String>? = null, updated: Output<String>? = null, userProject: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): BucketObjectArgs

Properties

Link copied to clipboard
val acl: Output<List<ObjectAccessControlArgs>>? = null

Access controls on the object.

Link copied to clipboard
val bucket: Output<String>? = null

The name of the bucket containing this object.

Link copied to clipboard
val cacheControl: Output<String>? = null

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.

Link copied to clipboard
val componentCount: Output<Int>? = null

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

Link copied to clipboard
val contentDisposition: Output<String>? = null

Content-Disposition of the object data.

Link copied to clipboard
val contentEncoding: Output<String>? = null

Content-Encoding of the object data.

Link copied to clipboard
val contentLanguage: Output<String>? = null

Content-Language of the object data.

Link copied to clipboard
val contentType: Output<String>? = null

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

Link copied to clipboard
val crc32c: Output<String>? = null

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.

Link copied to clipboard

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

Link copied to clipboard
val customTime: Output<String>? = null

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

Link copied to clipboard
val etag: Output<String>? = null

HTTP 1.1 Entity tag for the object.

Link copied to clipboard
val eventBasedHold: Output<Boolean>? = null

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.

Link copied to clipboard
val generation: Output<String>? = null

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

Link copied to clipboard
val id: Output<String>? = null

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

Link copied to clipboard
val ifGenerationMatch: Output<String>? = null

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

Link copied to clipboard
val ifGenerationNotMatch: Output<String>? = null

Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

Link copied to clipboard
val ifMetagenerationMatch: Output<String>? = null

Makes the operation conditional on whether the object's current metageneration matches the given value.

Link copied to clipboard
val ifMetagenerationNotMatch: Output<String>? = null

Makes the operation conditional on whether the object's current metageneration does not match the given value.

Link copied to clipboard
val kind: Output<String>? = null

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

Link copied to clipboard
val kmsKeyName: Output<String>? = null

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

Link copied to clipboard
val md5Hash: Output<String>? = null

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

Link copied to clipboard
val mediaLink: Output<String>? = null

Media download link.

Link copied to clipboard
val metadata: Output<Map<String, String>>? = null

User-provided metadata, in key/value pairs.

Link copied to clipboard
val metageneration: Output<String>? = null

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.

Link copied to clipboard
val name: Output<String>? = null

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

Link copied to clipboard
val owner: Output<BucketObjectOwnerArgs>? = null

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

Link copied to clipboard
val predefinedAcl: Output<String>? = null

Apply a predefined set of access controls to this object.

Link copied to clipboard
val projection: Output<String>? = null

Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.

Link copied to clipboard
val retentionExpirationTime: Output<String>? = null

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).

Link copied to clipboard
val selfLink: Output<String>? = null

The link to this object.

Link copied to clipboard
val size: Output<String>? = null

Content-Length of the data in bytes.

Link copied to clipboard
val source: Output<AssetOrArchive>? = null
Link copied to clipboard
val storageClass: Output<String>? = null

Storage class of the object.

Link copied to clipboard
val temporaryHold: Output<Boolean>? = null

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.

Link copied to clipboard
val timeCreated: Output<String>? = null

The creation time of the object in RFC 3339 format.

Link copied to clipboard
val timeDeleted: Output<String>? = null

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.

Link copied to clipboard
val timeStorageClassUpdated: Output<String>? = null

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.

Link copied to clipboard
val updated: Output<String>? = null

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.

Link copied to clipboard
val userProject: Output<String>? = null

The project to be billed for this request. Required for Requester Pays buckets.