org.springframework.cloud.contract.verifier.messaging.kafka

Class KafkaMetadata

java.lang.Object

org.springframework.cloud.contract.verifier.messaging.kafka.KafkaMetadata

All Implemented Interfaces:

SpringCloudContractMetadata

public class KafkaMetadata
extends Object
implements SpringCloudContractMetadata

Represents metadata for Kafka based communication.

Since:

3.0.0

Author:

Marcin Grzejszczak

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KafkaMetadata.ConnectToBroker Options related to connecting to the real broker.
static class	KafkaMetadata.MessageKafkaMetadata Kafka message metadata.

Field Summary

Fields

Modifier and Type	Field and Description
static String	METADATA_KEY Key under which this metadata entry can be found in contract's metadata.

Constructor Summary

Constructors

Constructor and Description
KafkaMetadata()

Method Summary

Modifier and Type	Method and Description
String	description() Short description of the metadata.
static KafkaMetadata	fromMetadata(Map<String,Object> metadata)
KafkaMetadata.MessageKafkaMetadata	getInput()
KafkaMetadata.MessageKafkaMetadata	getOutputMessage()
String	key() Name of the key under which this metadata entry will be present in contract's metadata.
void	setInput(KafkaMetadata.MessageKafkaMetadata input)
void	setOutputMessage(KafkaMetadata.MessageKafkaMetadata outputMessage)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.cloud.contract.verifier.util.SpringCloudContractMetadata

additionalClassesToLookAt

Field Detail

METADATA_KEY

public static final String METADATA_KEY

Key under which this metadata entry can be found in contract's metadata.

See Also:

Constant Field Values

Constructor Detail

KafkaMetadata

public KafkaMetadata()

Method Detail

getInput

public KafkaMetadata.MessageKafkaMetadata getInput()

setInput

public void setInput(KafkaMetadata.MessageKafkaMetadata input)

getOutputMessage

public KafkaMetadata.MessageKafkaMetadata getOutputMessage()

setOutputMessage

public void setOutputMessage(KafkaMetadata.MessageKafkaMetadata outputMessage)

fromMetadata

public static KafkaMetadata fromMetadata(Map<String,Object> metadata)

key

public String key()

Description copied from interface: SpringCloudContractMetadata

Name of the key under which this metadata entry will be present in contract's metadata.

Specified by:

key in interface SpringCloudContractMetadata

Returns:

key name

description

public String description()

Description copied from interface: SpringCloudContractMetadata

Short description of the metadata. Will be used in the generated documentation.

Specified by:

description in interface SpringCloudContractMetadata

Returns:

description of the metadata.