Struct google_api_proto::google::storagetransfer::v1::UpdateTransferJobRequest

pub struct UpdateTransferJobRequest {
    pub job_name: String,
    pub project_id: String,
    pub transfer_job: Option<TransferJob>,
    pub update_transfer_job_field_mask: Option<FieldMask>,
}

Request passed to UpdateTransferJob.

Fields

job_name: String

Required. The name of job to update.

project_id: String

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

transfer_job: Option<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 permission.

update_transfer_job_field_mask: Option<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].

Trait Implementations

impl Clone for UpdateTransferJobRequest

fn clone(&self) -> UpdateTransferJobRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateTransferJobRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UpdateTransferJobRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for UpdateTransferJobRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for UpdateTransferJobRequest

fn eq(&self, other: &UpdateTransferJobRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateTransferJobRequest