public sealed class TransferJob : IMessage<TransferJob>, IEquatable<TransferJob>, IDeepCloneable<TransferJob>, IBufferMessage, IMessageReference documentation and code samples for the Storage Transfer v1 API class TransferJob.
This resource represents the configuration of a transfer job that runs periodically.
Implements
IMessageTransferJob, IEquatableTransferJob, IDeepCloneableTransferJob, IBufferMessage, IMessageNamespace
Google.Cloud.StorageTransfer.V1Assembly
Google.Cloud.StorageTransfer.V1.dll
Constructors
TransferJob()
public TransferJob()TransferJob(TransferJob)
public TransferJob(TransferJob other)| Parameter | |
|---|---|
| Name | Description |
other |
TransferJob |
Properties
CreationTime
public Timestamp CreationTime { get; set; }Output only. The time that the transfer job was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
DeletionTime
public Timestamp DeletionTime { get; set; }Output only. The time that the transfer job was deleted.
| Property Value | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
EventStream |
|
LastModificationTime
public Timestamp LastModificationTime { get; set; }Output only. The time that the transfer job was last modified.
| Property Value | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
string |
|
LoggingConfig
public LoggingConfig LoggingConfig { get; set; }Logging configuration.
| Property Value | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
string |
|
NotificationConfig
public NotificationConfig NotificationConfig { get; set; }Notification configuration.
| Property Value | |
|---|---|
| Type | Description |
NotificationConfig |
|
ProjectId
public string ProjectId { get; set; }The ID of the Google Cloud project that owns the job.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ReplicationSpec
public ReplicationSpec ReplicationSpec { get; set; }Replication specification.
| Property Value | |
|---|---|
| Type | Description |
ReplicationSpec |
|
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 | |
|---|---|
| Type | Description |
Schedule |
|
ServiceAccount
public string ServiceAccount { get; set; }Optional. The user-managed service account to which to delegate service agent permissions. You can grant Cloud Storage bucket permissions to this service account instead of to the Transfer Service service agent.
Format is
projects/-/serviceAccounts/ACCOUNT_EMAIL_OR_UNIQUEID
Either the service account email
(SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com) or the unique
ID (123456789012345678901) are accepted in the string. The -
wildcard character is required; replacing it with a project ID is invalid.
See https://cloud.google.com//storage-transfer/docs/delegate-service-agent-permissions for required permissions.
| Property Value | |
|---|---|
| Type | Description |
string |
|
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 | |
|---|---|
| Type | Description |
TransferJobTypesStatus |
|
TransferSpec
public TransferSpec TransferSpec { get; set; }Transfer specification.
| Property Value | |
|---|---|
| Type | Description |
TransferSpec |
|