Storage Transfer v1 API - Class TransferJob (2.4.0)

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

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

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

Inheritance

object > TransferJob

Namespace

Google.Cloud.StorageTransfer.V1

Assembly

Google.Cloud.StorageTransfer.V1.dll

Constructors

TransferJob()

public TransferJob()

TransferJob(TransferJob)

public TransferJob(TransferJob other)
Parameter
NameDescription
otherTransferJob

Properties

CreationTime

public Timestamp CreationTime { get; set; }

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

Property Value
TypeDescription
Timestamp

DeletionTime

public Timestamp DeletionTime { get; set; }

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

Property Value
TypeDescription
Timestamp

Description

public string Description { get; set; }

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

Property Value
TypeDescription
string

EventStream

public EventStream EventStream { get; set; }

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

Property Value
TypeDescription
EventStream

LastModificationTime

public Timestamp LastModificationTime { get; set; }

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

Property Value
TypeDescription
Timestamp

LatestOperationName

public string LatestOperationName { get; set; }

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

Property Value
TypeDescription
string

LoggingConfig

public LoggingConfig LoggingConfig { get; set; }

Logging configuration.

Property Value
TypeDescription
LoggingConfig

Name

public string Name { get; set; }

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.

Property Value
TypeDescription
string

NotificationConfig

public NotificationConfig NotificationConfig { get; set; }

Notification configuration. This is not supported for transfers involving PosixFilesystem.

Property Value
TypeDescription
NotificationConfig

ProjectId

public string ProjectId { get; set; }

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

Property Value
TypeDescription
string

Schedule

public Schedule Schedule { get; set; }

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.

Property Value
TypeDescription
Schedule

Status

public TransferJob.Types.Status Status { get; set; }

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.

Property Value
TypeDescription
TransferJobTypesStatus

TransferSpec

public TransferSpec TransferSpec { get; set; }

Transfer specification.

Property Value
TypeDescription
TransferSpec