Skip to main content
← back to extensions

@swamp/gcp/storagetransfer

v2026.04.23.1

Google Cloud storagetransfer infrastructure models

Repository

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

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudstoragetransfercloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/storagetransfer

@swamp/gcp/storagetransfer/agentpoolsv2026.04.23.1agentpools.ts

Global Arguments

ArgumentTypeDescription
bandwidthLimit?objectSpecifies a bandwidth limit for an agent pool.
displayName?stringSpecifies the client-specified AgentPool description.
name?stringRequired. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}`
agentPoolId?stringRequired. The ID of the agent pool to create. The `agent_pool_id` must meet the following requirements: * Length of 128 characters or less. * Not start with the string `goog`. * Start with a lowercase ASCII character, followed by: * Zero or more: lowercase Latin alphabet characters, numerals, hyphens (`-`), periods (`.`), underscores (`_`), or tildes (`~`). * One or more numerals or lowercase ASCII characters. As expressed by the regular expression: `^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$`.
createCreate a agentPools
getGet a agentPools
ArgumentTypeDescription
identifierstringThe name of the agentPools
updateUpdate agentPools attributes
deleteDelete the agentPools
ArgumentTypeDescription
identifierstringThe name of the agentPools
syncSync agentPools state from GCP

Resources

state(infinite)— Represents an agent pool.
@swamp/gcp/storagetransfer/googleserviceaccountsv2026.04.23.1googleserviceaccounts.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a googleServiceAccounts
ArgumentTypeDescription
identifierstringThe name of the googleServiceAccounts
syncSync googleServiceAccounts state from GCP

Resources

state(infinite)— Google service account
@swamp/gcp/storagetransfer/transferjobsv2026.04.23.1transferjobs.ts

Global Arguments

ArgumentTypeDescription
description?stringA description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
eventStream?objectSpecifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.
latestOperationName?stringThe name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
loggingConfig?objectSpecifies the logging behavior for transfer operations. Logs can be sent to Cloud Logging for all transfer types. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details.
name?stringA unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service assigns a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. For transfers involvi
notificationConfig?objectSpecification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` contains a
projectId?stringRequired. The ID of the Google Cloud project that owns the job.
replicationSpec?objectSpecifies the configuration for a cross-bucket replication job. Cross-bucket replication copies new or updated objects from a source Cloud Storage bucket to a destination Cloud Storage bucket. Existing objects in the source bucket are not copied by a new cross-bucket replication job.
schedule?objectTransfers can be scheduled to recur or to run just once.
serviceAccount?stringOptional. The user-managed service account to which to delegate service agent permissions. You can grant Cloud Storage bucket permissions to this service account instead of to the Transfer Service service agent. Either the service account email (`SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com`) or the unique ID (`123456789012345678901`) are accepted. See https://docs.cloud.google.com/storage-transfer/docs/delegate-service-agent-permissions for required permissions.
status?enumStatus of the job. This value MUST be specified for `CreateTransferJobRequests`. **Note:** The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.
transferSpec?objectConfiguration for running a transfer.
transferJob?objectThis resource represents the configuration of a transfer job that runs periodically.
updateTransferJobFieldMask?stringThe field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: description, transfer_spec, notification_config, logging_config, and status. To update the `transfer_spec` of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT.
createCreate a transferJobs
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a transferJobs
ArgumentTypeDescription
identifierstringThe name of the transferJobs
updateUpdate transferJobs attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the transferJobs
ArgumentTypeDescription
identifierstringThe name of the transferJobs
syncSync transferJobs state from GCP
runrun
ArgumentTypeDescription
projectId?any

Resources

state(infinite)— This resource represents the configuration of a transfer job that runs period...