Home > @tridion-sites/open-api-client > PublishTransactionState
Represents the states a Publish Transaction can have.
Members: * ScheduledForPublish
- The PublishTransaction is scheduled to start at the specified date time.
* WaitingForPublish
- The PublishTransaction is waiting to be processed.
* InProgress
- The PublishTransaction is currently in progress.
* ScheduledForDeployment
- The PublishTransaction is scheduled to be deployed at the specified date time.
* WaitingForDeployment
- The PublishTransaction is waiting to be deployed at the specified date time.
* Failed
- The PublishTransaction failed.
* Success
- The PublishTransaction succeeded.
* Warning
- The PublishTransaction succeeded but contains warnings.
* Resolving
- The PublishTransaction is currently being resolved.
* Rendering
- The PublishTransaction is currently being rendered.
* Throttled
- The PublishTransaction is currently being throttled by the TransportService.
* ReadyForTransport
- The PublishTransaction is currently ready for transport.
* Transporting
- The PublishTransaction is currently being transported to the destinations.
* Deploying
- The PublishTransaction is currently being deployed.
* PreparingDeployment
- The PublishTransaction is currently being prepared for deployment.
* PreCommittingDeployment
- The PublishTransaction is in the pre-committing deployment phase.
* CommittingDeployment
- The PublishTransaction is being committed for the deployment.
* WaitingForCdEnvironment
- The PublishTransaction is waiting for Content Delivery Environment to be online.
* UnknownByClient
- Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.
Signature:
export declare enum PublishTransactionState
Member | Value | Description |
---|---|---|
COMMITTING_DEPLOYMENT | "CommittingDeployment" |
|
DEPLOYING | "Deploying" |
|
FAILED | "Failed" |
|
IN_PROGRESS | "InProgress" |
|
PRE_COMMITTING_DEPLOYMENT | "PreCommittingDeployment" |
|
PREPARING_DEPLOYMENT | "PreparingDeployment" |
|
READY_FOR_TRANSPORT | "ReadyForTransport" |
|
RENDERING | "Rendering" |
|
RESOLVING | "Resolving" |
|
SCHEDULED_FOR_DEPLOYMENT | "ScheduledForDeployment" |
|
SCHEDULED_FOR_PUBLISH | "ScheduledForPublish" |
|
SUCCESS | "Success" |
|
THROTTLED | "Throttled" |
|
TRANSPORTING | "Transporting" |
|
UNKNOWN_BY_CLIENT | "UnknownByClient" |
|
WAITING_FOR_CD_ENVIRONMENT | "WaitingForCdEnvironment" |
|
WAITING_FOR_DEPLOYMENT | "WaitingForDeployment" |
|
WAITING_FOR_PUBLISH | "WaitingForPublish" |
|
WARNING | "Warning" |