PipeSourceSelfManagedKafkaParameters (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipeSourceSelfManagedKafkaParameters
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The parameters for using a self-managed Apache Kafka stream as a source.

A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipeSourceSelfManagedKafkaParameters()

Constructors
Constructor and Description
`PipeSourceSelfManagedKafkaParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipeSourceSelfManagedKafkaParameters`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAdditionalBootstrapServers()` An array of server URLs.
`Integer`	`getBatchSize()` The maximum number of records to include in each batch.
`String`	`getConsumerGroupID()` The name of the destination queue to consume.
`SelfManagedKafkaAccessConfigurationCredentials`	`getCredentials()` The credentials needed to access the resource.
`Integer`	`getMaximumBatchingWindowInSeconds()` The maximum length of a time to wait for events.
`String`	`getServerRootCaCertificate()` The ARN of the Secrets Manager secret used for certification.
`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.
`SelfManagedKafkaAccessConfigurationVpc`	`getVpc()` This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalBootstrapServers(Collection<String> additionalBootstrapServers)` An array of server URLs.
`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(SelfManagedKafkaAccessConfigurationCredentials credentials)` The credentials needed to access the resource.
`void`	`setMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)` The maximum length of a time to wait for events.
`void`	`setServerRootCaCertificate(String serverRootCaCertificate)` The ARN of the Secrets Manager secret used for certification.
`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.
`void`	`setVpc(SelfManagedKafkaAccessConfigurationVpc vpc)` This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
`String`	`toString()` Returns a string representation of this object.
`PipeSourceSelfManagedKafkaParameters`	`withAdditionalBootstrapServers(Collection<String> additionalBootstrapServers)` An array of server URLs.
`PipeSourceSelfManagedKafkaParameters`	`withAdditionalBootstrapServers(String... additionalBootstrapServers)` An array of server URLs.
`PipeSourceSelfManagedKafkaParameters`	`withBatchSize(Integer batchSize)` The maximum number of records to include in each batch.
`PipeSourceSelfManagedKafkaParameters`	`withConsumerGroupID(String consumerGroupID)` The name of the destination queue to consume.
`PipeSourceSelfManagedKafkaParameters`	`withCredentials(SelfManagedKafkaAccessConfigurationCredentials credentials)` The credentials needed to access the resource.
`PipeSourceSelfManagedKafkaParameters`	`withMaximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)` The maximum length of a time to wait for events.
`PipeSourceSelfManagedKafkaParameters`	`withServerRootCaCertificate(String serverRootCaCertificate)` The ARN of the Secrets Manager secret used for certification.
`PipeSourceSelfManagedKafkaParameters`	`withStartingPosition(SelfManagedKafkaStartPosition startingPosition)` (Streams only) The position in a stream from which to start reading.
`PipeSourceSelfManagedKafkaParameters`	`withStartingPosition(String startingPosition)` (Streams only) The position in a stream from which to start reading.
`PipeSourceSelfManagedKafkaParameters`	`withTopicName(String topicName)` The name of the topic that the pipe will read from.
`PipeSourceSelfManagedKafkaParameters`	`withVpc(SelfManagedKafkaAccessConfigurationVpc vpc)` This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

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

- Constructor Detail
  - PipeSourceSelfManagedKafkaParameters
```
public PipeSourceSelfManagedKafkaParameters()
```
- 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 PipeSourceSelfManagedKafkaParameters 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:
    
    SelfManagedKafkaStartPosition
  - 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:
    
    SelfManagedKafkaStartPosition
  - withStartingPosition
```
public PipeSourceSelfManagedKafkaParameters 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:
    
    SelfManagedKafkaStartPosition
  - withStartingPosition
```
public PipeSourceSelfManagedKafkaParameters withStartingPosition(SelfManagedKafkaStartPosition 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:
    
    SelfManagedKafkaStartPosition
  - getAdditionalBootstrapServers
```
public List<String> getAdditionalBootstrapServers()
```
    An array of server URLs.
    
    Returns:
    
    An array of server URLs.
  - setAdditionalBootstrapServers
```
public void setAdditionalBootstrapServers(Collection<String> additionalBootstrapServers)
```
    An array of server URLs.
    
    Parameters:
    
    additionalBootstrapServers - An array of server URLs.
  - withAdditionalBootstrapServers
```
public PipeSourceSelfManagedKafkaParameters withAdditionalBootstrapServers(String... additionalBootstrapServers)
```
    An array of server URLs.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalBootstrapServers(java.util.Collection) or withAdditionalBootstrapServers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    additionalBootstrapServers - An array of server URLs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdditionalBootstrapServers
```
public PipeSourceSelfManagedKafkaParameters withAdditionalBootstrapServers(Collection<String> additionalBootstrapServers)
```
    An array of server URLs.
    
    Parameters:
    
    additionalBootstrapServers - An array of server URLs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 PipeSourceSelfManagedKafkaParameters 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 PipeSourceSelfManagedKafkaParameters 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 PipeSourceSelfManagedKafkaParameters 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(SelfManagedKafkaAccessConfigurationCredentials credentials)
```
    The credentials needed to access the resource.
    
    Parameters:
    
    credentials - The credentials needed to access the resource.
  - getCredentials
```
public SelfManagedKafkaAccessConfigurationCredentials getCredentials()
```
    The credentials needed to access the resource.
    
    Returns:
    
    The credentials needed to access the resource.
  - withCredentials
```
public PipeSourceSelfManagedKafkaParameters withCredentials(SelfManagedKafkaAccessConfigurationCredentials 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.
  - setServerRootCaCertificate
```
public void setServerRootCaCertificate(String serverRootCaCertificate)
```
    The ARN of the Secrets Manager secret used for certification.
    
    Parameters:
    
    serverRootCaCertificate - The ARN of the Secrets Manager secret used for certification.
  - getServerRootCaCertificate
```
public String getServerRootCaCertificate()
```
    The ARN of the Secrets Manager secret used for certification.
    
    Returns:
    
    The ARN of the Secrets Manager secret used for certification.
  - withServerRootCaCertificate
```
public PipeSourceSelfManagedKafkaParameters withServerRootCaCertificate(String serverRootCaCertificate)
```
    The ARN of the Secrets Manager secret used for certification.
    
    Parameters:
    
    serverRootCaCertificate - The ARN of the Secrets Manager secret used for certification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpc
```
public void setVpc(SelfManagedKafkaAccessConfigurationVpc vpc)
```
    This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
    
    Parameters:
    
    vpc - This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
  - getVpc
```
public SelfManagedKafkaAccessConfigurationVpc getVpc()
```
    This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
    
    Returns:
    
    This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
  - withVpc
```
public PipeSourceSelfManagedKafkaParameters withVpc(SelfManagedKafkaAccessConfigurationVpc vpc)
```
    This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
    
    Parameters:
    
    vpc - This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
    
    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 PipeSourceSelfManagedKafkaParameters 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.777

Class PipeSourceSelfManagedKafkaParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipeSourceSelfManagedKafkaParameters

Method Detail

setTopicName

getTopicName

withTopicName

setStartingPosition

getStartingPosition

withStartingPosition

withStartingPosition

getAdditionalBootstrapServers

setAdditionalBootstrapServers

withAdditionalBootstrapServers

withAdditionalBootstrapServers

setBatchSize

getBatchSize

withBatchSize

setMaximumBatchingWindowInSeconds

getMaximumBatchingWindowInSeconds

withMaximumBatchingWindowInSeconds

setConsumerGroupID

getConsumerGroupID

withConsumerGroupID

setCredentials

getCredentials

withCredentials

setServerRootCaCertificate

getServerRootCaCertificate

withServerRootCaCertificate

setVpc

getVpc

withVpc

toString

equals

hashCode

clone

marshall