Package com.commercetools.api.models.subscription

Interface SubscriptionHealthStatus

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
SubscriptionHealthStatus.SubscriptionHealthStatusEnum
public interface SubscriptionHealthStatus extends JsonEnum

The health status of the Subscription that indicates whether messages are being delivered.

  • Field Details

    • HEALTHY

      static final SubscriptionHealthStatus HEALTHY

      Delivers messages as expected.

    • CONFIGURATION_ERROR

      static final SubscriptionHealthStatus CONFIGURATION_ERROR

      Messages cannot be delivered with the current configuration. Common causes are deleting the Destination queue, deleting access credentials, or removing the necessary permissions. The configuration can be fixed by re-creating the configuration on the Destination side, or by setting a new configuration with the Change Destination update action. If the configuration is fixed, undelivered messages will be delivered and the status will change to Healthy. ConfigurationError is automatically turned into ConfigurationErrorDeliveryStopped after some time. For more information, see Delivery Guarantees.

    • CONFIGURATION_ERROR_DELIVERY_STOPPED

      static final SubscriptionHealthStatus CONFIGURATION_ERROR_DELIVERY_STOPPED

      Does not deliver messages with the current configuration and the delivery of the messages is no longer attempted. If the configuration is fixed, undelivered messages are not retained and will not be delivered. The status will change to Healthy as soon as new messages can be delivered.

    • TEMPORARY_ERROR

      static final SubscriptionHealthStatus TEMPORARY_ERROR

      Does not deliver messages temporarily due to reasons other than a configuration error. For example, the Destination has a temporary outage.

    • MANUALLY_SUSPENDED

      static final SubscriptionHealthStatus MANUALLY_SUSPENDED

      Does not deliver messages with the current configuration and the delivery of the messages is no longer attempted. Undelivered messages are not retained and will not be delivered. The status will not automatically change to Healthy. To return your subscriptions to a Healthy status, please contact our support team.

  • Method Details

    • getJsonName

      String getJsonName()
      the JSON value
      Specified by:
      getJsonName in interface JsonEnum
      Returns:
      json value

    • name

      String name()
      the enum value
      Specified by:
      name in interface JsonEnum
      Returns:
      name

    • toString

      String toString()
      convert value to string
      Specified by:
      toString in interface JsonEnum
      Overrides:
      toString in class Object
      Returns:
      string representation

    • findEnum

      static SubscriptionHealthStatus findEnum(String value)
      factory method for a enum value of SubscriptionHealthStatus if no enum has been found an anonymous instance will be created
      Parameters:
      value - the enum value to be wrapped
      Returns:
      enum instance

    • findEnumViaJsonName

      static Optional<SubscriptionHealthStatus> findEnumViaJsonName(String jsonName)
      method to find enum using the JSON value
      Parameters:
      jsonName - the json value to be wrapped
      Returns:
      optional of enum instance

    • values

      static SubscriptionHealthStatus[] values()
      possible enum values
      Returns:
      array of possible enum values