TransferJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)This resource represents the configuration of a transfer job that runs periodically.
Attributes | |
|---|---|
| Name | Description |
name |
str
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 |
str
A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. |
project_id |
str
The ID of the Google Cloud project that owns the job. |
transfer_spec |
google.cloud.storage_transfer_v1.types.TransferSpec
Transfer specification. |
notification_config |
google.cloud.storage_transfer_v1.types.NotificationConfig
Notification configuration. This is not supported for transfers involving PosixFilesystem. |
logging_config |
google.cloud.storage_transfer_v1.types.LoggingConfig
Logging configuration. |
schedule |
google.cloud.storage_transfer_v1.types.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 |
google.cloud.storage_transfer_v1.types.EventStream
Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored. |
status |
google.cloud.storage_transfer_v1.types.TransferJob.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][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 |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time that the transfer job was created. |
last_modification_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time that the transfer job was last modified. |
deletion_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time that the transfer job was deleted. |
latest_operation_name |
str
The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig. |
Classes
Status
Status(value)The status of the transfer job.
Values:
STATUS_UNSPECIFIED (0):
Zero is an illegal value.
ENABLED (1):
New transfers are performed based on the
schedule.
DISABLED (2):
New transfers are not scheduled.
DELETED (3):
This is a soft delete state. After a transfer job is set to
this state, the job and all the transfer executions are
subject to garbage collection. Transfer jobs become eligible
for garbage collection 30 days after their status is set to
DELETED.