Skip to main content

AppEnvironmentSyncProgress

Progress details for an environment sync.

type AppEnvironmentSyncProgress {
  config: JSON
  error: String
  finished_at: Int
  from_environment: AppEnvironment
  progress_percentage: Int
  progress_update_text: String
  skip_media_copy: Boolean
  started_at: Int
  status: String
  steps: [AppEnvironmentSyncStep]
  sync: Int
}

Fields​

AppEnvironmentSyncProgress.config ● JSON scalar common​

The copy configuration payload.

AppEnvironmentSyncProgress.error ● String scalar common​

Why the sync failed, when the sync recorded a reason.

AppEnvironmentSyncProgress.finished_at ● Int scalar common​

When the sync finished, as a Unix timestamp.

AppEnvironmentSyncProgress.from_environment ● AppEnvironment object common​

The source environment to sync from.

AppEnvironmentSyncProgress.progress_percentage ● Int scalar common​

How far through the sync the job has reported, as a percentage. Null when no progress has been recorded. Terminal states report 100, including failures.

AppEnvironmentSyncProgress.progress_update_text ● String scalar common​

Free-form detail about the current step's progress, as reported by the sync job. Null when none has been recorded.

AppEnvironmentSyncProgress.skip_media_copy ● Boolean scalar common​

Whether the sync skips copying media: always true from a production source, otherwise as requested. Null for syncs started before this was recorded.

AppEnvironmentSyncProgress.started_at ● Int scalar common​

When the sync started, as a Unix timestamp.

AppEnvironmentSyncProgress.status ● String scalar common​

The overall sync status.

AppEnvironmentSyncProgress.steps ● [AppEnvironmentSyncStep] list object common​

The individual sync steps.

AppEnvironmentSyncProgress.sync ● Int scalar common​

The sync job ID.

Member Of​

AppEnvironment object