Interface SubscriptionHealthStatus
- All Superinterfaces:
io.vrap.rmf.base.client.JsonEnum
- All Known Implementing Classes:
SubscriptionHealthStatus.SubscriptionHealthStatusEnum
The health status of the Subscription that indicates whether messages are being delivered to the Destination.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic enum
possible values of SubscriptionHealthStatus -
Field Summary
Modifier and TypeFieldDescriptionstatic final SubscriptionHealthStatus
Messages cannot be delivered with the current configuration.static final SubscriptionHealthStatus
Does not deliver messages with the current configuration and the delivery of the messages is no longer attempted.static final SubscriptionHealthStatus
Delivers messages as expected.static final SubscriptionHealthStatus
Does not deliver messages temporarily due to reasons other than a configuration error. -
Method Summary
Modifier and TypeMethodDescriptionstatic SubscriptionHealthStatus
factory method for a enum value of SubscriptionHealthStatus if no enum has been found an anonymous instance will be createdstatic Optional<SubscriptionHealthStatus>
findEnumViaJsonName
(String jsonName) method to find enum using the JSON valuethe JSON valuename()
the enum valuetoString()
convert value to stringstatic SubscriptionHealthStatus[]
values()
possible enum values
-
Field Details
-
HEALTHY
Delivers messages as expected.
-
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 intoConfigurationErrorDeliveryStopped
after some time. For more information, see Delivery Guarantees. -
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
Does not deliver messages temporarily due to reasons other than a configuration error. For example, the Destination has a temporary outage.
-
-
Method Details
-
getJsonName
the JSON value- Specified by:
getJsonName
in interfaceio.vrap.rmf.base.client.JsonEnum
- Returns:
- json value
-
name
the enum value- Specified by:
name
in interfaceio.vrap.rmf.base.client.JsonEnum
- Returns:
- name
-
toString
convert value to string -
findEnum
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
method to find enum using the JSON value- Parameters:
jsonName
- the json value to be wrapped- Returns:
- optional of enum instance
-
values
possible enum values- Returns:
- array of possible enum values
-