Class UpdateTransferJobRequest (1.3.1)

UpdateTransferJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request passed to UpdateTransferJob.

Attributes

NameDescription
job_name str
Required. The name of job to update.
project_id str
Required. The ID of the Google Cloud project that owns the job.
transfer_job google.cloud.storage_transfer_v1.types.TransferJob
Required. The job to update. transferJob is expected to specify one or more of five fields: description][google.storagetransfer.v1.TransferJob.description], transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec], notification_config][google.storagetransfer.v1.TransferJob.notification_config], logging_config][google.storagetransfer.v1.TransferJob.logging_config], and status][google.storagetransfer.v1.TransferJob.status]. An UpdateTransferJobRequest that specifies other fields are rejected with the error INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. Updating a job status to DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED] requires storagetransfer.jobs.delete permissions.
update_transfer_job_field_mask google.protobuf.field_mask_pb2.FieldMask
The field mask of the fields in transferJob that are to be updated in this request. Fields in transferJob that can be updated are: description][google.storagetransfer.v1.TransferJob.description], transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec], notification_config][google.storagetransfer.v1.TransferJob.notification_config], logging_config][google.storagetransfer.v1.TransferJob.logging_config], and status][google.storagetransfer.v1.TransferJob.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][google.rpc.Code.INVALID_ARGUMENT].