PipeSourceManagedStreamingKafkaParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pipes.model.PipeSourceManagedStreamingKafkaParameters

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipeSourceManagedStreamingKafkaParameters
extends Object
implements Serializable, Cloneable, StructuredPojo

The parameters for using an MSK stream as a source.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipeSourceManagedStreamingKafkaParameters()

Constructors
Constructor and Description
`PipeSourceManagedStreamingKafkaParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipeSourceManagedStreamingKafkaParameters`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBatchSize()` The maximum number of records to include in each batch.
`String`	`getConsumerGroupID()` The name of the destination queue to consume.
`MSKAccessCredentials`	`getCredentials()` The credentials needed to access the resource.
`Integer`	`getMaximumBatchingWindowInSeconds()` The maximum length of a time to wait for events.
`String`	`getStartingPosition()` (Streams only) The position in a stream from which to start reading.
`String`	`getTopicName()` The name of the topic that the pipe will read from.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBatchSize(Integer batchSize)` The maximum number of records to include in each batch.
`void`	`setConsumerGroupID(String consumerGroupID)` The name of the destination queue to consume.
`void`	`setCredentials(MSKAccessCredentials credentials)` The credentials needed to access the resource.
`void`	`setMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)` The maximum length of a time to wait for events.
`void`	`setStartingPosition(String startingPosition)` (Streams only) The position in a stream from which to start reading.
`void`	`setTopicName(String topicName)` The name of the topic that the pipe will read from.
`String`	`toString()` Returns a string representation of this object.
`PipeSourceManagedStreamingKafkaParameters`	`withBatchSize(Integer batchSize)` The maximum number of records to include in each batch.
`PipeSourceManagedStreamingKafkaParameters`	`withConsumerGroupID(String consumerGroupID)` The name of the destination queue to consume.
`PipeSourceManagedStreamingKafkaParameters`	`withCredentials(MSKAccessCredentials credentials)` The credentials needed to access the resource.
`PipeSourceManagedStreamingKafkaParameters`	`withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)` The maximum length of a time to wait for events.
`PipeSourceManagedStreamingKafkaParameters`	`withStartingPosition(MSKStartPosition startingPosition)` (Streams only) The position in a stream from which to start reading.
`PipeSourceManagedStreamingKafkaParameters`	`withStartingPosition(String startingPosition)` (Streams only) The position in a stream from which to start reading.
`PipeSourceManagedStreamingKafkaParameters`	`withTopicName(String topicName)` The name of the topic that the pipe will read from.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PipeSourceManagedStreamingKafkaParameters
```
public PipeSourceManagedStreamingKafkaParameters()
```
- Method Detail
  - setTopicName
```
public void setTopicName(String topicName)
```
    The name of the topic that the pipe will read from.
    
    Parameters:
    
    topicName - The name of the topic that the pipe will read from.
  - getTopicName
```
public String getTopicName()
```
    The name of the topic that the pipe will read from.
    
    Returns:
    
    The name of the topic that the pipe will read from.
  - withTopicName
```
public PipeSourceManagedStreamingKafkaParameters withTopicName(String topicName)
```
    The name of the topic that the pipe will read from.
    
    Parameters:
    
    topicName - The name of the topic that the pipe will read from.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartingPosition
```
public void setStartingPosition(String startingPosition)
```
    (Streams only) The position in a stream from which to start reading.
    
    Parameters:
    
    startingPosition - (Streams only) The position in a stream from which to start reading.
    
    See Also:
    
    MSKStartPosition
  - getStartingPosition
```
public String getStartingPosition()
```
    (Streams only) The position in a stream from which to start reading.
    
    Returns:
    
    (Streams only) The position in a stream from which to start reading.
    
    See Also:
    
    MSKStartPosition
  - withStartingPosition
```
public PipeSourceManagedStreamingKafkaParameters withStartingPosition(String startingPosition)
```
    (Streams only) The position in a stream from which to start reading.
    
    Parameters:
    
    startingPosition - (Streams only) The position in a stream from which to start reading.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MSKStartPosition
  - withStartingPosition
```
public PipeSourceManagedStreamingKafkaParameters withStartingPosition(MSKStartPosition startingPosition)
```
    (Streams only) The position in a stream from which to start reading.
    
    Parameters:
    
    startingPosition - (Streams only) The position in a stream from which to start reading.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MSKStartPosition
  - setBatchSize
```
public void setBatchSize(Integer batchSize)
```
    The maximum number of records to include in each batch.
    
    Parameters:
    
    batchSize - The maximum number of records to include in each batch.
  - getBatchSize
```
public Integer getBatchSize()
```
    The maximum number of records to include in each batch.
    
    Returns:
    
    The maximum number of records to include in each batch.
  - withBatchSize
```
public PipeSourceManagedStreamingKafkaParameters withBatchSize(Integer batchSize)
```
    The maximum number of records to include in each batch.
    
    Parameters:
    
    batchSize - The maximum number of records to include in each batch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaximumBatchingWindowInSeconds
```
public void setMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)
```
    The maximum length of a time to wait for events.
    
    Parameters:
    
    maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
  - getMaximumBatchingWindowInSeconds
```
public Integer getMaximumBatchingWindowInSeconds()
```
    The maximum length of a time to wait for events.
    
    Returns:
    
    The maximum length of a time to wait for events.
  - withMaximumBatchingWindowInSeconds
```
public PipeSourceManagedStreamingKafkaParameters withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)
```
    The maximum length of a time to wait for events.
    
    Parameters:
    
    maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConsumerGroupID
```
public void setConsumerGroupID(String consumerGroupID)
```
    The name of the destination queue to consume.
    
    Parameters:
    
    consumerGroupID - The name of the destination queue to consume.
  - getConsumerGroupID
```
public String getConsumerGroupID()
```
    The name of the destination queue to consume.
    
    Returns:
    
    The name of the destination queue to consume.
  - withConsumerGroupID
```
public PipeSourceManagedStreamingKafkaParameters withConsumerGroupID(String consumerGroupID)
```
    The name of the destination queue to consume.
    
    Parameters:
    
    consumerGroupID - The name of the destination queue to consume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCredentials
```
public void setCredentials(MSKAccessCredentials credentials)
```
    The credentials needed to access the resource.
    
    Parameters:
    
    credentials - The credentials needed to access the resource.
  - getCredentials
```
public MSKAccessCredentials getCredentials()
```
    The credentials needed to access the resource.
    
    Returns:
    
    The credentials needed to access the resource.
  - withCredentials
```
public PipeSourceManagedStreamingKafkaParameters withCredentials(MSKAccessCredentials credentials)
```
    The credentials needed to access the resource.
    
    Parameters:
    
    credentials - The credentials needed to access the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PipeSourceManagedStreamingKafkaParameters clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class PipeSourceManagedStreamingKafkaParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipeSourceManagedStreamingKafkaParameters

Method Detail

setTopicName

getTopicName

withTopicName

setStartingPosition

getStartingPosition

withStartingPosition

withStartingPosition

setBatchSize

getBatchSize

withBatchSize

setMaximumBatchingWindowInSeconds

getMaximumBatchingWindowInSeconds

withMaximumBatchingWindowInSeconds

setConsumerGroupID

getConsumerGroupID

withConsumerGroupID

setCredentials

getCredentials

withCredentials

toString

equals

hashCode

clone

marshall