Struct google_api_proto::google::storagetransfer::v1::TransferJob

pub struct TransferJob {

    pub name: String,
    pub description: String,
    pub project_id: String,
    pub transfer_spec: Option<TransferSpec>,
    pub notification_config: Option<NotificationConfig>,
    pub logging_config: Option<LoggingConfig>,
    pub schedule: Option<Schedule>,
    pub event_stream: Option<EventStream>,
    pub status: i32,
    pub creation_time: Option<Timestamp>,
    pub last_modification_time: Option<Timestamp>,
    pub deletion_time: Option<Timestamp>,
    pub latest_operation_name: String,
}

This resource represents the configuration of a transfer job that runs periodically.

Fields

name: String

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][google.rpc.Code.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][google.rpc.Code.INVALID_ARGUMENT] error.

description: String

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

project_id: String

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

transfer_spec: Option<TransferSpec>

Transfer specification.

notification_config: Option<NotificationConfig>

Notification configuration.

logging_config: Option<LoggingConfig>

Logging configuration.

schedule: Option<Schedule>

Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.

event_stream: Option<EventStream>

Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.

status: i32

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][google.storagetransfer.v1.TransferJob.Status.ENABLED] to [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED], and an operation spawned by the transfer is running, the status change would not affect the current operation.

creation_time: Option<Timestamp>

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

last_modification_time: Option<Timestamp>

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

deletion_time: Option<Timestamp>

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

latest_operation_name: String

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

Implementations

impl TransferJob

pub fn status(&self) -> Status

Returns the enum value of status, or the default if the field is set to an invalid enum value.

pub fn set_status(&mut self, value: Status)

Sets status to the provided enum value.

Trait Implementations

impl Clone for TransferJob

fn clone(&self) -> TransferJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransferJob

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

Formats the value using the given formatter.

impl Default for TransferJob

fn default() -> Self

Returns the “default value” for a type.

impl Message for TransferJob

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 TransferJob

fn eq(&self, other: &TransferJob) -> 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 TransferJob