Class KafkaAction
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<KafkaAction.Builder,
KafkaAction>
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic KafkaAction.Builder
builder()
Properties of the Apache Kafka producer client.final String
The ARN of Kafka action's VPCTopicRuleDestination
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ClientProperties property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Headers property.final List
<KafkaActionHeader> headers()
The list of Kafka headers that you specify.final String
key()
The Kafka message key.final String
The Kafka message partition.static Class
<? extends KafkaAction.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
topic()
The Kafka topic for messages to be sent to the Kafka broker.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
destinationArn
The ARN of Kafka action's VPC
TopicRuleDestination
.- Returns:
- The ARN of Kafka action's VPC
TopicRuleDestination
.
-
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
The Kafka message key.
- Returns:
- The Kafka message key.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<KafkaAction.Builder,
KafkaAction> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-