java.lang.Object
- software.amazon.awssdk.services.pipes.model.PipeSourceSelfManagedKafkaParameters

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<PipeSourceSelfManagedKafkaParameters.Builder,PipeSourceSelfManagedKafkaParameters>

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

The parameters for using a self-managed Apache Kafka stream as a source.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PipeSourceSelfManagedKafkaParameters.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`additionalBootstrapServers()`	An array of server URLs.
`Integer`	`batchSize()`	The maximum number of records to include in each batch.
`static PipeSourceSelfManagedKafkaParameters.Builder`	`builder()`
`String`	`consumerGroupID()`	The name of the destination queue to consume.
`SelfManagedKafkaAccessConfigurationCredentials`	`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)`
`boolean`	`hasAdditionalBootstrapServers()`	For responses, this returns true if the service returned a value for the AdditionalBootstrapServers property.
`int`	`hashCode()`
`Integer`	`maximumBatchingWindowInSeconds()`	The maximum length of a time to wait for events.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PipeSourceSelfManagedKafkaParameters.Builder>`	`serializableBuilderClass()`
`String`	`serverRootCaCertificate()`	The ARN of the Secrets Manager secret used for certification.
`SelfManagedKafkaStartPosition`	`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.
`PipeSourceSelfManagedKafkaParameters.Builder`	`toBuilder()`
`String`	`topicName()`	The name of the topic that the pipe will read from.
`String`	`toString()`	Returns a string representation of this object.
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasAdditionalBootstrapServers
```
public final boolean hasAdditionalBootstrapServers()
```
    For responses, this returns true if the service returned a value for the AdditionalBootstrapServers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - additionalBootstrapServers
```
public final List<String> additionalBootstrapServers()
```
    An array of server URLs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalBootstrapServers() method.
    
    Returns:
    
    An array of server URLs.
  - 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 SelfManagedKafkaAccessConfigurationCredentials 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.
  - serverRootCaCertificate
```
public final String serverRootCaCertificate()
```
    The ARN of the Secrets Manager secret used for certification.
    
    Returns:
    
    The ARN of the Secrets Manager secret used for certification.
  - startingPosition
```
public final SelfManagedKafkaStartPosition 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 SelfManagedKafkaStartPosition.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:
    
    SelfManagedKafkaStartPosition
  - 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 SelfManagedKafkaStartPosition.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:
    
    SelfManagedKafkaStartPosition
  - 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.
  - vpc
```
public final SelfManagedKafkaAccessConfigurationVpc vpc()
```
    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.
  - toBuilder
```
public PipeSourceSelfManagedKafkaParameters.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PipeSourceSelfManagedKafkaParameters.Builder,PipeSourceSelfManagedKafkaParameters>
  - builder
```
public static PipeSourceSelfManagedKafkaParameters.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PipeSourceSelfManagedKafkaParameters.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

Class PipeSourceSelfManagedKafkaParameters

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAdditionalBootstrapServers

additionalBootstrapServers

batchSize

consumerGroupID

credentials

maximumBatchingWindowInSeconds

serverRootCaCertificate

startingPosition

startingPositionAsString

topicName

vpc

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields