v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13154269.2 KB
transferJobs

Creates a transfer job that runs periodically.

post/v1/transferJobs

Request body

deletionTimestring google-datetime

Output only. The time that the transfer job was deleted.

latestOperationNamestring

The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.

projectIdstring

The ID of the Google Cloud project that owns the job.

serviceAccountstring

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

lastModificationTimestring google-datetime

Output only. The time that the transfer job was last modified.

namestring

A 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 involving PosixFilesystem, this name must start with transferJobs/OPI specifically. For all other transfer types, this name must not start with transferJobs/OPI. Non-PosixFilesystem example: "transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$" PosixFilesystem example: "transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$" Applications must not rely on the enforcement of naming requirements involving OPI. Invalid job names fail with an INVALID_ARGUMENT error.

status'STATUS_UNSPECIFIED' | 'ENABLED' | 'DISABLED' | 'DELETED'

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

descriptionstring

A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.

creationTimestring google-datetime

Output only. The time that the transfer job was created.

Response

Successful response