Package com.hazelcast.jet.kinesis
Class KinesisSinks.Builder<T>
java.lang.Object
com.hazelcast.jet.kinesis.KinesisSinks.Builder<T>
- Type Parameters:
T
- Type of items ingested by this sink
- Enclosing class:
- KinesisSinks
Fluent builder for constructing the Kinesis sink and setting its
configuration parameters.
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Construct the sink based on the options provided so far.withCredentials
(String accessKey, String secretKey) Specifies the AWS credentials to use for authentication purposes.withEndpoint
(String endpoint) Specifies the AWS Kinesis endpoint (URL of the entry point for the AWS web service) to connect to.withExecutorServiceSupplier
(SupplierEx<ExecutorService> executorSupplier) Specifies an executor service supplier that will be used by theAwsConfig
to construct an AWS async client.withRegion
(String region) Specifies the AWS Region (collection of AWS resources in a geographic area) to connect to.withRetryStrategy
(RetryStrategy retryStrategy) Specifies how the source should behave when reading data from the stream fails.
-
Method Details
-
withEndpoint
Specifies the AWS Kinesis endpoint (URL of the entry point for the AWS web service) to connect to. The general syntax of these endpoint URLs is "protocol://service-code.region-code.amazonaws.com
", so for example, for Kinesis, for theus-west-2
region, we could have "https://dynamodb.us-west-2.amazonaws.com
". For local testing, it might be "http://localhost:4566
".If not specified (or specified as
null
), the default endpoint for the specified region will be used. -
withRegion
Specifies the AWS Region (collection of AWS resources in a geographic area) to connect to. Region names are of form "us-west-1
", "eu-central-1
" and so on.If not specified (or specified as
null
), the default region set via external means will be used (either from your local.aws/config
file or theAWS_REGION
environment variable). If no such default is set, then "us-east-1
" will be used. -
withCredentials
@Nonnull public KinesisSinks.Builder<T> withCredentials(@Nullable String accessKey, @Nullable String secretKey) Specifies the AWS credentials to use for authentication purposes.If not specified (or specified as
null
), then keys specified via external means will be used. This can mean the local.aws/credentials
file or theAWS_ACCESS_KEY_ID
andAWS_SECRET_ACCESS_KEY
environmental variables.Either both keys must be set to non-null values or neither.
-
withRetryStrategy
Specifies how the source should behave when reading data from the stream fails. The default behavior retries the read operation indefinitely, but after an exponentially increasing delay, it starts with 100 milliseconds and doubles on each subsequent failure. A successful read resets it. The delay is capped at 3 seconds. -
withExecutorServiceSupplier
@Nonnull public KinesisSinks.Builder<T> withExecutorServiceSupplier(@Nonnull SupplierEx<ExecutorService> executorSupplier) Specifies an executor service supplier that will be used by theAwsConfig
to construct an AWS async client.- Since:
- 5.2
-
build
Construct the sink based on the options provided so far.
-