Class TransferJob (1.5.1)

Version 1.5.1

• 1.11.3 (latest)
• 1.11.2
• 1.10.0
• 1.9.2
• 1.8.1
• 1.7.1
• 1.6.0
• 1.5.2
• 1.4.1
• 1.3.1
• 1.2.1
• 1.1.1
• 1.0.2
• 0.1.0

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

Inheritance

builtins.object > proto.message.Message > TransferJob

Classes

Status

Status(value)

The status of the transfer job.