KinesisStreamingSourceOptions (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KinesisStreamingSourceOptions
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Additional options for the Amazon Kinesis streaming data source.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KinesisStreamingSourceOptions()

Constructors
Constructor and Description
`KinesisStreamingSourceOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KinesisStreamingSourceOptions`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAddIdleTimeBetweenReads()` Adds a time delay between two consecutive getRecords operations.
`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 stream.
`Boolean`	`getAvoidEmptyBatches()` Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started.
`String`	`getClassification()` An optional classification.
`String`	`getDelimiter()` Specifies the delimiter character.
`Long`	`getDescribeShardInterval()` The minimum time interval between two ListShards API calls for your script to consider resharding.
`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 stream and the time it arrives in Glue to CloudWatch.
`String`	`getEndpointUrl()` The URL of the Kinesis endpoint.
`Long`	`getIdleTimeBetweenReadsInMs()` The minimum time delay between two consecutive getRecords operations, specified in ms.
`Long`	`getMaxFetchRecordsPerShard()` The maximum number of records to fetch per shard in the Kinesis data stream.
`Long`	`getMaxFetchTimeInMs()` The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms).
`Long`	`getMaxRecordPerRead()` The maximum number of records to fetch from the Kinesis data stream in each getRecords operation.
`Long`	`getMaxRetryIntervalMs()` The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call.
`Integer`	`getNumRetries()` The maximum number of retries for Kinesis Data Streams API requests.
`Long`	`getRetryIntervalMs()` The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS).
`String`	`getRoleSessionName()` An identifier for the session assuming the role using AWS STS.
`String`	`getStartingPosition()` The starting position in the Kinesis data stream to read data from.
`Date`	`getStartingTimestamp()` The timestamp of the record in the Kinesis data stream to start reading data from.
`String`	`getStreamArn()` The Amazon Resource Name (ARN) of the Kinesis data stream.
`String`	`getStreamName()` The name of the Kinesis data stream.
`int`	`hashCode()`
`Boolean`	`isAddIdleTimeBetweenReads()` Adds a time delay between two consecutive getRecords operations.
`Boolean`	`isAvoidEmptyBatches()` Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAddIdleTimeBetweenReads(Boolean addIdleTimeBetweenReads)` Adds a time delay between two consecutive getRecords operations.
`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 stream.
`void`	`setAvoidEmptyBatches(Boolean avoidEmptyBatches)` Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started.
`void`	`setClassification(String classification)` An optional classification.
`void`	`setDelimiter(String delimiter)` Specifies the delimiter character.
`void`	`setDescribeShardInterval(Long describeShardInterval)` The minimum time interval between two ListShards API calls for your script to consider resharding.
`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 stream and the time it arrives in Glue to CloudWatch.
`void`	`setEndpointUrl(String endpointUrl)` The URL of the Kinesis endpoint.
`void`	`setIdleTimeBetweenReadsInMs(Long idleTimeBetweenReadsInMs)` The minimum time delay between two consecutive getRecords operations, specified in ms.
`void`	`setMaxFetchRecordsPerShard(Long maxFetchRecordsPerShard)` The maximum number of records to fetch per shard in the Kinesis data stream.
`void`	`setMaxFetchTimeInMs(Long maxFetchTimeInMs)` The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms).
`void`	`setMaxRecordPerRead(Long maxRecordPerRead)` The maximum number of records to fetch from the Kinesis data stream in each getRecords operation.
`void`	`setMaxRetryIntervalMs(Long maxRetryIntervalMs)` The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call.
`void`	`setNumRetries(Integer numRetries)` The maximum number of retries for Kinesis Data Streams API requests.
`void`	`setRetryIntervalMs(Long retryIntervalMs)` The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS).
`void`	`setRoleSessionName(String roleSessionName)` An identifier for the session assuming the role using AWS STS.
`void`	`setStartingPosition(String startingPosition)` The starting position in the Kinesis data stream to read data from.
`void`	`setStartingTimestamp(Date startingTimestamp)` The timestamp of the record in the Kinesis data stream to start reading data from.
`void`	`setStreamArn(String streamArn)` The Amazon Resource Name (ARN) of the Kinesis data stream.
`void`	`setStreamName(String streamName)` The name of the Kinesis data stream.
`String`	`toString()` Returns a string representation of this object.
`KinesisStreamingSourceOptions`	`withAddIdleTimeBetweenReads(Boolean addIdleTimeBetweenReads)` Adds a time delay between two consecutive getRecords operations.
`KinesisStreamingSourceOptions`	`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 stream.
`KinesisStreamingSourceOptions`	`withAvoidEmptyBatches(Boolean avoidEmptyBatches)` Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started.
`KinesisStreamingSourceOptions`	`withClassification(String classification)` An optional classification.
`KinesisStreamingSourceOptions`	`withDelimiter(String delimiter)` Specifies the delimiter character.
`KinesisStreamingSourceOptions`	`withDescribeShardInterval(Long describeShardInterval)` The minimum time interval between two ListShards API calls for your script to consider resharding.
`KinesisStreamingSourceOptions`	`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 stream and the time it arrives in Glue to CloudWatch.
`KinesisStreamingSourceOptions`	`withEndpointUrl(String endpointUrl)` The URL of the Kinesis endpoint.
`KinesisStreamingSourceOptions`	`withIdleTimeBetweenReadsInMs(Long idleTimeBetweenReadsInMs)` The minimum time delay between two consecutive getRecords operations, specified in ms.
`KinesisStreamingSourceOptions`	`withMaxFetchRecordsPerShard(Long maxFetchRecordsPerShard)` The maximum number of records to fetch per shard in the Kinesis data stream.
`KinesisStreamingSourceOptions`	`withMaxFetchTimeInMs(Long maxFetchTimeInMs)` The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms).
`KinesisStreamingSourceOptions`	`withMaxRecordPerRead(Long maxRecordPerRead)` The maximum number of records to fetch from the Kinesis data stream in each getRecords operation.
`KinesisStreamingSourceOptions`	`withMaxRetryIntervalMs(Long maxRetryIntervalMs)` The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call.
`KinesisStreamingSourceOptions`	`withNumRetries(Integer numRetries)` The maximum number of retries for Kinesis Data Streams API requests.
`KinesisStreamingSourceOptions`	`withRetryIntervalMs(Long retryIntervalMs)` The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call.
`KinesisStreamingSourceOptions`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS).
`KinesisStreamingSourceOptions`	`withRoleSessionName(String roleSessionName)` An identifier for the session assuming the role using AWS STS.
`KinesisStreamingSourceOptions`	`withStartingPosition(StartingPosition startingPosition)` The starting position in the Kinesis data stream to read data from.
`KinesisStreamingSourceOptions`	`withStartingPosition(String startingPosition)` The starting position in the Kinesis data stream to read data from.
`KinesisStreamingSourceOptions`	`withStartingTimestamp(Date startingTimestamp)` The timestamp of the record in the Kinesis data stream to start reading data from.
`KinesisStreamingSourceOptions`	`withStreamArn(String streamArn)` The Amazon Resource Name (ARN) of the Kinesis data stream.
`KinesisStreamingSourceOptions`	`withStreamName(String streamName)` The name of the Kinesis data stream.

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

- Constructor Detail
  - KinesisStreamingSourceOptions
```
public KinesisStreamingSourceOptions()
```
- Method Detail
  - setEndpointUrl
```
public void setEndpointUrl(String endpointUrl)
```
    The URL of the Kinesis endpoint.
    
    Parameters:
    
    endpointUrl - The URL of the Kinesis endpoint.
  - getEndpointUrl
```
public String getEndpointUrl()
```
    The URL of the Kinesis endpoint.
    
    Returns:
    
    The URL of the Kinesis endpoint.
  - withEndpointUrl
```
public KinesisStreamingSourceOptions withEndpointUrl(String endpointUrl)
```
    The URL of the Kinesis endpoint.
    
    Parameters:
    
    endpointUrl - The URL of the Kinesis endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStreamName
```
public void setStreamName(String streamName)
```
    The name of the Kinesis data stream.
    
    Parameters:
    
    streamName - The name of the Kinesis data stream.
  - getStreamName
```
public String getStreamName()
```
    The name of the Kinesis data stream.
    
    Returns:
    
    The name of the Kinesis data stream.
  - withStreamName
```
public KinesisStreamingSourceOptions withStreamName(String streamName)
```
    The name of the Kinesis data stream.
    
    Parameters:
    
    streamName - The name of the Kinesis data stream.
    
    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 KinesisStreamingSourceOptions 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 KinesisStreamingSourceOptions 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.
  - setStartingPosition
```
public void setStartingPosition(String startingPosition)
```
    The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", "earliest", or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest".
    
    Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
    
    Parameters:
    
    startingPosition - The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", "earliest", or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest" .
    
    Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
    
    See Also:
    
    StartingPosition
  - getStartingPosition
```
public String getStartingPosition()
```
    The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", "earliest", or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest".
    
    Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
    
    Returns:
    
    The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", "earliest", or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest" .
    
    Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
    
    See Also:
    
    StartingPosition
  - withStartingPosition
```
public KinesisStreamingSourceOptions withStartingPosition(String startingPosition)
```
    The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", "earliest", or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest".
    
    Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
    
    Parameters:
    
    startingPosition - The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", "earliest", or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest" .
    
    Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StartingPosition
  - withStartingPosition
```
public KinesisStreamingSourceOptions withStartingPosition(StartingPosition startingPosition)
```
    The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", "earliest", or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest".
    
    Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
    
    Parameters:
    
    startingPosition - The starting position in the Kinesis data stream to read data from. The possible values are "latest", "trim_horizon", "earliest", or a timestamp string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is "latest" .
    
    Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StartingPosition
  - setMaxFetchTimeInMs
```
public void setMaxFetchTimeInMs(Long maxFetchTimeInMs)
```
    The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
    
    Parameters:
    
    maxFetchTimeInMs - The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
  - getMaxFetchTimeInMs
```
public Long getMaxFetchTimeInMs()
```
    The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
    
    Returns:
    
    The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
  - withMaxFetchTimeInMs
```
public KinesisStreamingSourceOptions withMaxFetchTimeInMs(Long maxFetchTimeInMs)
```
    The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
    
    Parameters:
    
    maxFetchTimeInMs - The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxFetchRecordsPerShard
```
public void setMaxFetchRecordsPerShard(Long maxFetchRecordsPerShard)
```
    The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
    
    Parameters:
    
    maxFetchRecordsPerShard - The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
  - getMaxFetchRecordsPerShard
```
public Long getMaxFetchRecordsPerShard()
```
    The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
    
    Returns:
    
    The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
  - withMaxFetchRecordsPerShard
```
public KinesisStreamingSourceOptions withMaxFetchRecordsPerShard(Long maxFetchRecordsPerShard)
```
    The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
    
    Parameters:
    
    maxFetchRecordsPerShard - The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxRecordPerRead
```
public void setMaxRecordPerRead(Long maxRecordPerRead)
```
    The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000.
    
    Parameters:
    
    maxRecordPerRead - The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000.
  - getMaxRecordPerRead
```
public Long getMaxRecordPerRead()
```
    The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000.
    
    Returns:
    
    The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000.
  - withMaxRecordPerRead
```
public KinesisStreamingSourceOptions withMaxRecordPerRead(Long maxRecordPerRead)
```
    The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000.
    
    Parameters:
    
    maxRecordPerRead - The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAddIdleTimeBetweenReads
```
public void setAddIdleTimeBetweenReads(Boolean addIdleTimeBetweenReads)
```
    Adds a time delay between two consecutive getRecords operations. The default value is "False". This option is only configurable for Glue version 2.0 and above.
    
    Parameters:
    
    addIdleTimeBetweenReads - Adds a time delay between two consecutive getRecords operations. The default value is "False" . This option is only configurable for Glue version 2.0 and above.
  - getAddIdleTimeBetweenReads
```
public Boolean getAddIdleTimeBetweenReads()
```
    Adds a time delay between two consecutive getRecords operations. The default value is "False". This option is only configurable for Glue version 2.0 and above.
    
    Returns:
    
    Adds a time delay between two consecutive getRecords operations. The default value is "False". This option is only configurable for Glue version 2.0 and above.
  - withAddIdleTimeBetweenReads
```
public KinesisStreamingSourceOptions withAddIdleTimeBetweenReads(Boolean addIdleTimeBetweenReads)
```
    Adds a time delay between two consecutive getRecords operations. The default value is "False". This option is only configurable for Glue version 2.0 and above.
    
    Parameters:
    
    addIdleTimeBetweenReads - Adds a time delay between two consecutive getRecords operations. The default value is "False" . This option is only configurable for Glue version 2.0 and above.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAddIdleTimeBetweenReads
```
public Boolean isAddIdleTimeBetweenReads()
```
    Adds a time delay between two consecutive getRecords operations. The default value is "False". This option is only configurable for Glue version 2.0 and above.
    
    Returns:
    
    Adds a time delay between two consecutive getRecords operations. The default value is "False". This option is only configurable for Glue version 2.0 and above.
  - setIdleTimeBetweenReadsInMs
```
public void setIdleTimeBetweenReadsInMs(Long idleTimeBetweenReadsInMs)
```
    The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000. This option is only configurable for Glue version 2.0 and above.
    
    Parameters:
    
    idleTimeBetweenReadsInMs - The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000. This option is only configurable for Glue version 2.0 and above.
  - getIdleTimeBetweenReadsInMs
```
public Long getIdleTimeBetweenReadsInMs()
```
    The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000. This option is only configurable for Glue version 2.0 and above.
    
    Returns:
    
    The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000. This option is only configurable for Glue version 2.0 and above.
  - withIdleTimeBetweenReadsInMs
```
public KinesisStreamingSourceOptions withIdleTimeBetweenReadsInMs(Long idleTimeBetweenReadsInMs)
```
    The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000. This option is only configurable for Glue version 2.0 and above.
    
    Parameters:
    
    idleTimeBetweenReadsInMs - The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000. This option is only configurable for Glue version 2.0 and above.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescribeShardInterval
```
public void setDescribeShardInterval(Long describeShardInterval)
```
    The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s.
    
    Parameters:
    
    describeShardInterval - The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s.
  - getDescribeShardInterval
```
public Long getDescribeShardInterval()
```
    The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s.
    
    Returns:
    
    The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s.
  - withDescribeShardInterval
```
public KinesisStreamingSourceOptions withDescribeShardInterval(Long describeShardInterval)
```
    The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s.
    
    Parameters:
    
    describeShardInterval - The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumRetries
```
public void setNumRetries(Integer numRetries)
```
    The maximum number of retries for Kinesis Data Streams API requests. The default value is 3.
    
    Parameters:
    
    numRetries - The maximum number of retries for Kinesis Data Streams API requests. The default value is 3.
  - getNumRetries
```
public Integer getNumRetries()
```
    The maximum number of retries for Kinesis Data Streams API requests. The default value is 3.
    
    Returns:
    
    The maximum number of retries for Kinesis Data Streams API requests. The default value is 3.
  - withNumRetries
```
public KinesisStreamingSourceOptions withNumRetries(Integer numRetries)
```
    The maximum number of retries for Kinesis Data Streams API requests. The default value is 3.
    
    Parameters:
    
    numRetries - The maximum number of retries for Kinesis Data Streams API requests. 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 cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000.
    
    Parameters:
    
    retryIntervalMs - The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000.
  - getRetryIntervalMs
```
public Long getRetryIntervalMs()
```
    The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000.
    
    Returns:
    
    The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000.
  - withRetryIntervalMs
```
public KinesisStreamingSourceOptions withRetryIntervalMs(Long retryIntervalMs)
```
    The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000.
    
    Parameters:
    
    retryIntervalMs - The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxRetryIntervalMs
```
public void setMaxRetryIntervalMs(Long maxRetryIntervalMs)
```
    The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000.
    
    Parameters:
    
    maxRetryIntervalMs - The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000.
  - getMaxRetryIntervalMs
```
public Long getMaxRetryIntervalMs()
```
    The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000.
    
    Returns:
    
    The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000.
  - withMaxRetryIntervalMs
```
public KinesisStreamingSourceOptions withMaxRetryIntervalMs(Long maxRetryIntervalMs)
```
    The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000.
    
    Parameters:
    
    maxRetryIntervalMs - The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAvoidEmptyBatches
```
public void setAvoidEmptyBatches(Boolean avoidEmptyBatches)
```
    Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
    
    Parameters:
    
    avoidEmptyBatches - Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
  - getAvoidEmptyBatches
```
public Boolean getAvoidEmptyBatches()
```
    Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
    
    Returns:
    
    Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
  - withAvoidEmptyBatches
```
public KinesisStreamingSourceOptions withAvoidEmptyBatches(Boolean avoidEmptyBatches)
```
    Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
    
    Parameters:
    
    avoidEmptyBatches - Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAvoidEmptyBatches
```
public Boolean isAvoidEmptyBatches()
```
    Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
    
    Returns:
    
    Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is "False".
  - setStreamArn
```
public void setStreamArn(String streamArn)
```
    The Amazon Resource Name (ARN) of the Kinesis data stream.
    
    Parameters:
    
    streamArn - The Amazon Resource Name (ARN) of the Kinesis data stream.
  - getStreamArn
```
public String getStreamArn()
```
    The Amazon Resource Name (ARN) of the Kinesis data stream.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Kinesis data stream.
  - withStreamArn
```
public KinesisStreamingSourceOptions withStreamArn(String streamArn)
```
    The Amazon Resource Name (ARN) of the Kinesis data stream.
    
    Parameters:
    
    streamArn - The Amazon Resource Name (ARN) of the Kinesis data stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName".
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName".
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName".
    
    Returns:
    
    The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName".
  - withRoleArn
```
public KinesisStreamingSourceOptions withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName".
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSSessionName".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleSessionName
```
public void setRoleSessionName(String roleSessionName)
```
    An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN".
    
    Parameters:
    
    roleSessionName - An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN".
  - getRoleSessionName
```
public String getRoleSessionName()
```
    An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN".
    
    Returns:
    
    An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN".
  - withRoleSessionName
```
public KinesisStreamingSourceOptions withRoleSessionName(String roleSessionName)
```
    An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN".
    
    Parameters:
    
    roleSessionName - An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with "awsSTSRoleARN".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 stream. 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 stream. 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 stream. 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 stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
  - withAddRecordTimestamp
```
public KinesisStreamingSourceOptions 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 stream. 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 stream. 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 stream 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 stream 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 stream 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 stream 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 KinesisStreamingSourceOptions 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 stream 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 stream 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 Kinesis data stream 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").
    
    Parameters:
    
    startingTimestamp - The timestamp of the record in the Kinesis data stream 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").
  - getStartingTimestamp
```
public Date getStartingTimestamp()
```
    The timestamp of the record in the Kinesis data stream 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").
    
    Returns:
    
    The timestamp of the record in the Kinesis data stream 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").
  - withStartingTimestamp
```
public KinesisStreamingSourceOptions withStartingTimestamp(Date startingTimestamp)
```
    The timestamp of the record in the Kinesis data stream 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").
    
    Parameters:
    
    startingTimestamp - The timestamp of the record in the Kinesis data stream 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").
    
    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 KinesisStreamingSourceOptions 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.679

Class KinesisStreamingSourceOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KinesisStreamingSourceOptions

Method Detail

setEndpointUrl

getEndpointUrl

withEndpointUrl

setStreamName

getStreamName

withStreamName

setClassification

getClassification

withClassification

setDelimiter

getDelimiter

withDelimiter

setStartingPosition

getStartingPosition

withStartingPosition

withStartingPosition

setMaxFetchTimeInMs

getMaxFetchTimeInMs

withMaxFetchTimeInMs

setMaxFetchRecordsPerShard

getMaxFetchRecordsPerShard

withMaxFetchRecordsPerShard

setMaxRecordPerRead

getMaxRecordPerRead

withMaxRecordPerRead

setAddIdleTimeBetweenReads

getAddIdleTimeBetweenReads

withAddIdleTimeBetweenReads

isAddIdleTimeBetweenReads

setIdleTimeBetweenReadsInMs

getIdleTimeBetweenReadsInMs

withIdleTimeBetweenReadsInMs

setDescribeShardInterval

getDescribeShardInterval

withDescribeShardInterval

setNumRetries

getNumRetries

withNumRetries

setRetryIntervalMs

getRetryIntervalMs

withRetryIntervalMs

setMaxRetryIntervalMs

getMaxRetryIntervalMs

withMaxRetryIntervalMs

setAvoidEmptyBatches

getAvoidEmptyBatches

withAvoidEmptyBatches

isAvoidEmptyBatches

setStreamArn

getStreamArn

withStreamArn

setRoleArn

getRoleArn

withRoleArn

setRoleSessionName

getRoleSessionName

withRoleSessionName

setAddRecordTimestamp

getAddRecordTimestamp

withAddRecordTimestamp

setEmitConsumerLagMetrics

getEmitConsumerLagMetrics

withEmitConsumerLagMetrics

setStartingTimestamp

getStartingTimestamp

withStartingTimestamp

toString

equals

hashCode

clone

marshall