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

Interface MSKSourceDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MSKSourceDescription.Builder,MSKSourceDescription>, SdkBuilder<MSKSourceDescription.Builder,MSKSourceDescription>, SdkPojo

Enclosing class:

MSKSourceDescription

public static interface MSKSourceDescription.Builder
extends SdkPojo, CopyableBuilder<MSKSourceDescription.Builder,MSKSourceDescription>

Method Summary

Modifier and Type	Method	Description
default MSKSourceDescription.Builder	authenticationConfiguration(Consumer<AuthenticationConfiguration.Builder> authenticationConfiguration)	The authentication configuration of the Amazon MSK cluster.
MSKSourceDescription.Builder	authenticationConfiguration(AuthenticationConfiguration authenticationConfiguration)	The authentication configuration of the Amazon MSK cluster.
MSKSourceDescription.Builder	deliveryStartTimestamp(Instant deliveryStartTimestamp)	Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.
MSKSourceDescription.Builder	mskClusterARN(String mskClusterARN)	The ARN of the Amazon MSK cluster.
MSKSourceDescription.Builder	readFromTimestamp(Instant readFromTimestamp)	The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read.
MSKSourceDescription.Builder	topicName(String topicName)	The topic name within the Amazon MSK cluster.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

mskClusterARN

MSKSourceDescription.Builder mskClusterARN(String mskClusterARN)

The ARN of the Amazon MSK cluster.

Parameters:

mskClusterARN - The ARN of the Amazon MSK cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

topicName

MSKSourceDescription.Builder topicName(String topicName)

The topic name within the Amazon MSK cluster.

Parameters:

topicName - The topic name within the Amazon MSK cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

authenticationConfiguration

MSKSourceDescription.Builder authenticationConfiguration(AuthenticationConfiguration authenticationConfiguration)

The authentication configuration of the Amazon MSK cluster.

Parameters:

authenticationConfiguration - The authentication configuration of the Amazon MSK cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

authenticationConfiguration

default MSKSourceDescription.Builder authenticationConfiguration(Consumer<AuthenticationConfiguration.Builder> authenticationConfiguration)

The authentication configuration of the Amazon MSK cluster.

This is a convenience method that creates an instance of the AuthenticationConfiguration.Builder avoiding the need to create one manually via AuthenticationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticationConfiguration(AuthenticationConfiguration).

Parameters:

authenticationConfiguration - a consumer that will call methods on AuthenticationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

authenticationConfiguration(AuthenticationConfiguration)

deliveryStartTimestamp

MSKSourceDescription.Builder deliveryStartTimestamp(Instant deliveryStartTimestamp)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

readFromTimestamp

MSKSourceDescription.Builder readFromTimestamp(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).

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.