TransferJobArgs class

The set of arguments for TransferJob. The set of arguments for TransferJob.

Constructors

TransferJobArgs({Input<String?>? deletionPolicy, required Input<String> description, Input<TransferJobEventStream?>? eventStream, Input<TransferJobLoggingConfig?>? loggingConfig, Input<String?>? name, Input<TransferJobNotificationConfig?>? notificationConfig, Input<String?>? project, Input<TransferJobReplicationSpec?>? replicationSpec, Input<TransferJobSchedule?>? schedule, Input<String?>? serviceAccount, Input<String?>? status, Input<TransferJobTransferSpec?>? transferSpec})
Creates a new TransferJobArgs. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". description Unique description to identify the Transfer Job. eventStream Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files. Structure documented below Either eventStream or schedule must be set. loggingConfig Logging configuration. Structure documented below. name The name of the Transfer Job. This name must start with "transferJobs/" prefix and end with a letter or a number, and should be no more than 128 characters ( transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$ ). For transfers involving PosixFilesystem, this name must start with transferJobs/OPI specifically ( transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$ ). For all other transfer types, this name must not start with transferJobs/OPI. Default the provider will assign a random unique name with transferJobs/{{name}} format, where name is a numeric value. notificationConfig Notification configuration. This is not supported for transfers involving PosixFilesystem. Structure documented below. project The project in which the resource belongs. If it replicationSpec Replication specification. Structure documented below. User should not configure schedule, eventStream with this argument. One of transferSpec, or replicationSpec must be specified. schedule Schedule specification defining when the Transfer Job should be scheduled to start, end and what time to run. Structure documented below. Either schedule or eventStream must be set. serviceAccount The user-managed service account to run the job. If this field is specified, the given service account is granted the necessary permissions to all applicable resources (e.g. GCS buckets) required by the job. status Status of the job. Default: ENABLED. 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. transferSpec Transfer specification. Structure documented below. One of transferSpec, or replicationSpec can be specified.
const
TransferJobArgs.fromMap(Map<String, dynamic> map)
factory

Properties

deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String>
Unique description to identify the Transfer Job.
final
eventStream → Input<TransferJobEventStream?>?
Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files. Structure documented below Either eventStream or schedule must be set.
final
hashCode → int
The hash code for this object.
no setterinherited
loggingConfig → Input<TransferJobLoggingConfig?>?
Logging configuration. Structure documented below.
final
name → Input<String?>?
The name of the Transfer Job. This name must start with "transferJobs/" prefix and end with a letter or a number, and should be no more than 128 characters ( transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$ ). For transfers involving PosixFilesystem, this name must start with transferJobs/OPI specifically ( transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$ ). For all other transfer types, this name must not start with transferJobs/OPI. Default the provider will assign a random unique name with transferJobs/{{name}} format, where name is a numeric value.
final
notificationConfig → Input<TransferJobNotificationConfig?>?
Notification configuration. This is not supported for transfers involving PosixFilesystem. Structure documented below.
final
project → Input<String?>?
The project in which the resource belongs. If it is not provided, the provider project is used.
final
replicationSpec → Input<TransferJobReplicationSpec?>?
Replication specification. Structure documented below. User should not configure schedule, eventStream with this argument. One of transferSpec, or replicationSpec must be specified.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schedule → Input<TransferJobSchedule?>?
Schedule specification defining when the Transfer Job should be scheduled to start, end and what time to run. Structure documented below. Either schedule or eventStream must be set.
final
serviceAccount → Input<String?>?
The user-managed service account to run the job. If this field is specified, the given service account is granted the necessary permissions to all applicable resources (e.g. GCS buckets) required by the job.
final
status → Input<String?>?
Status of the job. Default: ENABLED. 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.
final
transferSpec → Input<TransferJobTransferSpec?>?
Transfer specification. Structure documented below. One of transferSpec, or replicationSpec can be specified.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited