GoogleApi.StorageTransfer.V1.Model.TransferJob (google_api_storage_transfer v0.26.2) View Source

This resource represents the configuration of a transfer job that runs periodically.


  • creationTime (type: DateTime.t, default: nil) - Output only. The time that the transfer job was created.
  • deletionTime (type: DateTime.t, default: nil) - Output only. The time that the transfer job was deleted.
  • description (type: String.t, default: nil) - A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
  • lastModificationTime (type: DateTime.t, default: nil) - Output only. The time that the transfer job was last modified.
  • latestOperationName (type: String.t, default: nil) - The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
  • name (type: String.t, default: nil) - A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign 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 ALREADYEXISTS error. This name must start with "transferJobs/" prefix and end with a letter or a number, and should be no more than 128 characters. This name must not start with 'transferJobs/OPI'. 'transferJobs/OPI' is a reserved prefix. Example: `"transferJobs/^(?!OPI)[A-Za-z0-9-.~]*[A-Za-z0-9]$"` Invalid job names will fail with an INVALID_ARGUMENT error.
  • notificationConfig (type: GoogleApi.StorageTransfer.V1.Model.NotificationConfig.t, default: nil) - Notification configuration.
  • projectId (type: String.t, default: nil) - The ID of the Google Cloud Platform Project that owns the job.
  • schedule (type: GoogleApi.StorageTransfer.V1.Model.Schedule.t, default: nil) - Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job will never execute a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.
  • status (type: String.t, default: nil) - 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.
  • transferSpec (type: GoogleApi.StorageTransfer.V1.Model.TransferSpec.t, default: nil) - Transfer specification.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.StorageTransfer.V1.Model.TransferJob{
  creationTime: DateTime.t() | nil,
  deletionTime: DateTime.t() | nil,
  description: String.t() | nil,
  lastModificationTime: DateTime.t() | nil,
  latestOperationName: String.t() | nil,
  name: String.t() | nil,
    GoogleApi.StorageTransfer.V1.Model.NotificationConfig.t() | nil,
  projectId: String.t() | nil,
  schedule: GoogleApi.StorageTransfer.V1.Model.Schedule.t() | nil,
  status: String.t() | nil,
  transferSpec: GoogleApi.StorageTransfer.V1.Model.TransferSpec.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.