Enum KafkaTopicService.KafkaTopicState
- java.lang.Object
-
- java.lang.Enum<KafkaTopicService.KafkaTopicState>
-
- com.hivemq.extensions.kafka.api.services.KafkaTopicService.KafkaTopicState
-
- All Implemented Interfaces:
Serializable
,Comparable<KafkaTopicService.KafkaTopicState>
- Enclosing interface:
- KafkaTopicService
public static enum KafkaTopicService.KafkaTopicState extends Enum<KafkaTopicService.KafkaTopicState>
KafkaTopicState encodes the current known state of a Kafka topic on the associated cluster.- Since:
- 4.4.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CREATED
This topic was created on the associated Kafka cluster.EXISTS
This topic already exists on the associated Kafka cluster.FAILURE
FAILURE signals that the operation for the topic was not successful.MISSING
This topic is missing from the associated Kafka cluster and may need to be created before a record can be published to it.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static KafkaTopicService.KafkaTopicState
valueOf(String name)
Returns the enum constant of this type with the specified name.static KafkaTopicService.KafkaTopicState[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
FAILURE
public static final KafkaTopicService.KafkaTopicState FAILURE
FAILURE signals that the operation for the topic was not successful. No possible information about the true state of this topic on the Kafka cluster can be assumed.Reasons for FAILURE can include, but are not limited to:
- Network degradation between HiveMQ and the Kafka cluster
- Insufficient permissions to perform the operation
- An unsuitable configuration in either the HiveMQ Enterprise Extension for Kafka or the Kafka cluster
- The internal state of the Kafka cluster
- Since:
- 4.4.0
-
MISSING
public static final KafkaTopicService.KafkaTopicState MISSING
This topic is missing from the associated Kafka cluster and may need to be created before a record can be published to it.- Since:
- 4.4.0
-
EXISTS
public static final KafkaTopicService.KafkaTopicState EXISTS
This topic already exists on the associated Kafka cluster.- Since:
- 4.4.0
-
CREATED
public static final KafkaTopicService.KafkaTopicState CREATED
This topic was created on the associated Kafka cluster.- Since:
- 4.4.0
-
-
Method Detail
-
values
public static KafkaTopicService.KafkaTopicState[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (KafkaTopicService.KafkaTopicState c : KafkaTopicService.KafkaTopicState.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static KafkaTopicService.KafkaTopicState valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-