Package software.amazon.awssdk.services.firehose.model

Class MSKSourceDescription

java.lang.Object

software.amazon.awssdk.services.firehose.model.MSKSourceDescription

All Implemented Interfaces:

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

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

Details about the Amazon MSK cluster used as the source for a Firehose stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MSKSourceDescription.Builder

Method Summary

Modifier and Type	Method	Description
AuthenticationConfiguration	authenticationConfiguration()	The authentication configuration of the Amazon MSK cluster.
static MSKSourceDescription.Builder	builder()
Instant	deliveryStartTimestamp()	Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	mskClusterARN()	The ARN of the Amazon MSK cluster.
Instant	readFromTimestamp()	The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MSKSourceDescription.Builder>	serializableBuilderClass()
MSKSourceDescription.Builder	toBuilder()
String	topicName()	The topic name within the Amazon MSK cluster.
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

mskClusterARN

public final String mskClusterARN()

The ARN of the Amazon MSK cluster.

Returns:

The ARN of the Amazon MSK cluster.

topicName

public final String topicName()

The topic name within the Amazon MSK cluster.

Returns:

The topic name within the Amazon MSK cluster.

authenticationConfiguration

public final AuthenticationConfiguration authenticationConfiguration()

The authentication configuration of the Amazon MSK cluster.

Returns:

The authentication configuration of the Amazon MSK cluster.

deliveryStartTimestamp

public final Instant deliveryStartTimestamp()

Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.

Returns:

Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.

readFromTimestamp

public final Instant readFromTimestamp()

The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestampUTC parameter to Epoch (1970-01-01T00:00:00Z).

Returns:

The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestampUTC parameter to Epoch (1970-01-01T00:00:00Z).

toBuilder

public MSKSourceDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MSKSourceDescription.Builder,MSKSourceDescription>

builder

public static MSKSourceDescription.Builder builder()

serializableBuilderClass

public static Class<? extends MSKSourceDescription.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo