KafkaStreamingSourceOptions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.glue.model.KafkaStreamingSourceOptions

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Additional options for streaming.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KafkaStreamingSourceOptions()

Constructors
Constructor and Description
`KafkaStreamingSourceOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KafkaStreamingSourceOptions`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAddRecordTimestamp()` When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic.
`String`	`getAssign()` The specific `TopicPartitions` to consume.
`String`	`getBootstrapServers()` A list of bootstrap server URLs, for example, as `b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094`.
`String`	`getClassification()` An optional classification.
`String`	`getConnectionName()` The name of the connection.
`String`	`getDelimiter()` Specifies the delimiter character.
`String`	`getEmitConsumerLagMetrics()` When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch.
`String`	`getEndingOffsets()` The end point when a batch query is ended.
`Boolean`	`getIncludeHeaders()` Whether to include the Kafka headers.
`Long`	`getMaxOffsetsPerTrigger()` The rate limit on the maximum number of offsets that are processed per trigger interval.
`Integer`	`getMinPartitions()` The desired minimum number of partitions to read from Kafka.
`Integer`	`getNumRetries()` The number of times to retry before failing to fetch Kafka offsets.
`Long`	`getPollTimeoutMs()` The timeout in milliseconds to poll data from Kafka in Spark job executors.
`Long`	`getRetryIntervalMs()` The time in milliseconds to wait before retrying to fetch Kafka offsets.
`String`	`getSecurityProtocol()` The protocol used to communicate with brokers.
`String`	`getStartingOffsets()` The starting position in the Kafka topic to read data from.
`Date`	`getStartingTimestamp()` The timestamp of the record in the Kafka topic to start reading data from.
`String`	`getSubscribePattern()` A Java regex string that identifies the topic list to subscribe to.
`String`	`getTopicName()` The topic name as specified in Apache Kafka.
`int`	`hashCode()`
`Boolean`	`isIncludeHeaders()` Whether to include the Kafka headers.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAddRecordTimestamp(String addRecordTimestamp)` When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic.
`void`	`setAssign(String assign)` The specific `TopicPartitions` to consume.
`void`	`setBootstrapServers(String bootstrapServers)` A list of bootstrap server URLs, for example, as `b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094`.
`void`	`setClassification(String classification)` An optional classification.
`void`	`setConnectionName(String connectionName)` The name of the connection.
`void`	`setDelimiter(String delimiter)` Specifies the delimiter character.
`void`	`setEmitConsumerLagMetrics(String emitConsumerLagMetrics)` When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch.
`void`	`setEndingOffsets(String endingOffsets)` The end point when a batch query is ended.
`void`	`setIncludeHeaders(Boolean includeHeaders)` Whether to include the Kafka headers.
`void`	`setMaxOffsetsPerTrigger(Long maxOffsetsPerTrigger)` The rate limit on the maximum number of offsets that are processed per trigger interval.
`void`	`setMinPartitions(Integer minPartitions)` The desired minimum number of partitions to read from Kafka.
`void`	`setNumRetries(Integer numRetries)` The number of times to retry before failing to fetch Kafka offsets.
`void`	`setPollTimeoutMs(Long pollTimeoutMs)` The timeout in milliseconds to poll data from Kafka in Spark job executors.
`void`	`setRetryIntervalMs(Long retryIntervalMs)` The time in milliseconds to wait before retrying to fetch Kafka offsets.
`void`	`setSecurityProtocol(String securityProtocol)` The protocol used to communicate with brokers.
`void`	`setStartingOffsets(String startingOffsets)` The starting position in the Kafka topic to read data from.
`void`	`setStartingTimestamp(Date startingTimestamp)` The timestamp of the record in the Kafka topic to start reading data from.
`void`	`setSubscribePattern(String subscribePattern)` A Java regex string that identifies the topic list to subscribe to.
`void`	`setTopicName(String topicName)` The topic name as specified in Apache Kafka.
`String`	`toString()` Returns a string representation of this object.
`KafkaStreamingSourceOptions`	`withAddRecordTimestamp(String addRecordTimestamp)` When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic.
`KafkaStreamingSourceOptions`	`withAssign(String assign)` The specific `TopicPartitions` to consume.
`KafkaStreamingSourceOptions`	`withBootstrapServers(String bootstrapServers)` A list of bootstrap server URLs, for example, as `b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094`.
`KafkaStreamingSourceOptions`	`withClassification(String classification)` An optional classification.
`KafkaStreamingSourceOptions`	`withConnectionName(String connectionName)` The name of the connection.
`KafkaStreamingSourceOptions`	`withDelimiter(String delimiter)` Specifies the delimiter character.
`KafkaStreamingSourceOptions`	`withEmitConsumerLagMetrics(String emitConsumerLagMetrics)` When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch.
`KafkaStreamingSourceOptions`	`withEndingOffsets(String endingOffsets)` The end point when a batch query is ended.
`KafkaStreamingSourceOptions`	`withIncludeHeaders(Boolean includeHeaders)` Whether to include the Kafka headers.
`KafkaStreamingSourceOptions`	`withMaxOffsetsPerTrigger(Long maxOffsetsPerTrigger)` The rate limit on the maximum number of offsets that are processed per trigger interval.
`KafkaStreamingSourceOptions`	`withMinPartitions(Integer minPartitions)` The desired minimum number of partitions to read from Kafka.
`KafkaStreamingSourceOptions`	`withNumRetries(Integer numRetries)` The number of times to retry before failing to fetch Kafka offsets.
`KafkaStreamingSourceOptions`	`withPollTimeoutMs(Long pollTimeoutMs)` The timeout in milliseconds to poll data from Kafka in Spark job executors.
`KafkaStreamingSourceOptions`	`withRetryIntervalMs(Long retryIntervalMs)` The time in milliseconds to wait before retrying to fetch Kafka offsets.
`KafkaStreamingSourceOptions`	`withSecurityProtocol(String securityProtocol)` The protocol used to communicate with brokers.
`KafkaStreamingSourceOptions`	`withStartingOffsets(String startingOffsets)` The starting position in the Kafka topic to read data from.
`KafkaStreamingSourceOptions`	`withStartingTimestamp(Date startingTimestamp)` The timestamp of the record in the Kafka topic to start reading data from.
`KafkaStreamingSourceOptions`	`withSubscribePattern(String subscribePattern)` A Java regex string that identifies the topic list to subscribe to.
`KafkaStreamingSourceOptions`	`withTopicName(String topicName)` The topic name as specified in Apache Kafka.

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

- Constructor Detail
  - KafkaStreamingSourceOptions
```
public KafkaStreamingSourceOptions()
```
- Method Detail
  - setBootstrapServers
```
public void setBootstrapServers(String bootstrapServers)
```
    A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or defined in the table metadata in the Data Catalog.
    
    Parameters:
    
    bootstrapServers - A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or defined in the table metadata in the Data Catalog.
  - getBootstrapServers
```
public String getBootstrapServers()
```
    A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or defined in the table metadata in the Data Catalog.
    
    Returns:
    
    A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or defined in the table metadata in the Data Catalog.
  - withBootstrapServers
```
public KafkaStreamingSourceOptions withBootstrapServers(String bootstrapServers)
```
    A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or defined in the table metadata in the Data Catalog.
    
    Parameters:
    
    bootstrapServers - A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or defined in the table metadata in the Data Catalog.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityProtocol
```
public void setSecurityProtocol(String securityProtocol)
```
    The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".
    
    Parameters:
    
    securityProtocol - The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".
  - getSecurityProtocol
```
public String getSecurityProtocol()
```
    The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".
    
    Returns:
    
    The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".
  - withSecurityProtocol
```
public KafkaStreamingSourceOptions withSecurityProtocol(String securityProtocol)
```
    The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".
    
    Parameters:
    
    securityProtocol - The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectionName
```
public void setConnectionName(String connectionName)
```
    The name of the connection.
    
    Parameters:
    
    connectionName - The name of the connection.
  - getConnectionName
```
public String getConnectionName()
```
    The name of the connection.
    
    Returns:
    
    The name of the connection.
  - withConnectionName
```
public KafkaStreamingSourceOptions withConnectionName(String connectionName)
```
    The name of the connection.
    
    Parameters:
    
    connectionName - The name of the connection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTopicName
```
public void setTopicName(String topicName)
```
    The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Parameters:
    
    topicName - The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".
  - getTopicName
```
public String getTopicName()
```
    The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Returns:
    
    The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".
  - withTopicName
```
public KafkaStreamingSourceOptions withTopicName(String topicName)
```
    The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Parameters:
    
    topicName - The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAssign
```
public void setAssign(String assign)
```
    The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Parameters:
    
    assign - The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".
  - getAssign
```
public String getAssign()
```
    The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Returns:
    
    The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".
  - withAssign
```
public KafkaStreamingSourceOptions withAssign(String assign)
```
    The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Parameters:
    
    assign - The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubscribePattern
```
public void setSubscribePattern(String subscribePattern)
```
    A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Parameters:
    
    subscribePattern - A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or "subscribePattern".
  - getSubscribePattern
```
public String getSubscribePattern()
```
    A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Returns:
    
    A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or "subscribePattern".
  - withSubscribePattern
```
public KafkaStreamingSourceOptions withSubscribePattern(String subscribePattern)
```
    A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Parameters:
    
    subscribePattern - A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or "subscribePattern".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClassification
```
public void setClassification(String classification)
```
    An optional classification.
    
    Parameters:
    
    classification - An optional classification.
  - getClassification
```
public String getClassification()
```
    An optional classification.
    
    Returns:
    
    An optional classification.
  - withClassification
```
public KafkaStreamingSourceOptions withClassification(String classification)
```
    An optional classification.
    
    Parameters:
    
    classification - An optional classification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDelimiter
```
public void setDelimiter(String delimiter)
```
    Specifies the delimiter character.
    
    Parameters:
    
    delimiter - Specifies the delimiter character.
  - getDelimiter
```
public String getDelimiter()
```
    Specifies the delimiter character.
    
    Returns:
    
    Specifies the delimiter character.
  - withDelimiter
```
public KafkaStreamingSourceOptions withDelimiter(String delimiter)
```
    Specifies the delimiter character.
    
    Parameters:
    
    delimiter - Specifies the delimiter character.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartingOffsets
```
public void setStartingOffsets(String startingOffsets)
```
    The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is "latest".
    
    Parameters:
    
    startingOffsets - The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is "latest".
  - getStartingOffsets
```
public String getStartingOffsets()
```
    The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is "latest".
    
    Returns:
    
    The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is "latest".
  - withStartingOffsets
```
public KafkaStreamingSourceOptions withStartingOffsets(String startingOffsets)
```
    The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is "latest".
    
    Parameters:
    
    startingOffsets - The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is "latest".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndingOffsets
```
public void setEndingOffsets(String endingOffsets)
```
    The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition.
    
    Parameters:
    
    endingOffsets - The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition.
  - getEndingOffsets
```
public String getEndingOffsets()
```
    The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition.
    
    Returns:
    
    The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition.
  - withEndingOffsets
```
public KafkaStreamingSourceOptions withEndingOffsets(String endingOffsets)
```
    The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition.
    
    Parameters:
    
    endingOffsets - The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPollTimeoutMs
```
public void setPollTimeoutMs(Long pollTimeoutMs)
```
    The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512 .
    
    Parameters:
    
    pollTimeoutMs - The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512.
  - getPollTimeoutMs
```
public Long getPollTimeoutMs()
```
    The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512 .
    
    Returns:
    
    The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512.
  - withPollTimeoutMs
```
public KafkaStreamingSourceOptions withPollTimeoutMs(Long pollTimeoutMs)
```
    The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512 .
    
    Parameters:
    
    pollTimeoutMs - The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumRetries
```
public void setNumRetries(Integer numRetries)
```
    The number of times to retry before failing to fetch Kafka offsets. The default value is 3.
    
    Parameters:
    
    numRetries - The number of times to retry before failing to fetch Kafka offsets. The default value is 3.
  - getNumRetries
```
public Integer getNumRetries()
```
    The number of times to retry before failing to fetch Kafka offsets. The default value is 3.
    
    Returns:
    
    The number of times to retry before failing to fetch Kafka offsets. The default value is 3.
  - withNumRetries
```
public KafkaStreamingSourceOptions withNumRetries(Integer numRetries)
```
    The number of times to retry before failing to fetch Kafka offsets. The default value is 3.
    
    Parameters:
    
    numRetries - The number of times to retry before failing to fetch Kafka offsets. The default value is 3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetryIntervalMs
```
public void setRetryIntervalMs(Long retryIntervalMs)
```
    The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.
    
    Parameters:
    
    retryIntervalMs - The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.
  - getRetryIntervalMs
```
public Long getRetryIntervalMs()
```
    The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.
    
    Returns:
    
    The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.
  - withRetryIntervalMs
```
public KafkaStreamingSourceOptions withRetryIntervalMs(Long retryIntervalMs)
```
    The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.
    
    Parameters:
    
    retryIntervalMs - The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxOffsetsPerTrigger
```
public void setMaxOffsetsPerTrigger(Long maxOffsetsPerTrigger)
```
    The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
    
    Parameters:
    
    maxOffsetsPerTrigger - The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
  - getMaxOffsetsPerTrigger
```
public Long getMaxOffsetsPerTrigger()
```
    The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
    
    Returns:
    
    The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
  - withMaxOffsetsPerTrigger
```
public KafkaStreamingSourceOptions withMaxOffsetsPerTrigger(Long maxOffsetsPerTrigger)
```
    The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
    
    Parameters:
    
    maxOffsetsPerTrigger - The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinPartitions
```
public void setMinPartitions(Integer minPartitions)
```
    The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
    
    Parameters:
    
    minPartitions - The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
  - getMinPartitions
```
public Integer getMinPartitions()
```
    The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
    
    Returns:
    
    The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
  - withMinPartitions
```
public KafkaStreamingSourceOptions withMinPartitions(Integer minPartitions)
```
    The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
    
    Parameters:
    
    minPartitions - The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIncludeHeaders
```
public void setIncludeHeaders(Boolean includeHeaders)
```
    Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]. The default value is "false". This option is available in Glue version 3.0 or later only.
    
    Parameters:
    
    includeHeaders - Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]. The default value is "false". This option is available in Glue version 3.0 or later only.
  - getIncludeHeaders
```
public Boolean getIncludeHeaders()
```
    Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]. The default value is "false". This option is available in Glue version 3.0 or later only.
    
    Returns:
    
    Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]. The default value is "false". This option is available in Glue version 3.0 or later only.
  - withIncludeHeaders
```
public KafkaStreamingSourceOptions withIncludeHeaders(Boolean includeHeaders)
```
    Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]. The default value is "false". This option is available in Glue version 3.0 or later only.
    
    Parameters:
    
    includeHeaders - Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]. The default value is "false". This option is available in Glue version 3.0 or later only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeHeaders
```
public Boolean isIncludeHeaders()
```
    Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]. The default value is "false". This option is available in Glue version 3.0 or later only.
    
    Returns:
    
    Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type Array[Struct(key: String, value: String)]. The default value is "false". This option is available in Glue version 3.0 or later only.
  - setAddRecordTimestamp
```
public void setAddRecordTimestamp(String addRecordTimestamp)
```
    When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
    
    Parameters:
    
    addRecordTimestamp - When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
  - getAddRecordTimestamp
```
public String getAddRecordTimestamp()
```
    When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
    
    Returns:
    
    When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
  - withAddRecordTimestamp
```
public KafkaStreamingSourceOptions withAddRecordTimestamp(String addRecordTimestamp)
```
    When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
    
    Parameters:
    
    addRecordTimestamp - When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmitConsumerLagMetrics
```
public void setEmitConsumerLagMetrics(String emitConsumerLagMetrics)
```
    When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
    
    Parameters:
    
    emitConsumerLagMetrics - When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
  - getEmitConsumerLagMetrics
```
public String getEmitConsumerLagMetrics()
```
    When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
    
    Returns:
    
    When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
  - withEmitConsumerLagMetrics
```
public KafkaStreamingSourceOptions withEmitConsumerLagMetrics(String emitConsumerLagMetrics)
```
    When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
    
    Parameters:
    
    emitConsumerLagMetrics - When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartingTimestamp
```
public void setStartingTimestamp(Date startingTimestamp)
```
    The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
    
    Only one of StartingTimestamp or StartingOffsets must be set.
    
    Parameters:
    
    startingTimestamp - The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
    
    Only one of StartingTimestamp or StartingOffsets must be set.
  - getStartingTimestamp
```
public Date getStartingTimestamp()
```
    The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
    
    Only one of StartingTimestamp or StartingOffsets must be set.
    
    Returns:
    
    The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
    
    Only one of StartingTimestamp or StartingOffsets must be set.
  - withStartingTimestamp
```
public KafkaStreamingSourceOptions withStartingTimestamp(Date startingTimestamp)
```
    The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
    
    Only one of StartingTimestamp or StartingOffsets must be set.
    
    Parameters:
    
    startingTimestamp - The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
    
    Only one of StartingTimestamp or StartingOffsets must be set.
    
    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 KafkaStreamingSourceOptions 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.773

Class KafkaStreamingSourceOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KafkaStreamingSourceOptions

Method Detail

setBootstrapServers

getBootstrapServers

withBootstrapServers

setSecurityProtocol

getSecurityProtocol

withSecurityProtocol

setConnectionName

getConnectionName

withConnectionName

setTopicName

getTopicName

withTopicName

setAssign

getAssign

withAssign

setSubscribePattern

getSubscribePattern

withSubscribePattern

setClassification

getClassification

withClassification

setDelimiter

getDelimiter

withDelimiter

setStartingOffsets

getStartingOffsets

withStartingOffsets

setEndingOffsets

getEndingOffsets

withEndingOffsets

setPollTimeoutMs

getPollTimeoutMs

withPollTimeoutMs

setNumRetries

getNumRetries

withNumRetries

setRetryIntervalMs

getRetryIntervalMs

withRetryIntervalMs

setMaxOffsetsPerTrigger

getMaxOffsetsPerTrigger

withMaxOffsetsPerTrigger

setMinPartitions

getMinPartitions

withMinPartitions

setIncludeHeaders

getIncludeHeaders

withIncludeHeaders

isIncludeHeaders

setAddRecordTimestamp

getAddRecordTimestamp

withAddRecordTimestamp

setEmitConsumerLagMetrics

getEmitConsumerLagMetrics

withEmitConsumerLagMetrics

setStartingTimestamp

getStartingTimestamp

withStartingTimestamp

toString

equals

hashCode

clone

marshall