TransferJobArgs

data class TransferJobArgs(val description: Output<String>? = null, val eventStream: Output<EventStreamArgs>? = null, val latestOperationName: Output<String>? = null, val loggingConfig: Output<LoggingConfigArgs>? = null, val name: Output<String>? = null, val notificationConfig: Output<NotificationConfigArgs>? = null, val project: Output<String>? = null, val schedule: Output<ScheduleArgs>? = null, val status: Output<TransferJobStatus>? = null, val transferSpec: Output<TransferSpecArgs>? = null) : ConvertibleToJava<TransferJobArgs>

Creates a transfer job that runs periodically.

Constructors

Link copied to clipboard
fun TransferJobArgs(description: Output<String>? = null, eventStream: Output<EventStreamArgs>? = null, latestOperationName: Output<String>? = null, loggingConfig: Output<LoggingConfigArgs>? = null, name: Output<String>? = null, notificationConfig: Output<NotificationConfigArgs>? = null, project: Output<String>? = null, schedule: Output<ScheduleArgs>? = null, status: Output<TransferJobStatus>? = null, transferSpec: Output<TransferSpecArgs>? = null)

Functions

Link copied to clipboard
open override fun toJava(): TransferJobArgs

Properties

Link copied to clipboard
val description: Output<String>? = null

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

Link copied to clipboard
val eventStream: Output<EventStreamArgs>? = null

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

Link copied to clipboard
val latestOperationName: Output<String>? = null

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

Link copied to clipboard
val loggingConfig: Output<LoggingConfigArgs>? = null

Logging configuration.

Link copied to clipboard
val name: Output<String>? = null

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-&#46;_~]*[A-Za-z0-9]$" PosixFilesystem example: "transferJobs/OPI^[A-Za-z0-9-&#46;_~]*[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.

Link copied to clipboard

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

Link copied to clipboard
val project: Output<String>? = null

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

Link copied to clipboard
val schedule: Output<ScheduleArgs>? = null

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.

Link copied to clipboard
val status: Output<TransferJobStatus>? = null

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.

Link copied to clipboard
val transferSpec: Output<TransferSpecArgs>? = null

Transfer specification.