Gcp/storage

@swamp/gcp/storagev2026.05.28.1· 6d agoMODELS

01README

Google Cloud storage infrastructure models

02Release Notes

Updated: buckets

03Models11

anywherecaches.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
admissionPolicy?	string	no	The cache-level entry admission policy.
anywhereCacheId?	string	no	The ID of the Anywhere cache instance.
bucket?	string	no	The name of the bucket containing this cache instance.
createTime?	string	no	The creation time of the cache instance in RFC 3339 format.
id?	string	no	The ID of the resource, including the project number, bucket name and anywhere cache ID.
ingestOnWrite?	boolean	no	Specifies whether objects are ingested into the cache upon write.
pendingUpdate?	boolean	no	True if the cache instance has an active Update long-running operation.
state?	string	no	The current state of the cache instance.
ttl?	string	no	The TTL of all cache entries in whole seconds. e.g., "7200s".
updateTime?	string	no	The modification time of the cache instance metadata in RFC 3339 format.
zone?	string	no	The zone in which the cache instance is running. For example, us-central1-a.

fn create()

Create a anywhereCaches

fn get(identifier: string)

Get a anywhereCaches

Argument	Type	Required	Description
identifier	string	yes	The name of the anywhereCaches

fn update()

Update anywhereCaches attributes

fn sync()

Sync anywhereCaches state from GCP

fn list(pageSize?: number, maxPages?: number)

List anywhereCaches resources

Argument	Type	Required	Description
pageSize?	number	no	Maximum number of items to return in a single page of responses. Maximum 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn disable()

disable

fn pause()

pause

fn resume()

resume

bucketaccesscontrols.tsv2026.05.25.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
bucket?	string	no	The name of the bucket.
domain?	string	no	The domain associated with the entity, if any.
email?	string	no	The email address associated with the entity, if any.
entity	string	yes	The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - project-team-projectId - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
entityId?	string	no	The ID for the entity, if any.
id?	string	no	The ID of the access-control entry.
projectTeam?	object	no	The project number.
role	string	yes	The access permission for the entity.
userProject?	string	no	The project to be billed for this request. Required for Requester Pays buckets.

fn create()

Create a bucketAccessControls

fn get(identifier: string)

Get a bucketAccessControls

Argument	Type	Required	Description
identifier	string	yes	The name of the bucketAccessControls

fn update()

Update bucketAccessControls attributes

fn delete(identifier: string)

Delete the bucketAccessControls

Argument	Type	Required	Description
identifier	string	yes	The name of the bucketAccessControls

fn sync()

Sync bucketAccessControls state from GCP

fn list(userProject?: string, maxPages?: number)

List bucketAccessControls resources

Argument	Type	Required	Description
userProject?	string	no	The project to be billed for this request. Required for Requester Pays buckets.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

buckets.tsv2026.05.28.1

Global Arguments

Argument	Type	Required	Description
acl?	array	no	The name of the bucket.
autoclass?	object	no	Whether or not Autoclass is enabled on this bucket
billing?	object	no	When set to true, Requester Pays is enabled for this bucket.
cors?	array	no	The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
customPlacementConfig?	object	no	The list of regional locations in which data is placed.
defaultEventBasedHold?	boolean	no	The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, 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 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. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
defaultObjectAcl?	array	no	The name of the bucket.
encryption?	object	no	Server-determined value that indicates the time from which configuration was enforced and effective. This value is in RFC 3339 format.
generation?	string	no	The generation of this bucket.
hardDeleteTime?	string	no	The hard delete time of the bucket in RFC 3339 format.
hierarchicalNamespace?	object	no	When set to true, hierarchical namespace is enabled for this bucket.
iamConfiguration?	object	no	If set, access is controlled only by bucket-level or above IAM policies.
id?	string	no	The ID of the bucket. For buckets, the id and name properties are the same.
ipFilter?	object	no	Whether to allow all service agents to access the bucket regardless of the IP filter configuration.
labels?	record	no	User-provided labels, in key/value pairs.
lifecycle?	object	no	Target storage class. Required iff the type of the action is SetStorageClass.
location?	string	no	The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the [Developer's Guide](https://cloud.google.com/storage/docs/locations) for the authoritative list.
locationType?	string	no	The type of the bucket location.
logging?	object	no	The destination bucket where the current bucket's logs should be placed.
metageneration?	string	no	The metadata generation of this bucket.
name	string	yes	The name of the bucket.
objectRetention?	object	no	The bucket's object retention mode. Can be Enabled.
owner?	object	no	The entity, in the form project-owner-projectId.
projectNumber?	string	no	The project number of the project the bucket belongs to.
retentionPolicy?	object	no	Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
rpo?	string	no	The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
satisfiesPZI?	boolean	no	Reserved for future use.
satisfiesPZS?	boolean	no	Reserved for future use.
softDeletePolicy?	object	no	Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format.
softDeleteTime?	string	no	The soft delete time of the bucket in RFC 3339 format.
storageClass?	string	no	The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes).
timeCreated?	string	no	The creation time of the bucket in RFC 3339 format.
updated?	string	no	The modification time of the bucket in RFC 3339 format.
versioning?	object	no	While set to true, versioning is fully enabled for this bucket.
website?	object	no	If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
enableObjectRetention?	string	no	When set to true, object retention is enabled for this bucket.
predefinedAcl?	string	no	Apply a predefined set of access controls to this bucket.
predefinedDefaultObjectAcl?	string	no	Apply a predefined set of default object access controls to this bucket.
project?	string	no	A valid API project identifier.
projection?	string	no	Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
userProject?	string	no	The project to be billed for this request.

fn create()

Create a buckets

fn get(identifier: string)

Get a buckets

Argument	Type	Required	Description
identifier	string	yes	The name of the buckets

fn update()

Update buckets attributes

fn delete(identifier: string)

Delete the buckets

Argument	Type	Required	Description
identifier	string	yes	The name of the buckets

fn sync()

Sync buckets state from GCP

fn list(maxResults?: number, prefix?: string, project?: string, projection?: string, returnPartialSuccess?: boolean, softDeleted?: boolean, userProject?: string, maxPages?: number)

List buckets resources

Argument	Type	Required	Description
maxResults?	number	no	Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
prefix?	string	no	Filter results to buckets whose names begin with this prefix.
project?	string	no	A valid API project identifier.
projection?	string	no	Set of properties to return. Defaults to noAcl.
returnPartialSuccess?	boolean	no	If true, return a list of bucket resource names for buckets that are in unreachable locations.
softDeleted?	boolean	no	If true, only soft-deleted bucket versions will be returned. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).
userProject?	string	no	The project to be billed for this request.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy()

get iam policy

fn get_storage_layout()

get storage layout

fn lock_retention_policy()

lock retention policy

fn relocate(destinationCustomPlacementConfig?: any, destinationKmsKeyName?: any, destinationLocation?: any, validateOnly?: any)

relocate

Argument	Type	Required
destinationCustomPlacementConfig?	any	no
destinationKmsKeyName?	any	no
destinationLocation?	any	no
validateOnly?	any	no

fn restore()

restore

fn set_iam_policy(bindings?: any, etag?: any, kind?: any, resourceId?: any, version?: any)

set iam policy

Argument	Type	Required
bindings?	any	no
etag?	any	no
kind?	any	no
resourceId?	any	no
version?	any	no

fn test_iam_permissions()

test iam permissions

defaultobjectaccesscontrols.tsv2026.05.25.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
bucket?	string	no	The name of the bucket.
domain?	string	no	The domain associated with the entity, if any.
email?	string	no	The email address associated with the entity, if any.
entity	string	yes	The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - project-team-projectId - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
entityId?	string	no	The ID for the entity, if any.
generation?	string	no	The content generation of the object, if applied to an object.
id?	string	no	The ID of the access-control entry.
object?	string	no	The name of the object, if applied to an object.
projectTeam?	object	no	The project number.
role	string	yes	The access permission for the entity.
userProject?	string	no	The project to be billed for this request. Required for Requester Pays buckets.

fn create()

Create a defaultObjectAccessControls

fn get(identifier: string)

Get a defaultObjectAccessControls

Argument	Type	Required	Description
identifier	string	yes	The name of the defaultObjectAccessControls

fn update()

Update defaultObjectAccessControls attributes

fn delete(identifier: string)

Delete the defaultObjectAccessControls

Argument	Type	Required	Description
identifier	string	yes	The name of the defaultObjectAccessControls

fn sync()

Sync defaultObjectAccessControls state from GCP

fn list(ifMetagenerationMatch?: string, ifMetagenerationNotMatch?: string, userProject?: string, maxPages?: number)

List defaultObjectAccessControls resources

Argument	Type	Required	Description
ifMetagenerationMatch?	string	no	If present, only return default ACL listing if the bucket's current metageneration matches this value.
ifMetagenerationNotMatch?	string	no	If present, only return default ACL listing if the bucket's current metageneration does not match the given value.
userProject?	string	no	The project to be billed for this request. Required for Requester Pays buckets.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

folders.tsv2026.05.25.1

Global Arguments

Argument	Type	Required	Description
bucket?	string	no	The name of the bucket containing this folder.
createTime?	string	no	The creation time of the folder in RFC 3339 format.
id?	string	no	The ID of the folder, including the bucket name, folder name.
metageneration?	string	no	The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.
name?	string	no	The name of the folder. Required if not specified by URL parameter.
pendingRenameInfo?	object	no	The ID of the rename folder operation.
updateTime?	string	no	The modification time of the folder metadata in RFC 3339 format.
recursive?	string	no	If true, any parent folder which doesn't exist will be created automatically.

fn create()

Create a folders

fn get(identifier: string)

Get a folders

Argument	Type	Required	Description
identifier	string	yes	The name of the folders

fn delete(identifier: string)

Delete the folders

Argument	Type	Required	Description
identifier	string	yes	The name of the folders

fn sync()

Sync folders state from GCP

fn list(delimiter?: string, endOffset?: string, pageSize?: number, prefix?: string, startOffset?: string, maxPages?: number)

List folders resources

Argument	Type	Required	Description
delimiter?	string	no	Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.
endOffset?	string	no	Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
pageSize?	number	no	Maximum number of items to return in a single page of responses.
prefix?	string	no	Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.
startOffset?	string	no	Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn rename()

rename

hmackeys.tsv2026.05.25.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessId?	string	no	The ID of the HMAC Key.
etag?	string	no	HTTP 1.1 Entity tag for the HMAC key.
id?	string	no	The ID of the HMAC key, including the Project ID and the Access ID.
kind?	string	no	The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
projectId?	string	no	Project ID owning the service account to which the key authenticates.
selfLink?	string	no	The link to this resource.
serviceAccountEmail?	string	no	The email address of the key's associated service account.
state?	string	no	The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
timeCreated?	string	no	The creation time of the HMAC key in RFC 3339 format.
updated?	string	no	The last modification time of the HMAC key metadata in RFC 3339 format.
userProject?	string	no	The project to be billed for this request.

fn create()

Create a hmacKeys

fn get(identifier: string)

Get a hmacKeys

Argument	Type	Required	Description
identifier	string	yes	The name of the hmacKeys

fn update()

Update hmacKeys attributes

fn delete(identifier: string)

Delete the hmacKeys

Argument	Type	Required	Description
identifier	string	yes	The name of the hmacKeys

fn sync()

Sync hmacKeys state from GCP

fn list(maxResults?: number, serviceAccountEmail?: string, showDeletedKeys?: boolean, userProject?: string, maxPages?: number)

List hmacKeys resources

Argument	Type	Required	Description
maxResults?	number	no	Maximum number of items to return in a single page of responses. The service uses this parameter or 250 items, whichever is smaller. The max number of items per page will also be limited by the number of distinct service accounts in the response. If the number of service accounts in a single response is too high, the page will truncated and a next page token will be returned.
serviceAccountEmail?	string	no	If present, only keys for the given service account are returned.
showDeletedKeys?	boolean	no	Whether or not to show keys in the DELETED state.
userProject?	string	no	The project to be billed for this request.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

managedfolders.tsv2026.05.25.1

Global Arguments

Argument	Type	Required	Description
bucket?	string	no	The name of the bucket containing this managed folder.
createTime?	string	no	The creation time of the managed folder in RFC 3339 format.
id?	string	no	The ID of the managed folder, including the bucket name and managed folder name.
metageneration?	string	no	The version of the metadata for this managed folder. Used for preconditions and for detecting changes in metadata.
name?	string	no	The name of the managed folder. Required if not specified by URL parameter.
updateTime?	string	no	The last update time of the managed folder metadata in RFC 3339 format.

fn create()

Create a managedFolders

fn get(identifier: string)

Get a managedFolders

Argument	Type	Required	Description
identifier	string	yes	The name of the managedFolders

fn delete(identifier: string)

Delete the managedFolders

Argument	Type	Required	Description
identifier	string	yes	The name of the managedFolders

fn sync()

Sync managedFolders state from GCP

fn list(pageSize?: number, prefix?: string, maxPages?: number)

List managedFolders resources

Argument	Type	Required	Description
pageSize?	number	no	Maximum number of items to return in a single page of responses.
prefix?	string	no	The managed folder name/path prefix to filter the output list of results.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy()

get iam policy

fn set_iam_policy(bindings?: any, etag?: any, kind?: any, resourceId?: any, version?: any)

set iam policy

Argument	Type	Required
bindings?	any	no
etag?	any	no
kind?	any	no
resourceId?	any	no
version?	any	no

fn test_iam_permissions()

test iam permissions

notifications.tsv2026.05.25.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
custom_attributes?	record	no	An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.
event_types?	array	no	If present, only send notifications about listed event types. If empty, sent notifications for all event types.
id?	string	no	The ID of the notification.
object_name_prefix?	string	no	If present, only apply this notification configuration to object names that begin with this prefix.
payload_format	string	yes	The desired content of the Payload.
topic	string	yes	The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
bucket	string	yes	The parent bucket of the notification.
userProject?	string	no	The project to be billed for this request. Required for Requester Pays buckets.

fn create()

Create a notifications

fn get(identifier: string)

Get a notifications

Argument	Type	Required	Description
identifier	string	yes	The name of the notifications

fn delete(identifier: string)

Delete the notifications

Argument	Type	Required	Description
identifier	string	yes	The name of the notifications

fn sync()

Sync notifications state from GCP

fn list(userProject?: string, maxPages?: number)

List notifications resources

Argument	Type	Required	Description
userProject?	string	no	The project to be billed for this request. Required for Requester Pays buckets.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

objectaccesscontrols.tsv2026.05.25.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
bucket?	string	no	The name of the bucket.
domain?	string	no	The domain associated with the entity, if any.
email?	string	no	The email address associated with the entity, if any.
entity	string	yes	The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - project-team-projectId - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
entityId?	string	no	The ID for the entity, if any.
generation?	string	no	The content generation of the object, if applied to an object.
id?	string	no	The ID of the access-control entry.
object?	string	no	The name of the object, if applied to an object.
projectTeam?	object	no	The project number.
role	string	yes	The access permission for the entity.
userProject?	string	no	The project to be billed for this request. Required for Requester Pays buckets.

fn create()

Create a objectAccessControls

fn get(identifier: string)

Get a objectAccessControls

Argument	Type	Required	Description
identifier	string	yes	The name of the objectAccessControls

fn update()

Update objectAccessControls attributes

fn delete(identifier: string)

Delete the objectAccessControls

Argument	Type	Required	Description
identifier	string	yes	The name of the objectAccessControls

fn sync()

Sync objectAccessControls state from GCP

fn list(generation?: string, userProject?: string, maxPages?: number)

List objectAccessControls resources

Argument	Type	Required	Description
generation?	string	no	If present, selects a specific revision of this object (as opposed to the latest version, the default).
userProject?	string	no	The project to be billed for this request. Required for Requester Pays buckets.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

objects.tsv2026.05.25.1

Global Arguments

Argument	Type	Required	Description
acl?	array	no	The name of the bucket.
bucket?	string	no	The name of the bucket containing this object.
cacheControl?	string	no	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	no	Number of underlying components that make up this object. Components are accumulated by compose operations.
contentDisposition?	string	no	Content-Disposition of the object data.
contentEncoding?	string	no	Content-Encoding of the object data.
contentLanguage?	string	no	Content-Language of the object data.
contentType?	string	no	Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
contexts?	object	no	The time at which the object context was created in RFC 3339 format.
crc32c?	string	no	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 [Data Validation and Change Detection](https://cloud.google.com/storage/docs/data-validation).
customTime?	string	no	A timestamp in RFC 3339 format specified by the user for an object.
customerEncryption?	object	no	The encryption algorithm.
eventBasedHold?	boolean	no	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?	string	no	The content generation of this object. Used for object versioning.
hardDeleteTime?	string	no	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	no	The ID of the object, including the bucket name, object name, and generation number.
kmsKeyName?	string	no	Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
md5Hash?	string	no	MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see [Data Validation and Change Detection](https://cloud.google.com/storage/docs/data-validation).
mediaLink?	string	no	Media download link.
metadata?	record	no	User-provided metadata, in key/value pairs.
metageneration?	string	no	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	no	The name of the object. Required if not specified by URL parameter.
owner?	object	no	The entity, in the form user-userId.
restoreToken?	string	no	Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.
retention?	object	no	The bucket's object retention mode, can only be Unlocked or Locked.
retentionExpirationTime?	string	no	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).
size?	string	no	Content-Length of the data in bytes.
softDeleteTime?	string	no	The time at which the object became soft-deleted in RFC 3339 format.
storageClass?	string	no	Storage class of the object.
temporaryHold?	boolean	no	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?	string	no	The creation time of the object in RFC 3339 format.
timeDeleted?	string	no	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.
timeFinalized?	string	no	The time when the object was finalized.
timeStorageClassUpdated?	string	no	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?	string	no	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.
ifGenerationMatch?	string	no	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.
ifGenerationNotMatch?	string	no	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.
ifMetagenerationMatch?	string	no	Makes the operation conditional on whether the object's current metageneration matches the given value.
ifMetagenerationNotMatch?	string	no	Makes the operation conditional on whether the object's current metageneration does not match the given value.
predefinedAcl?	string	no	Apply a predefined set of access controls to this object.
projection?	string	no	Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
userProject?	string	no	The project to be billed for this request. Required for Requester Pays buckets.

fn create()

Create a objects

fn get(identifier: string)

Get a objects

Argument	Type	Required	Description
identifier	string	yes	The name of the objects

fn update()

Update objects attributes

fn delete(identifier: string)

Delete the objects

Argument	Type	Required	Description
identifier	string	yes	The name of the objects

fn sync()

Sync objects state from GCP

fn list(delimiter?: string, endOffset?: string, filter?: string, includeFoldersAsPrefixes?: boolean, includeTrailingDelimiter?: boolean, matchGlob?: string, maxResults?: number, prefix?: string, projection?: string, softDeleted?: boolean, startOffset?: string, userProject?: string, versions?: boolean, maxPages?: number)

List objects resources

Argument	Type	Required	Description
delimiter?	string	no	Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
endOffset?	string	no	Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
filter?	string	no	Filter the returned objects. Currently only supported for the contexts field. If delimiter is set, the returned prefixes are exempt from this filter.
includeFoldersAsPrefixes?	boolean	no	Only applicable if delimiter is set to '/'. If true, will also include folders and managed folders (besides objects) in the returned prefixes.
includeTrailingDelimiter?	boolean	no	If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
matchGlob?	string	no	Filter results to objects and prefixes that match this glob pattern.
maxResults?	number	no	Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
prefix?	string	no	Filter results to objects whose names begin with this prefix.
projection?	string	no	Set of properties to return. Defaults to noAcl.
softDeleted?	boolean	no	If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).
startOffset?	string	no	Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
userProject?	string	no	The project to be billed for this request. Required for Requester Pays buckets.
versions?	boolean	no	If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning).
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn bulk_restore(allowOverwrite?: any, copySourceAcl?: any, createdAfterTime?: any, createdBeforeTime?: any, matchGlobs?: any, softDeletedAfterTime?: any, softDeletedBeforeTime?: any)

bulk restore

Argument	Type	Required
allowOverwrite?	any	no
copySourceAcl?	any	no
createdAfterTime?	any	no
createdBeforeTime?	any	no
matchGlobs?	any	no
softDeletedAfterTime?	any	no
softDeletedBeforeTime?	any	no

fn compose(deleteSourceObjects?: any, destination?: any, kind?: any, sourceObjects?: any)

compose

Argument	Type	Required
deleteSourceObjects?	any	no
destination?	any	no
kind?	any	no
sourceObjects?	any	no

fn copy(acl?: any, bucket?: any, cacheControl?: any, componentCount?: any, contentDisposition?: any, contentEncoding?: any, contentLanguage?: any, contentType?: any, contexts?: any, crc32c?: any, customTime?: any, customerEncryption?: any, etag?: any, eventBasedHold?: any, generation?: any, hardDeleteTime?: any, id?: any, kind?: any, kmsKeyName?: any, md5Hash?: any, mediaLink?: any, metadata?: any, metageneration?: any, name?: any, owner?: any, restoreToken?: any, retention?: any, retentionExpirationTime?: any, selfLink?: any, size?: any, softDeleteTime?: any, storageClass?: any, temporaryHold?: any, timeCreated?: any, timeDeleted?: any, timeFinalized?: any, timeStorageClassUpdated?: any, updated?: any)

copy

Argument	Type	Required
acl?	any	no
bucket?	any	no
cacheControl?	any	no
componentCount?	any	no
contentDisposition?	any	no
contentEncoding?	any	no
contentLanguage?	any	no
contentType?	any	no
contexts?	any	no
crc32c?	any	no
customTime?	any	no
customerEncryption?	any	no
etag?	any	no
eventBasedHold?	any	no
generation?	any	no
hardDeleteTime?	any	no
id?	any	no
kind?	any	no
kmsKeyName?	any	no
md5Hash?	any	no
mediaLink?	any	no
metadata?	any	no
metageneration?	any	no
name?	any	no
owner?	any	no
restoreToken?	any	no
retention?	any	no
retentionExpirationTime?	any	no
selfLink?	any	no
size?	any	no
softDeleteTime?	any	no
storageClass?	any	no
temporaryHold?	any	no
timeCreated?	any	no
timeDeleted?	any	no
timeFinalized?	any	no
timeStorageClassUpdated?	any	no
updated?	any	no

fn get_iam_policy()

get iam policy

fn move()

move

fn restore(allowOverwrite?: any, copySourceAcl?: any, createdAfterTime?: any, createdBeforeTime?: any, matchGlobs?: any, softDeletedAfterTime?: any, softDeletedBeforeTime?: any)

restore

Argument	Type	Required
allowOverwrite?	any	no
copySourceAcl?	any	no
createdAfterTime?	any	no
createdBeforeTime?	any	no
matchGlobs?	any	no
softDeletedAfterTime?	any	no
softDeletedBeforeTime?	any	no

fn rewrite(acl?: any, bucket?: any, cacheControl?: any, componentCount?: any, contentDisposition?: any, contentEncoding?: any, contentLanguage?: any, contentType?: any, contexts?: any, crc32c?: any, customTime?: any, customerEncryption?: any, etag?: any, eventBasedHold?: any, generation?: any, hardDeleteTime?: any, id?: any, kind?: any, kmsKeyName?: any, md5Hash?: any, mediaLink?: any, metadata?: any, metageneration?: any, name?: any, owner?: any, restoreToken?: any, retention?: any, retentionExpirationTime?: any, selfLink?: any, size?: any, softDeleteTime?: any, storageClass?: any, temporaryHold?: any, timeCreated?: any, timeDeleted?: any, timeFinalized?: any, timeStorageClassUpdated?: any, updated?: any)

rewrite

Argument	Type	Required
acl?	any	no
bucket?	any	no
cacheControl?	any	no
componentCount?	any	no
contentDisposition?	any	no
contentEncoding?	any	no
contentLanguage?	any	no
contentType?	any	no
contexts?	any	no
crc32c?	any	no
customTime?	any	no
customerEncryption?	any	no
etag?	any	no
eventBasedHold?	any	no
generation?	any	no
hardDeleteTime?	any	no
id?	any	no
kind?	any	no
kmsKeyName?	any	no
md5Hash?	any	no
mediaLink?	any	no
metadata?	any	no
metageneration?	any	no
name?	any	no
owner?	any	no
restoreToken?	any	no
retention?	any	no
retentionExpirationTime?	any	no
selfLink?	any	no
size?	any	no
softDeleteTime?	any	no
storageClass?	any	no
temporaryHold?	any	no
timeCreated?	any	no
timeDeleted?	any	no
timeFinalized?	any	no
timeStorageClassUpdated?	any	no
updated?	any	no

fn set_iam_policy(bindings?: any, etag?: any, kind?: any, resourceId?: any, version?: any)

set iam policy

Argument	Type	Required
bindings?	any	no
etag?	any	no
kind?	any	no
resourceId?	any	no
version?	any	no

fn test_iam_permissions()

test iam permissions

fn watch_all(address?: any, expiration?: any, id?: any, kind?: any, params?: any, payload?: any, resourceId?: any, resourceUri?: any, token?: any, type?: any)

watch all

Argument	Type	Required
address?	any	no
expiration?	any	no
id?	any	no
kind?	any	no
params?	any	no
payload?	any	no
resourceId?	any	no
resourceUri?	any	no
token?	any	no
type?	any	no

serviceaccount.tsv2026.05.25.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

fn get(identifier: string)

Get a serviceAccount

Argument	Type	Required	Description
identifier	string	yes	The name of the serviceAccount

fn sync()

Sync serviceAccount state from GCP

04Previous Versions16

2026.05.26.1May 26, 2026

Updated: anywherecaches

2026.05.25.2May 25, 2026

Updated: buckets, hmackeys

2026.05.22.2May 22, 2026

Updated: buckets

2026.05.21.2May 21, 2026

Updated: anywherecaches, bucketaccesscontrols, buckets, defaultobjectaccesscontrols, folders, managedfolders, notifications, objectaccesscontrols, objects, hmackeys, serviceaccount

2026.05.21.1May 21, 2026

2026.05.20.1May 20, 2026

Updated: anywherecaches

2026.05.19.2May 19, 2026

2026.05.19.1May 19, 2026

2026.05.18.2May 18, 2026

Modified 1 models

2026.04.23.1Apr 23, 2026

2026.04.13.1Apr 13, 2026

Updated: anywherecaches

Modified 1 models

2026.04.04.1Apr 4, 2026

Updated: buckets

2026.04.03.3Apr 3, 2026

Updated: anywherecaches, bucketaccesscontrols, buckets, defaultobjectaccesscontrols, folders, managedfolders, notifications, objectaccesscontrols, objects, hmackeys, serviceaccount

2026.04.03.1Apr 3, 2026

Updated: anywherecaches, bucketaccesscontrols, buckets, defaultobjectaccesscontrols, folders, managedfolders, notifications, objectaccesscontrols, objects, hmackeys, serviceaccount

2026.04.02.2Apr 2, 2026

Modified 1 models

2026.03.27.1Mar 27, 2026

Added: anywherecaches, bucketaccesscontrols, buckets, defaultobjectaccesscontrols, folders, managedfolders, notifications, objectaccesscontrols, objects, hmackeys, serviceaccount

05Stats

100 / 100

Downloads

Archive size

150.9 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/systeminit/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#gcp #google-cloud #storage #cloud #infrastructure