GetTransferJobResult class
Result data returned by getTransferJob.
Constructors
- GetTransferJobResult({required String creationTime, required String deletionTime, required String description, required EventStreamResponse eventStream, required String lastModificationTime, required String latestOperationName, required LoggingConfigResponse loggingConfig, required String name, required NotificationConfigResponse notificationConfig, required String project, required ScheduleResponse schedule, required String status, required TransferSpecResponse transferSpec})
-
Creates a new GetTransferJobResult.
creationTimeThe time that the transfer job was created.deletionTimeThe time that the transfer job was deleted.descriptionA description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.eventStreamSpecifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.lastModificationTimeThe time that the transfer job was last modified.latestOperationNameThe name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.loggingConfigLogging configuration.nameA 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 withtransferJobs/OPIspecifically. For all other transfer types, this name must not start withtransferJobs/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 error.notificationConfigNotification configuration. This is not supported for transfers involving PosixFilesystem.projectThe ID of the Google Cloud project that owns the job.scheduleSpecifies 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.statusStatus of the job. This value MUST be specified forCreateTransferJobRequests. 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.transferSpecTransfer specification.const -
GetTransferJobResult.fromMap(Map<
String, dynamic> map) -
factory
Properties
- creationTime → String
-
The time that the transfer job was created.
final
- deletionTime → String
-
The time that the transfer job was deleted.
final
- description → String
-
A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
final
- eventStream → EventStreamResponse
-
Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- lastModificationTime → String
-
The time that the transfer job was last modified.
final
- latestOperationName → String
-
The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
final
- loggingConfig → LoggingConfigResponse
-
Logging configuration.
final
- name → String
-
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 withtransferJobs/OPIspecifically. For all other transfer types, this name must not start withtransferJobs/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 error.final - notificationConfig → NotificationConfigResponse
-
Notification configuration. This is not supported for transfers involving PosixFilesystem.
final
- project → String
-
The ID of the Google Cloud project that owns the job.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- schedule → ScheduleResponse
-
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.
final
- status → String
-
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.final - transferSpec → TransferSpecResponse
-
Transfer specification.
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