Class TransferJob

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

Inheritance
object
TransferJob
Implements
Inherited Members
Namespace: Google.Apis.Storagetransfer.v1.Data
Assembly: Google.Apis.Storagetransfer.v1.dll
Syntax
public class TransferJob : IDirectResponseSchema

Properties

CreationTime

object representation of CreationTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreationTimeDateTimeOffset instead.")]
public virtual object CreationTime { get; set; }
Property Value
Type Description
object

CreationTimeDateTimeOffset

DateTimeOffset representation of CreationTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreationTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreationTimeRaw

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

Declaration
[JsonProperty("creationTime")]
public virtual string CreationTimeRaw { get; set; }
Property Value
Type Description
string

DeletionTime

object representation of DeletionTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeletionTimeDateTimeOffset instead.")]
public virtual object DeletionTime { get; set; }
Property Value
Type Description
object

DeletionTimeDateTimeOffset

DateTimeOffset representation of DeletionTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? DeletionTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

DeletionTimeRaw

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

Declaration
[JsonProperty("deletionTime")]
public virtual string DeletionTimeRaw { get; set; }
Property Value
Type Description
string

Description

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

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EventStream

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

Declaration
[JsonProperty("eventStream")]
public virtual EventStream EventStream { get; set; }
Property Value
Type Description
EventStream

LastModificationTime

object representation of LastModificationTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastModificationTimeDateTimeOffset instead.")]
public virtual object LastModificationTime { get; set; }
Property Value
Type Description
object

LastModificationTimeDateTimeOffset

DateTimeOffset representation of LastModificationTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? LastModificationTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

LastModificationTimeRaw

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

Declaration
[JsonProperty("lastModificationTime")]
public virtual string LastModificationTimeRaw { get; set; }
Property Value
Type Description
string

LatestOperationName

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

Declaration
[JsonProperty("latestOperationName")]
public virtual string LatestOperationName { get; set; }
Property Value
Type Description
string

LoggingConfig

Logging configuration.

Declaration
[JsonProperty("loggingConfig")]
public virtual LoggingConfig LoggingConfig { get; set; }
Property Value
Type Description
LoggingConfig

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NotificationConfig

Notification configuration.

Declaration
[JsonProperty("notificationConfig")]
public virtual NotificationConfig NotificationConfig { get; set; }
Property Value
Type Description
NotificationConfig

ProjectId

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

Declaration
[JsonProperty("projectId")]
public virtual string ProjectId { get; set; }
Property Value
Type Description
string

ReplicationSpec

Replication specification.

Declaration
[JsonProperty("replicationSpec")]
public virtual ReplicationSpec ReplicationSpec { get; set; }
Property Value
Type Description
ReplicationSpec

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.

Declaration
[JsonProperty("schedule")]
public virtual Schedule Schedule { get; set; }
Property Value
Type Description
Schedule

Status

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 to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.

Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type Description
string

TransferSpec

Transfer specification.

Declaration
[JsonProperty("transferSpec")]
public virtual TransferSpec TransferSpec { get; set; }
Property Value
Type Description
TransferSpec

Implements