software.amazon.awssdk.services.pipes.model

Class PipeSourceManagedStreamingKafkaParameters

java.lang.Object

software.amazon.awssdk.services.pipes.model.PipeSourceManagedStreamingKafkaParameters

All Implemented Interfaces:

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

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

The parameters for using an MSK stream as a source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PipeSourceManagedStreamingKafkaParameters.Builder

Method Summary

Modifier and Type	Method and Description
Integer	batchSize() The maximum number of records to include in each batch.
static PipeSourceManagedStreamingKafkaParameters.Builder	builder()
String	consumerGroupID() The name of the destination queue to consume.
MSKAccessCredentials	credentials() The credentials needed to access the resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maximumBatchingWindowInSeconds() The maximum length of a time to wait for events.
List<SdkField<?>>	sdkFields()
static Class<? extends PipeSourceManagedStreamingKafkaParameters.Builder>	serializableBuilderClass()
MSKStartPosition	startingPosition() (Streams only) The position in a stream from which to start reading.
String	startingPositionAsString() (Streams only) The position in a stream from which to start reading.
PipeSourceManagedStreamingKafkaParameters.Builder	toBuilder()
String	topicName() The name of the topic that the pipe will read from.
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

batchSize

public final Integer batchSize()

The maximum number of records to include in each batch.

Returns:

The maximum number of records to include in each batch.

consumerGroupID

public final String consumerGroupID()

The name of the destination queue to consume.

Returns:

The name of the destination queue to consume.

credentials

public final MSKAccessCredentials credentials()

The credentials needed to access the resource.

Returns:

The credentials needed to access the resource.

maximumBatchingWindowInSeconds

public final Integer maximumBatchingWindowInSeconds()

The maximum length of a time to wait for events.

Returns:

The maximum length of a time to wait for events.

startingPosition

public final MSKStartPosition startingPosition()

(Streams only) The position in a stream from which to start reading.

If the service returns an enum value that is not available in the current SDK version, startingPosition will return MSKStartPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

Returns:

(Streams only) The position in a stream from which to start reading.

See Also:

MSKStartPosition

startingPositionAsString

public final String startingPositionAsString()

(Streams only) The position in a stream from which to start reading.

If the service returns an enum value that is not available in the current SDK version, startingPosition will return MSKStartPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

Returns:

(Streams only) The position in a stream from which to start reading.

See Also:

MSKStartPosition

topicName

public final String topicName()

The name of the topic that the pipe will read from.

Returns:

The name of the topic that the pipe will read from.

toBuilder

public PipeSourceManagedStreamingKafkaParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipeSourceManagedStreamingKafkaParameters.Builder,PipeSourceManagedStreamingKafkaParameters>

builder

public static PipeSourceManagedStreamingKafkaParameters.Builder builder()

serializableBuilderClass

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