Struct BucketObjectArgs

pub struct BucketObjectArgs {

    pub bucket: Output<String>,
    pub cache_control: Output<Option<String>>,
    pub content: Output<Option<String>>,
    pub content_disposition: Output<Option<String>>,
    pub content_encoding: Output<Option<String>>,
    pub content_language: Output<Option<String>>,
    pub content_type: Output<Option<String>>,
    pub customer_encryption: Output<Option<BucketObjectCustomerEncryption>>,
    pub detect_md5hash: Output<Option<String>>,
    pub event_based_hold: Output<Option<bool>>,
    pub kms_key_name: Output<Option<String>>,
    pub metadata: Output<Option<HashMap<String, String>>>,
    pub name: Output<Option<String>>,
    pub retention: Output<Option<BucketObjectRetention>>,
    pub source: Output<Option<String>>,
    pub storage_class: Output<Option<String>>,
    pub temporary_hold: Output<Option<bool>>,
}

Fields

bucket: Output<String>

The name of the containing bucket.

cache_control: Output<Option<String>>

Cache-Control directive to specify caching behavior of object data. If omitted and object is accessible to all anonymous users, the default will be public, max-age=3600

content: Output<Option<String>>

Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive.

content_disposition: Output<Option<String>>

Content-Disposition of the object data.

content_encoding: Output<Option<String>>

Content-Encoding of the object data.

content_language: Output<Option<String>>

Content-Language of the object data.

content_type: Output<Option<String>>

Content-Type of the object data. Defaults to “application/octet-stream” or “text/plain; charset=utf-8”.

customer_encryption: Output<Option<BucketObjectCustomerEncryption>>

Enables object encryption with Customer-Supplied Encryption Key (CSEK). Google documentation about CSEK. Structure is documented below.

detect_md5hash: Output<Option<String>>

event_based_hold: Output<Option<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).

kms_key_name: Output<Option<String>>

The resource name of the Cloud KMS key that will be used to encrypt the object.

metadata: Output<Option<HashMap<String, String>>>

User-provided metadata, in key/value pairs.

One of the following is required:

name: Output<Option<String>>

The name of the object. If you’re interpolating the name of this object, see output_name instead.

retention: Output<Option<BucketObjectRetention>>

The object retention settings for the object. The retention settings allow an object to be retained until a provided date. Structure is documented below.

source: Output<Option<String>>

A path to the data you want to upload. Must be defined if content is not.

---

storage_class: Output<Option<String>>

The StorageClass of the new bucket object. Supported values include: MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE. If not provided, this defaults to the bucket’s default storage class or to a standard class.

temporary_hold: Output<Option<bool>>

Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites.

Implementations

impl BucketObjectArgs

pub fn builder() -> BucketObjectArgsBuilder

Create an instance of BucketObjectArgs using the builder syntax

Trait Implementations

impl Clone for BucketObjectArgs

fn clone(&self) -> BucketObjectArgs

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.