Class PipeSourceManagedStreamingKafkaParameters
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PipeSourceManagedStreamingKafkaParameters.Builder,
PipeSourceManagedStreamingKafkaParameters>
The parameters for using an MSK stream as a source.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
The maximum number of records to include in each batch.builder()
final String
The name of the destination queue to consume.final MSKAccessCredentials
The credentials needed to access the resource.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 int
hashCode()
final Integer
The maximum length of a time to wait for events.static Class
<? extends PipeSourceManagedStreamingKafkaParameters.Builder> final MSKStartPosition
(Streams only) The position in a stream from which to start reading.final String
(Streams only) The position in a stream from which to start reading.Take this object and create a builder that contains all of the current property values of this object.final String
The name of the topic that the pipe will read from.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
batchSize
The maximum number of records to include in each batch.
- Returns:
- The maximum number of records to include in each batch.
-
consumerGroupID
The name of the destination queue to consume.
- Returns:
- The name of the destination queue to consume.
-
credentials
The credentials needed to access the resource.
- Returns:
- The credentials needed to access the resource.
-
maximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
- Returns:
- The maximum length of a time to wait for events.
-
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 returnMSKStartPosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstartingPositionAsString()
.- Returns:
- (Streams only) The position in a stream from which to start reading.
- See Also:
-
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 returnMSKStartPosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstartingPositionAsString()
.- Returns:
- (Streams only) The position in a stream from which to start reading.
- See Also:
-
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
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<PipeSourceManagedStreamingKafkaParameters.Builder,
PipeSourceManagedStreamingKafkaParameters> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends PipeSourceManagedStreamingKafkaParameters.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
-