BucketObject class

Stores a new object and metadata.

Constructors

BucketObject(String name, {BucketObjectArgs? args, CustomResourceOptions? options})

Creates a new BucketObject. name The Pulumi resource name. args Arguments used to configure this BucketObject. The set of arguments for BucketObject. options Resource options controlling this resource's behavior.

Properties

acl ↔ Output<List<Map<String, dynamic>>>

Access controls on the object.

late, final

bucket ↔ Output<String>

late, final

cacheControl ↔ Output<String>

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.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

componentCount ↔ Output<int>

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

late, final

contentDisposition ↔ Output<String>

Content-Disposition of the object data.

late, final

contentEncoding ↔ Output<String>

If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.

late, final

contentLanguage ↔ Output<String>

Content-Language of the object data.

late, final

contentType ↔ Output<String>

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

late, final

crc32c ↔ Output<String>

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.

late, final

customerEncryption ↔ Output<BucketObjectCustomerEncryptionResponse>

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

late, final

customTime ↔ Output<String>

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

late, final

etag ↔ Output<String>

HTTP 1.1 Entity tag for the object.

late, final

eventBasedHold ↔ Output<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). 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.

late, final

generation ↔ Output<String>

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

late, final

hardDeleteTime ↔ Output<String>

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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

ifGenerationMatch ↔ Output<String?>

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.

late, final

ifGenerationNotMatch ↔ Output<String?>

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.

late, final

ifMetagenerationMatch ↔ Output<String?>

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

late, final

ifMetagenerationNotMatch ↔ Output<String?>

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

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

kind ↔ Output<String>

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

late, final

kmsKeyName ↔ Output<String>

Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.

late, final

md5Hash ↔ Output<String>

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

late, final

mediaLink ↔ Output<String>

Media download link.

late, final

metadata ↔ Output<Map<String, String>>

User-provided metadata, in key/value pairs.

late, final

metageneration ↔ Output<String>

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.

late, final

name ↔ Output<String>

Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

late, final

owner ↔ Output<BucketObjectOwnerResponse>

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

late, final

predefinedAcl ↔ Output<String?>

Apply a predefined set of access controls to this object.

late, final

projection ↔ Output<String?>

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

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

retention ↔ Output<BucketObjectRetentionResponse>

A collection of object level retention parameters.

late, final

retentionExpirationTime ↔ Output<String>

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

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selfLink ↔ Output<String>

The link to this object.

late, final

size ↔ Output<String>

Content-Length of the data in bytes.

late, final

softDeleteTime ↔ Output<String>

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

late, final

storageClass ↔ Output<String>

Storage class of the object.

late, final

temporaryHold ↔ Output<bool>

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.

late, final

timeCreated ↔ Output<String>

The creation time of the object in RFC 3339 format.

late, final

timeDeleted ↔ Output<String>

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.

late, final

timeStorageClassUpdated ↔ Output<String>

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

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updated ↔ Output<String>

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.

late, final

urn ↔ Output<String>

late, final, inherited

userProject ↔ Output<String?>

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

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited