Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Note:The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).
Arguments
Parameters
jobName
string
Required. The name of job to update.
body
object ( UpdateTransferJobRequest
)
Required.
Raised exceptions
Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
Response
If successful, the response contains an instance of TransferJob
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation .
YAML
- patch : call : googleapis.storagetransfer.v1.transferJobs.patch args : jobName : ... body : projectId : ... transferJob : description : ... latestOperationName : ... loggingConfig : enableOnpremGcsTransferLogs : ... name : ... notificationConfig : eventTypes : ... payloadFormat : ... pubsubTopic : ... projectId : ... schedule : endTimeOfDay : hours : ... minutes : ... nanos : ... seconds : ... repeatInterval : ... scheduleEndDate : day : ... month : ... year : ... scheduleStartDate : ... startTimeOfDay : ... status : ... transferSpec : awsS3DataSource : awsAccessKey : accessKeyId : ... secretAccessKey : ... bucketName : ... path : ... roleArn : ... azureBlobStorageDataSource : azureCredentials : sasToken : ... container : ... path : ... storageAccount : ... gcsDataSink : bucketName : ... path : ... gcsDataSource : ... httpDataSource : listUrl : ... objectConditions : excludePrefixes : ... includePrefixes : ... lastModifiedBefore : ... lastModifiedSince : ... maxTimeElapsedSinceLastModification : ... minTimeElapsedSinceLastModification : ... posixDataSource : rootDirectory : ... transferOptions : deleteObjectsFromSourceAfterTransfer : ... deleteObjectsUniqueInSink : ... overwriteObjectsAlreadyExistingInSink : ... updateTransferJobFieldMask : ... result : patchResult
JSON
[ { "patch" : { "call" : "googleapis.storagetransfer.v1.transferJobs.patch" , "args" : { "jobName" : "..." , "body" : { "projectId" : "..." , "transferJob" : { "description" : "..." , "latestOperationName" : "..." , "loggingConfig" : { "enableOnpremGcsTransferLogs" : "..." }, "name" : "..." , "notificationConfig" : { "eventTypes" : "..." , "payloadFormat" : "..." , "pubsubTopic" : "..." }, "projectId" : "..." , "schedule" : { "endTimeOfDay" : { "hours" : "..." , "minutes" : "..." , "nanos" : "..." , "seconds" : "..." }, "repeatInterval" : "..." , "scheduleEndDate" : { "day" : "..." , "month" : "..." , "year" : "..." }, "scheduleStartDate" : "..." , "startTimeOfDay" : "..." }, "status" : "..." , "transferSpec" : { "awsS3DataSource" : { "awsAccessKey" : { "accessKeyId" : "..." , "secretAccessKey" : "..." }, "bucketName" : "..." , "path" : "..." , "roleArn" : "..." }, "azureBlobStorageDataSource" : { "azureCredentials" : { "sasToken" : "..." }, "container" : "..." , "path" : "..." , "storageAccount" : "..." }, "gcsDataSink" : { "bucketName" : "..." , "path" : "..." }, "gcsDataSource" : "..." , "httpDataSource" : { "listUrl" : "..." }, "objectConditions" : { "excludePrefixes" : "..." , "includePrefixes" : "..." , "lastModifiedBefore" : "..." , "lastModifiedSince" : "..." , "maxTimeElapsedSinceLastModification" : "..." , "minTimeElapsedSinceLastModification" : "..." }, "posixDataSource" : { "rootDirectory" : "..." }, "transferOptions" : { "deleteObjectsFromSourceAfterTransfer" : "..." , "deleteObjectsUniqueInSink" : "..." , "overwriteObjectsAlreadyExistingInSink" : "..." } } }, "updateTransferJobFieldMask" : "..." } }, "result" : "patchResult" } } ]
