Package software.amazon.awssdk.services.iot.model

Class KafkaAction

java.lang.Object

software.amazon.awssdk.services.iot.model.KafkaAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KafkaAction.Builder,KafkaAction>

@Generated("software.amazon.awssdk:codegen")
public final class KafkaAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KafkaAction.Builder,KafkaAction>

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KafkaAction.Builder

Method Summary

Modifier and Type	Method	Description
static KafkaAction.Builder	builder()
Map<String,String>	clientProperties()	Properties of the Apache Kafka producer client.
String	destinationArn()	The ARN of Kafka action's VPC TopicRuleDestination.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClientProperties()	For responses, this returns true if the service returned a value for the ClientProperties property.
int	hashCode()
boolean	hasHeaders()	For responses, this returns true if the service returned a value for the Headers property.
List<KafkaActionHeader>	headers()	The list of Kafka headers that you specify.
String	key()	The Kafka message key.
String	partition()	The Kafka message partition.
List<SdkField<?>>	sdkFields()
static Class<? extends KafkaAction.Builder>	serializableBuilderClass()
KafkaAction.Builder	toBuilder()
String	topic()	The Kafka topic for messages to be sent to the Kafka broker.
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

destinationArn

public final String destinationArn()

The ARN of Kafka action's VPC TopicRuleDestination.

Returns:

The ARN of Kafka action's VPC TopicRuleDestination.

topic

public final String topic()

The Kafka topic for messages to be sent to the Kafka broker.

Returns:

The Kafka topic for messages to be sent to the Kafka broker.

key

public final String key()

The Kafka message key.

Returns:

The Kafka message key.

partition

public final String partition()

The Kafka message partition.

Returns:

The Kafka message partition.

hasClientProperties

public final boolean hasClientProperties()

For responses, this returns true if the service returned a value for the ClientProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

clientProperties

public final Map<String,String> clientProperties()

Properties of the Apache Kafka producer client.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClientProperties() method.

Returns:

Properties of the Apache Kafka producer client.

hasHeaders

public final boolean hasHeaders()

For responses, this returns true if the service returned a value for the Headers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

headers

public final List<KafkaActionHeader> headers()

The list of Kafka headers that you specify.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHeaders() method.

Returns:

The list of Kafka headers that you specify.

toBuilder

public KafkaAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KafkaAction.Builder,KafkaAction>

builder

public static KafkaAction.Builder builder()

serializableBuilderClass

public static Class<? extends KafkaAction.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo