Storage Transfer v1 API - Class UpdateTransferJobRequest (2.5.0)

public sealed class UpdateTransferJobRequest : IMessage<UpdateTransferJobRequest>, IEquatable<UpdateTransferJobRequest>, IDeepCloneable<UpdateTransferJobRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Storage Transfer v1 API class UpdateTransferJobRequest.

Request passed to UpdateTransferJob.

Inheritance

object > UpdateTransferJobRequest

Implements

IMessage UpdateTransferJobRequest, IEquatable UpdateTransferJobRequest, IDeepCloneable UpdateTransferJobRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.StorageTransfer.V1

Assembly

Google.Cloud.StorageTransfer.V1.dll

Constructors

UpdateTransferJobRequest()

public UpdateTransferJobRequest()

UpdateTransferJobRequest(UpdateTransferJobRequest)

public UpdateTransferJobRequest(UpdateTransferJobRequest other)

Parameter
Name	Description
`other`	`UpdateTransferJobRequest`

Properties

JobName

public string JobName { get; set; }

Required. The name of job to update.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; set; }

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

Property Value
Type	Description
`string`

TransferJob

public TransferJob TransferJob { get; set; }

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

Property Value
Type	Description
`TransferJob`

UpdateTransferJobFieldMask

public FieldMask UpdateTransferJobFieldMask { get; set; }

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

Property Value
Type	Description
`FieldMask`