KinesisProducerConfiguration (Amazon Kinesis Producer Library 0.14.8 API)

java.lang.Object
- com.amazonaws.services.kinesis.producer.KinesisProducerConfiguration

```
public class KinesisProducerConfiguration
extends Object
```
Configuration for KinesisProducer. See each each individual set method for details about each parameter.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`KinesisProducerConfiguration.ThreadingModel` Configures the threading model used by the native process for handling requests to AWS Services.

Constructor Summary

Constructors
Constructor and Description

KinesisProducerConfiguration()

Constructors
Constructor and Description
`KinesisProducerConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAdditionalMetricsDimension(String key, String value, String granularity)` Add an additional, custom dimension to the metrics emitted by the KPL.
`protected com.amazonaws.services.kinesis.producer.protobuf.Config.Configuration.Builder`	`additionalConfigsToProtobuf(com.amazonaws.services.kinesis.producer.protobuf.Config.Configuration.Builder builder)`
`static KinesisProducerConfiguration`	`fromProperties(Properties props)` Load configuration from a `Properties` object.
`static KinesisProducerConfiguration`	`fromPropertiesFile(String path)` Load configuration from a properties file.
`long`	`getAggregationMaxCount()` Maximum number of items to pack into an aggregated record.
`long`	`getAggregationMaxSize()` Maximum number of bytes to pack into an aggregated Kinesis record.
`String`	`getCaCertPath()` Return the provided cacert path
`String`	`getCloudwatchEndpoint()` Use a custom CloudWatch endpoint.
`long`	`getCloudwatchPort()` Server port to connect to for CloudWatch.
`long`	`getCollectionMaxCount()` Maximum number of items to pack into an PutRecords request.
`long`	`getCollectionMaxSize()` Maximum amount of data to send with a PutRecords request.
`long`	`getConnectTimeout()` Timeout (milliseconds) for establishing TLS connections.
`com.amazonaws.auth.AWSCredentialsProvider`	`getCredentialsProvider()` `AWSCredentialsProvider` that supplies credentials used to put records to Kinesis.
`long`	`getCredentialsRefreshDelay()` How often to refresh credentials (in milliseconds).
`com.amazonaws.services.schemaregistry.common.configs.GlueSchemaRegistryConfiguration`	`getGlueSchemaRegistryConfiguration()` Return the set `GlueSchemaRegistryConfiguration` that has configuration options for Glue Schema Registry serializer to function.
`software.amazon.awssdk.auth.credentials.AwsCredentialsProvider`	`getGlueSchemaRegistryCredentialsProvider()` `AwsCredentialsProvider` that supplies credentials used to query AWS Glue Schema Registry.
`String`	`getGlueSchemaRegistryPropertiesFilePath()` Return the Property file path set for reading the `GlueSchemaRegistryConfiguration`.
`String`	`getKinesisEndpoint()` Use a custom Kinesis endpoint.
`long`	`getKinesisPort()` Server port to connect to for Kinesis.
`String`	`getLogLevel()` Minimum level of logs.
`long`	`getMaxConnections()` Maximum number of connections to open to the backend.
`com.amazonaws.auth.AWSCredentialsProvider`	`getMetricsCredentialsProvider()` `AWSCredentialsProvider` that supplies credentials used to upload metrics to CloudWatch.
`String`	`getMetricsGranularity()` Controls the granularity of metrics that are uploaded to CloudWatch.
`String`	`getMetricsLevel()` Controls the number of metrics that are uploaded to CloudWatch.
`String`	`getMetricsNamespace()` The namespace to upload metrics under.
`long`	`getMetricsUploadDelay()` Delay (in milliseconds) between each metrics upload.
`long`	`getMinConnections()` Minimum number of connections to keep open to the backend.
`String`	`getNativeExecutable()` Path to the native KPL binary.
`String`	`getProxyHost()` If you have users going through a proxy, get the host here.
`String`	`getProxyPassword()` If you have users going through a proxy, get the password here.
`long`	`getProxyPort()` If you have users going through a proxy, get the port here.
`String`	`getProxyUserName()` If you have users going through a proxy, get the user name here.
`long`	`getRateLimit()` Limits the maximum allowed put rate for a shard, as a percentage of the backend limits.
`long`	`getRecordMaxBufferedTime()` Maximum amount of time (milliseconds) a record may spend being buffered before it gets sent.
`long`	`getRecordTtl()` Set a time-to-live on records (milliseconds).
`String`	`getRegion()` Which region to send records to.
`long`	`getRequestTimeout()` The maximum total time (milliseconds) elapsed between when we begin a HTTP request and receiving all of the response.
`String`	`getTempDirectory()` Temp directory into which to extract the native binaries.
`KinesisProducerConfiguration.ThreadingModel`	`getThreadingModel()` Returns the threading model that the native process will use to handle requests to AWS services
`int`	`getThreadPoolSize()` This configures the maximum number of threads the thread pool in the native process will use.
`long`	`getUserRecordTimeoutInMillis()` Value in millis when the user submitted records will be timed out at the Java layer.
`boolean`	`isAggregationEnabled()` Enable aggregation.
`boolean`	`isEnableCoreDumps()` This has no effect on Windows.
`boolean`	`isFailIfThrottled()` If true, throttled puts are not retried.
`boolean`	`isVerifyCertificate()` Verify SSL certificates.
`KinesisProducerConfiguration`	`setAggregationEnabled(boolean val)` Enable aggregation.
`KinesisProducerConfiguration`	`setAggregationMaxCount(long val)` Maximum number of items to pack into an aggregated record.
`KinesisProducerConfiguration`	`setAggregationMaxSize(long val)` Maximum number of bytes to pack into an aggregated Kinesis record.
`KinesisProducerConfiguration`	`setCaCertPath(String val)` Use a provided cacert path to use which should be a full path to the cert location.
`KinesisProducerConfiguration`	`setCloudwatchEndpoint(String val)` Use a custom CloudWatch endpoint.
`KinesisProducerConfiguration`	`setCloudwatchPort(long val)` Server port to connect to for CloudWatch.
`KinesisProducerConfiguration`	`setCollectionMaxCount(long val)` Maximum number of items to pack into an PutRecords request.
`KinesisProducerConfiguration`	`setCollectionMaxSize(long val)` Maximum amount of data to send with a PutRecords request.
`KinesisProducerConfiguration`	`setConnectTimeout(long val)` Timeout (milliseconds) for establishing TLS connections.
`KinesisProducerConfiguration`	`setCredentialsProvider(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider)` `AWSCredentialsProvider` that supplies credentials used to put records to Kinesis.
`KinesisProducerConfiguration`	`setCredentialsRefreshDelay(long val)` How often to refresh credentials (in milliseconds).
`KinesisProducerConfiguration`	`setEnableCoreDumps(boolean val)` This has no effect on Windows.
`KinesisProducerConfiguration`	`setFailIfThrottled(boolean val)` If true, throttled puts are not retried.
`KinesisProducerConfiguration`	`setGlueSchemaRegistryConfiguration(com.amazonaws.services.schemaregistry.common.configs.GlueSchemaRegistryConfiguration glueSchemaRegistryConfiguration)` Set the `GlueSchemaRegistryConfiguration` that has configuration options for Glue Schema Registry serializer to function.
`KinesisProducerConfiguration`	`setGlueSchemaRegistryCredentialsProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider)` `AwsCredentialsProvider` that supplies credentials to query AWS Glue Schema Registry.
`KinesisProducerConfiguration`	`setGlueSchemaRegistryPropertiesFilePath(String filePath)` Set the file path for GlueSchemaRegistry Properties.
`KinesisProducerConfiguration`	`setKinesisEndpoint(String val)` Use a custom Kinesis endpoint.
`KinesisProducerConfiguration`	`setKinesisPort(long val)` Server port to connect to for Kinesis.
`KinesisProducerConfiguration`	`setLogLevel(String val)` Minimum level of logs.
`KinesisProducerConfiguration`	`setMaxConnections(long val)` Maximum number of connections to open to the backend.
`KinesisProducerConfiguration`	`setMetricsCredentialsProvider(com.amazonaws.auth.AWSCredentialsProvider metricsCredentialsProvider)` `AWSCredentialsProvider` that supplies credentials used to upload metrics to CloudWatch.
`KinesisProducerConfiguration`	`setMetricsGranularity(String val)` Controls the granularity of metrics that are uploaded to CloudWatch.
`KinesisProducerConfiguration`	`setMetricsLevel(String val)` Controls the number of metrics that are uploaded to CloudWatch.
`KinesisProducerConfiguration`	`setMetricsNamespace(String val)` The namespace to upload metrics under.
`KinesisProducerConfiguration`	`setMetricsUploadDelay(long val)` Delay (in milliseconds) between each metrics upload.
`KinesisProducerConfiguration`	`setMinConnections(long val)` Minimum number of connections to keep open to the backend.
`KinesisProducerConfiguration`	`setNativeExecutable(String val)` Path to the native KPL binary.
`KinesisProducerConfiguration`	`setProxyHost(String val)` If you have users going through a proxy, set the host here.
`KinesisProducerConfiguration`	`setProxyPassword(String val)` If you have users going through a proxy, set the password here.
`KinesisProducerConfiguration`	`setProxyPort(long val)` If you have users going through a proxy, set the port here.
`KinesisProducerConfiguration`	`setProxyUserName(String val)` If you have users going through a proxy, set the user name here.
`KinesisProducerConfiguration`	`setRateLimit(long val)` Limits the maximum allowed put rate for a shard, as a percentage of the backend limits.
`KinesisProducerConfiguration`	`setRecordMaxBufferedTime(long val)` Maximum amount of time (milliseconds) a record may spend being buffered before it gets sent.
`KinesisProducerConfiguration`	`setRecordTtl(long val)` Set a time-to-live on records (milliseconds).
`KinesisProducerConfiguration`	`setRegion(String val)` Which region to send records to.
`KinesisProducerConfiguration`	`setRequestTimeout(long val)` The maximum total time (milliseconds) elapsed between when we begin a HTTP request and receiving all of the response.
`KinesisProducerConfiguration`	`setTempDirectory(String val)` Temp directory into which to extract the native binaries.
`KinesisProducerConfiguration`	`setThreadingModel(KinesisProducerConfiguration.ThreadingModel threadingModel)` Sets the threading model that the native process will use.
`KinesisProducerConfiguration`	`setThreadingModel(String threadingModel)` Sets the threading model that the native process will use.
`KinesisProducerConfiguration`	`setThreadPoolSize(int threadPoolSize)` Sets the maximum number of threads that the native process' thread pool will be configured with.
`KinesisProducerConfiguration`	`setUserRecordTimeoutInMillis(long userRecordTimeoutInMillis)` Set the value in millis when the user submitted records will be timed out at the Java layer.
`KinesisProducerConfiguration`	`setVerifyCertificate(boolean val)` Verify SSL certificates.
`protected com.amazonaws.services.kinesis.producer.protobuf.Messages.Message`	`toProtobufMessage()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KinesisProducerConfiguration
```
public KinesisProducerConfiguration()
```
- Method Detail
  - addAdditionalMetricsDimension
```
public void addAdditionalMetricsDimension(String key,
                                          String value,
                                          String granularity)
```
    Add an additional, custom dimension to the metrics emitted by the KPL.
    For example, you can make the KPL emit per-host metrics by adding HostName as the key and the domain name of the current host as the value.
    The granularity of the custom dimension must be specified with the granularity parameter. The options are "global", "stream" and "shard", just like setMetricsGranularity(String). If global is chosen, the custom dimension will be inserted before the stream name; if stream is chosen then the custom metric will be inserted after the stream name, but before the shard id. Lastly, if shard is chosen, the custom metric is inserted after the shard id.
    For example, if you want to see how different hosts are affecting a single stream, you can choose a granularity of stream for your HostName custom dimension. This will produce per-host metrics for every stream. On the other hand, if you want to see how a single host is distributing its load across different streams, you can choose a granularity of global. This will produce per-stream metrics for each host.
    Note that custom dimensions will multiplicatively increase the number of metrics emitted by the KPL into CloudWatch.
    
    Parameters:
    
    key - Name of the dimension, e.g. "HostName". Length must be between 1 and 255.
    
    value - Value of the dimension, e.g. "my-host-1.my-domain.com". Length must be between 1 and 255.
    
    granularity - Granularity of the custom dimension, must be one of "global", "stream" or "shard"
    
    Throws:
    
    IllegalArgumentException - If granularity is not one of the allowed values.
  - getCredentialsProvider
```
public com.amazonaws.auth.AWSCredentialsProvider getCredentialsProvider()
```
    AWSCredentialsProvider that supplies credentials used to put records to Kinesis. These credentials will also be used to upload metrics to CloudWatch, unless setMetricsCredentialsProvider(com.amazonaws.auth.AWSCredentialsProvider) is used to provide separate credentials for that.
    
    See Also:
    
    setCredentialsProvider(AWSCredentialsProvider)
  - setCredentialsProvider
```
public KinesisProducerConfiguration setCredentialsProvider(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider)
```
    AWSCredentialsProvider that supplies credentials used to put records to Kinesis.
    These credentials will also be used to upload metrics to CloudWatch, unless setMetricsCredentialsProvider(com.amazonaws.auth.AWSCredentialsProvider) is used to provide separate credentials for that.
    Defaults to an instance of DefaultAWSCredentialsProviderChain
    
    See Also:
    
    setMetricsCredentialsProvider(AWSCredentialsProvider)
  - getMetricsCredentialsProvider
```
public com.amazonaws.auth.AWSCredentialsProvider getMetricsCredentialsProvider()
```
    AWSCredentialsProvider that supplies credentials used to upload metrics to CloudWatch. If not given, the credentials used to put records to Kinesis are also used for CloudWatch.
    
    See Also:
    
    setMetricsCredentialsProvider(AWSCredentialsProvider)
  - setMetricsCredentialsProvider
```
public KinesisProducerConfiguration setMetricsCredentialsProvider(com.amazonaws.auth.AWSCredentialsProvider metricsCredentialsProvider)
```
    AWSCredentialsProvider that supplies credentials used to upload metrics to CloudWatch.
    If not given, the credentials used to put records to Kinesis are also used for CloudWatch.
    
    See Also:
    
    setCredentialsProvider(AWSCredentialsProvider)
  - getGlueSchemaRegistryConfiguration
```
public com.amazonaws.services.schemaregistry.common.configs.GlueSchemaRegistryConfiguration getGlueSchemaRegistryConfiguration()
```
    Return the set GlueSchemaRegistryConfiguration that has configuration options for Glue Schema Registry serializer to function.
    
    Returns:
    
    GlueSchemaRegistryConfiguration
  - setGlueSchemaRegistryConfiguration
```
public KinesisProducerConfiguration setGlueSchemaRegistryConfiguration(com.amazonaws.services.schemaregistry.common.configs.GlueSchemaRegistryConfiguration glueSchemaRegistryConfiguration)
```
    Set the GlueSchemaRegistryConfiguration that has configuration options for Glue Schema Registry serializer to function. This is an optional parameter.
    
    Parameters:
    
    glueSchemaRegistryConfiguration - GlueSchemaRegistryConfiguration instance.
    
    Returns:
    
    KinesisProducerConfiguration instance set with GlueSchemaRegistryConfiguration
  - getGlueSchemaRegistryPropertiesFilePath
```
public String getGlueSchemaRegistryPropertiesFilePath()
```
    Return the Property file path set for reading the GlueSchemaRegistryConfiguration. See GlueSchemaRegistry docs for list of supported configuration options.
    
    Returns:
    
    File path for GlueSchemaRegistry Properties.
  - setGlueSchemaRegistryPropertiesFilePath
```
public KinesisProducerConfiguration setGlueSchemaRegistryPropertiesFilePath(String filePath)
```
    Set the file path for GlueSchemaRegistry Properties. The property file will be read and GlueSchemaRegistryConfiguration instance will be created from it. This is an optional parameter and the defaults will be used if not supplied. See GlueSchemaRegistry docs for list of supported configuration options.
    
    Parameters:
    
    filePath - Filepath for GlueSchemaRegistry Properties.
    
    Returns:
    
    KinesisProducerConfiguration instance set with GlueSchemaRegistryConfiguration and glueSchemaRegistryPropertiesFilePath.
  - getGlueSchemaRegistryCredentialsProvider
```
public software.amazon.awssdk.auth.credentials.AwsCredentialsProvider getGlueSchemaRegistryCredentialsProvider()
```
    AwsCredentialsProvider that supplies credentials used to query AWS Glue Schema Registry. If not given, the credentials used to put records to Kinesis will be used.
    
    See Also:
    
    (AwsCredentialsProvider)
  - setGlueSchemaRegistryCredentialsProvider
```
public KinesisProducerConfiguration setGlueSchemaRegistryCredentialsProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider)
```
    AwsCredentialsProvider that supplies credentials to query AWS Glue Schema Registry. If not given, the AWS SDK V2 default DefaultCredentialsProvider will be used.
  - fromPropertiesFile
```
public static KinesisProducerConfiguration fromPropertiesFile(String path)
```
    Load configuration from a properties file. Any fields not found in the target file will take on default values.
    The values loaded are checked against any constraints that each respective field may have. If there are invalid values an IllegalArgumentException will be thrown.
    
    Parameters:
    
    path - Path to the properties file containing KPL config.
    
    Returns:
    
    A KinesisProducerConfiguration instance containing values loaded from the specified file.
    
    Throws:
    
    IllegalArgumentException - If one or more config values are invalid.
  - fromProperties
```
public static KinesisProducerConfiguration fromProperties(Properties props)
```
    Load configuration from a Properties object. Any fields not found in the properties instance will take on default values.
    The values loaded are checked against any constraints that each respective field may have. If there are invalid values an IllegalArgumentException will be thrown.
    
    Parameters:
    
    props - Properties object containing KPL config.
    
    Returns:
    
    A KinesisProducerConfiguration instance containing values loaded from the specified file.
    
    Throws:
    
    IllegalArgumentException - If one or more config values are invalid.
  - setCaCertPath
```
public KinesisProducerConfiguration setCaCertPath(String val)
```
    Use a provided cacert path to use which should be a full path to the cert location. When provided KPL will use this path to find certs and if empty, KPL will use the internal default certs.
  - getCaCertPath
```
public String getCaCertPath()
```
    Return the provided cacert path
  - additionalConfigsToProtobuf
```
protected com.amazonaws.services.kinesis.producer.protobuf.Config.Configuration.Builder additionalConfigsToProtobuf(com.amazonaws.services.kinesis.producer.protobuf.Config.Configuration.Builder builder)
```
  - isAggregationEnabled
```
public boolean isAggregationEnabled()
```
    Enable aggregation. With aggregation, multiple user records are packed into a single KinesisRecord. If disabled, each user record is sent in its own KinesisRecord.
    If your records are small, enabling aggregation will allow you to put many more records than you would otherwise be able to for a shard before getting throttled.
    Default: true
  - getAggregationMaxCount
```
public long getAggregationMaxCount()
```
    Maximum number of items to pack into an aggregated record.
    There should be normally no need to adjust this. If you want to limit the time records spend buffering, look into record_max_buffered_time instead.
    Default: 4294967295
    Minimum: 1
    Maximum (inclusive): 9223372036854775807
  - getAggregationMaxSize
```
public long getAggregationMaxSize()
```
    Maximum number of bytes to pack into an aggregated Kinesis record.
    There should be normally no need to adjust this. If you want to limit the time records spend buffering, look into record_max_buffered_time instead.
    If a record has more data by itself than this limit, it will bypass the aggregator. Note the backend enforces a limit of 50KB on record size. If you set this beyond 50KB, oversize records will be rejected at the backend.
    Default: 51200
    Minimum: 64
    Maximum (inclusive): 1048576
  - getCloudwatchEndpoint
```
public String getCloudwatchEndpoint()
```
    Use a custom CloudWatch endpoint.
    Note this does not accept protocols or paths, only host names or ip addresses. There is no way to disable TLS. The KPL always connects with TLS.
    Expected pattern: ^([A-Za-z0-9-\\.]+)?$
  - getCloudwatchPort
```
public long getCloudwatchPort()
```
    Server port to connect to for CloudWatch.
    Default: 443
    Minimum: 1
    Maximum (inclusive): 65535
  - getCollectionMaxCount
```
public long getCollectionMaxCount()
```
    Maximum number of items to pack into an PutRecords request.
    There should be normally no need to adjust this. If you want to limit the time records spend buffering, look into record_max_buffered_time instead.
    Default: 500
    Minimum: 1
    Maximum (inclusive): 500
  - getCollectionMaxSize
```
public long getCollectionMaxSize()
```
    Maximum amount of data to send with a PutRecords request.
    There should be normally no need to adjust this. If you want to limit the time records spend buffering, look into record_max_buffered_time instead.
    Records larger than the limit will still be sent, but will not be grouped with others.
    Default: 5242880
    Minimum: 52224
    Maximum (inclusive): 9223372036854775807
  - getConnectTimeout
```
public long getConnectTimeout()
```
    Timeout (milliseconds) for establishing TLS connections.
    Default: 6000
    Minimum: 100
    Maximum (inclusive): 300000
  - getCredentialsRefreshDelay
```
public long getCredentialsRefreshDelay()
```
    How often to refresh credentials (in milliseconds).
    During a refresh, credentials are retrieved from any SDK credentials providers attached to the wrapper and pushed to the core.
    Default: 5000
    Minimum: 1
    Maximum (inclusive): 300000
  - isEnableCoreDumps
```
public boolean isEnableCoreDumps()
```
    This has no effect on Windows.
    If set to true, the KPL native process will attempt to raise its own core file size soft limit to 128MB, or the hard limit, whichever is lower. If the soft limit is already at or above the target amount, it is not changed.
    Note that even if the limit is successfully raised (or already sufficient), it does not guarantee that core files will be written on a crash, since that is dependent on operation system settings that's beyond the control of individual processes.
    Default: false
  - isFailIfThrottled
```
public boolean isFailIfThrottled()
```
    If true, throttled puts are not retried. The records that got throttled will be failed immediately upon receiving the throttling error. This is useful if you want to react immediately to any throttling without waiting for the KPL to retry. For example, you can use a different hash key to send the throttled record to a backup shard.
    If false, the KPL will automatically retry throttled puts. The KPL performs backoff for shards that it has received throttling errors from, and will avoid flooding them with retries. Note that records may fail from expiration (see record_ttl) if they get delayed for too long because of throttling.
    Default: false
  - getKinesisEndpoint
```
public String getKinesisEndpoint()
```
    Use a custom Kinesis endpoint.
    Note this does not accept protocols or paths, only host names or ip addresses. There is no way to disable TLS. The KPL always connects with TLS.
    Expected pattern: ^([A-Za-z0-9-\\.]+)?$
  - getKinesisPort
```
public long getKinesisPort()
```
    Server port to connect to for Kinesis.
    Default: 443
    Minimum: 1
    Maximum (inclusive): 65535
  - getLogLevel
```
public String getLogLevel()
```
    Minimum level of logs. Messages below the specified level will not be logged. Logs for the native KPL daemon show up on stderr.
    Default: info
    Expected pattern: info|warning|error
  - getMaxConnections
```
public long getMaxConnections()
```
    Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections.
    Setting this too high may impact latency and consume additional resources without increasing throughput.
    Default: 24
    Minimum: 1
    Maximum (inclusive): 256
  - getMetricsGranularity
```
public String getMetricsGranularity()
```
    Controls the granularity of metrics that are uploaded to CloudWatch. Greater granularity produces more metrics.
    When "shard" is selected, metrics are emitted with the stream name and shard id as dimensions. On top of this, the same metric is also emitted with only the stream name dimension, and lastly, without the stream name. This means for a particular metric, 2 streams with 2 shards (each) will produce 7 CloudWatch metrics, one for each shard, one for each stream, and one overall, all describing the same statistics, but at different levels of granularity.
    When "stream" is selected, per shard metrics are not uploaded; when "global" is selected, only the total aggregate for all streams and all shards are uploaded.
    Consider reducing the granularity if you're not interested in shard-level metrics, or if you have a large number of shards.
    If you only have 1 stream, select "global"; the global data will be equivalent to that for the stream.
    Refer to the metrics documentation for details about each metric.
    Default: shard
    Expected pattern: global|stream|shard
  - getMetricsLevel
```
public String getMetricsLevel()
```
    Controls the number of metrics that are uploaded to CloudWatch.
    "none" disables all metrics.
    "summary" enables the following metrics: UserRecordsPut, KinesisRecordsPut, ErrorsByCode, AllErrors, BufferingTime.
    "detailed" enables all remaining metrics.
    Refer to the metrics documentation for details about each metric.
    Default: detailed
    Expected pattern: none|summary|detailed
  - getMetricsNamespace
```
public String getMetricsNamespace()
```
    The namespace to upload metrics under.
    If you have multiple applications running the KPL under the same AWS account, you should use a different namespace for each application.
    If you are also using the KCL, you may wish to use the application name you have configured for the KCL as the the namespace here. This way both your KPL and KCL metrics show up under the same namespace.
    Default: KinesisProducerLibrary
    Expected pattern: (?!AWS/).{1,255}
  - getMetricsUploadDelay
```
public long getMetricsUploadDelay()
```
    Delay (in milliseconds) between each metrics upload.
    For testing only. There is no benefit in setting this lower or higher in production.
    Default: 60000
    Minimum: 1
    Maximum (inclusive): 60000
  - getMinConnections
```
public long getMinConnections()
```
    Minimum number of connections to keep open to the backend.
    There should be no need to increase this in general.
    Default: 1
    Minimum: 1
    Maximum (inclusive): 16
  - getNativeExecutable
```
public String getNativeExecutable()
```
    Path to the native KPL binary. Only use this setting if you want to use a custom build of the native code.
  - getRateLimit
```
public long getRateLimit()
```
    Limits the maximum allowed put rate for a shard, as a percentage of the backend limits.
    The rate limit prevents the producer from sending data too fast to a shard. Such a limit is useful for reducing bandwidth and CPU cycle wastage from sending requests that we know are going to fail from throttling.
    Kinesis enforces limits on both the number of records and number of bytes per second. This setting applies to both.
    The default value of 150% is chosen to allow a single producer instance to completely saturate the allowance for a shard. This is an aggressive setting. If you prefer to reduce throttling errors rather than completely saturate the shard, consider reducing this setting.
    Default: 150
    Minimum: 1
    Maximum (inclusive): 9223372036854775807
  - getRecordMaxBufferedTime
```
public long getRecordMaxBufferedTime()
```
    Maximum amount of time (milliseconds) a record may spend being buffered before it gets sent. Records may be sent sooner than this depending on the other buffering limits.
    This setting provides coarse ordering among records - any two records will be reordered by no more than twice this amount (assuming no failures and retries and equal network latency).
    The library makes a best effort to enforce this time, but cannot guarantee that it will be precisely met. In general, if the CPU is not overloaded, the library will meet this deadline to within 10ms.
    Failures and retries can additionally increase the amount of time records spend in the KPL. If your application cannot tolerate late records, use the record_ttl setting to drop records that do not get transmitted in time.
    Setting this too low can negatively impact throughput.
    Default: 100
    Maximum (inclusive): 9223372036854775807
  - getRecordTtl
```
public long getRecordTtl()
```
    Set a time-to-live on records (milliseconds). Records that do not get successfully put within the limit are failed.
    This setting is useful if your application cannot or does not wish to tolerate late records. Records will still incur network latency after they leave the KPL, so take that into consideration when choosing a value for this setting.
    If you do not wish to lose records and prefer to retry indefinitely, set record_ttl to a large value like INT_MAX. This has the potential to cause head-of-line blocking if network issues or throttling occur. You can respond to such situations by using the metrics reporting functions of the KPL. You may also set fail_if_throttled to true to prevent automatic retries in case of throttling.
    Default: 30000
    Minimum: 100
    Maximum (inclusive): 9223372036854775807
  - getRegion
```
public String getRegion()
```
    Which region to send records to.
    If you do not specify the region and are running in EC2, the library will use the region the instance is in.
    The region is also used to sign requests.
    Expected pattern: ^([a-z]+-([a-z]+-)?[a-z]+-[0-9])?$
  - getRequestTimeout
```
public long getRequestTimeout()
```
    The maximum total time (milliseconds) elapsed between when we begin a HTTP request and receiving all of the response. If it goes over, the request will be timed-out.
    Note that a timed-out request may actually succeed at the backend. Retrying then leads to duplicates. Setting the timeout too low will therefore increase the probability of duplicates.
    Default: 6000
    Minimum: 100
    Maximum (inclusive): 600000
  - getTempDirectory
```
public String getTempDirectory()
```
    Temp directory into which to extract the native binaries. The KPL requires write permissions in this directory.
    If not specified, defaults to /tmp in Unix. (Windows TBD)
  - isVerifyCertificate
```
public boolean isVerifyCertificate()
```
    Verify SSL certificates. Always enable in production for security.
    Default: true
  - getProxyHost
```
public String getProxyHost()
```
    If you have users going through a proxy, get the host here.
    Default: ""
  - getProxyPort
```
public long getProxyPort()
```
    If you have users going through a proxy, get the port here.
    Default: 443
  - getProxyUserName
```
public String getProxyUserName()
```
    If you have users going through a proxy, get the user name here.
    Default: ""
  - getProxyPassword
```
public String getProxyPassword()
```
    If you have users going through a proxy, get the password here.
    Default: ""
  - getThreadingModel
```
public KinesisProducerConfiguration.ThreadingModel getThreadingModel()
```
    Returns the threading model that the native process will use to handle requests to AWS services
    
    Returns:
    
    the KinesisProducerConfiguration.ThreadingModel the native process will use.
  - getThreadPoolSize
```
public int getThreadPoolSize()
```
    This configures the maximum number of threads the thread pool in the native process will use. This is only used when getThreadingModel() is set to KinesisProducerConfiguration.ThreadingModel.POOLED.
    
    Default
    
    The default value is 0 which allows the native process to choose the size of the thread pool
    
    Maximum
    
    There is no specific maximum, but operation systems may impose a maximum. If the native process exceeds that maximum it may be terminated.
    
    Returns:
    
    the size of the thread pool for the native process.
  - getUserRecordTimeoutInMillis
```
public long getUserRecordTimeoutInMillis()
```
    Value in millis when the user submitted records will be timed out at the Java layer.
    There should be normally no need to adjust this and by default this will be off. But if you are seeing too much outstanding records causing memory problems you can adjust this value based on your readings from getOldestRecordTimeInMillis and when your application starts to have memory problems.
    Default: 0(Off)
    Minimum: 0
    Maximum (inclusive): 9223372036854775807
  - setAggregationEnabled
```
public KinesisProducerConfiguration setAggregationEnabled(boolean val)
```
    Enable aggregation. With aggregation, multiple user records are packed into a single KinesisRecord. If disabled, each user record is sent in its own KinesisRecord.
    If your records are small, enabling aggregation will allow you to put many more records than you would otherwise be able to for a shard before getting throttled.
    Default: true
  - setAggregationMaxCount
```
public KinesisProducerConfiguration setAggregationMaxCount(long val)
```
    Maximum number of items to pack into an aggregated record.
    There should be normally no need to adjust this. If you want to limit the time records spend buffering, look into record_max_buffered_time instead.
    Default: 4294967295
    Minimum: 1
    Maximum (inclusive): 9223372036854775807
  - setAggregationMaxSize
```
public KinesisProducerConfiguration setAggregationMaxSize(long val)
```
    Maximum number of bytes to pack into an aggregated Kinesis record.
    There should be normally no need to adjust this. If you want to limit the time records spend buffering, look into record_max_buffered_time instead.
    If a record has more data by itself than this limit, it will bypass the aggregator. Note the backend enforces a limit of 50KB on record size. If you set this beyond 50KB, oversize records will be rejected at the backend.
    Default: 51200
    Minimum: 64
    Maximum (inclusive): 1048576
  - setCloudwatchEndpoint
```
public KinesisProducerConfiguration setCloudwatchEndpoint(String val)
```
    Use a custom CloudWatch endpoint.
    Note this does not accept protocols or paths, only host names or ip addresses. There is no way to disable TLS. The KPL always connects with TLS.
    Expected pattern: ^([A-Za-z0-9-\\.]+)?$
  - setCloudwatchPort
```
public KinesisProducerConfiguration setCloudwatchPort(long val)
```
    Server port to connect to for CloudWatch.
    Default: 443
    Minimum: 1
    Maximum (inclusive): 65535
  - setCollectionMaxCount
```
public KinesisProducerConfiguration setCollectionMaxCount(long val)
```
    Maximum number of items to pack into an PutRecords request.
    There should be normally no need to adjust this. If you want to limit the time records spend buffering, look into record_max_buffered_time instead.
    Default: 500
    Minimum: 1
    Maximum (inclusive): 500
  - setCollectionMaxSize
```
public KinesisProducerConfiguration setCollectionMaxSize(long val)
```
    Maximum amount of data to send with a PutRecords request.
    There should be normally no need to adjust this. If you want to limit the time records spend buffering, look into record_max_buffered_time instead.
    Records larger than the limit will still be sent, but will not be grouped with others.
    Default: 5242880
    Minimum: 52224
    Maximum (inclusive): 9223372036854775807
  - setConnectTimeout
```
public KinesisProducerConfiguration setConnectTimeout(long val)
```
    Timeout (milliseconds) for establishing TLS connections.
    Default: 6000
    Minimum: 100
    Maximum (inclusive): 300000
  - setCredentialsRefreshDelay
```
public KinesisProducerConfiguration setCredentialsRefreshDelay(long val)
```
    How often to refresh credentials (in milliseconds).
    During a refresh, credentials are retrieved from any SDK credentials providers attached to the wrapper and pushed to the core.
    Default: 5000
    Minimum: 1
    Maximum (inclusive): 300000
  - setEnableCoreDumps
```
public KinesisProducerConfiguration setEnableCoreDumps(boolean val)
```
    This has no effect on Windows.
    If set to true, the KPL native process will attempt to raise its own core file size soft limit to 128MB, or the hard limit, whichever is lower. If the soft limit is already at or above the target amount, it is not changed.
    Note that even if the limit is successfully raised (or already sufficient), it does not guarantee that core files will be written on a crash, since that is dependent on operation system settings that's beyond the control of individual processes.
    Default: false
  - setFailIfThrottled
```
public KinesisProducerConfiguration setFailIfThrottled(boolean val)
```
    If true, throttled puts are not retried. The records that got throttled will be failed immediately upon receiving the throttling error. This is useful if you want to react immediately to any throttling without waiting for the KPL to retry. For example, you can use a different hash key to send the throttled record to a backup shard.
    If false, the KPL will automatically retry throttled puts. The KPL performs backoff for shards that it has received throttling errors from, and will avoid flooding them with retries. Note that records may fail from expiration (see record_ttl) if they get delayed for too long because of throttling.
    Default: false
  - setKinesisEndpoint
```
public KinesisProducerConfiguration setKinesisEndpoint(String val)
```
    Use a custom Kinesis endpoint.
    Note this does not accept protocols or paths, only host names or ip addresses. There is no way to disable TLS. The KPL always connects with TLS.
    Expected pattern: ^([A-Za-z0-9-\\.]+)?$
  - setKinesisPort
```
public KinesisProducerConfiguration setKinesisPort(long val)
```
    Server port to connect to for Kinesis.
    Default: 443
    Minimum: 1
    Maximum (inclusive): 65535
  - setLogLevel
```
public KinesisProducerConfiguration setLogLevel(String val)
```
    Minimum level of logs. Messages below the specified level will not be logged. Logs for the native KPL daemon show up on stderr.
    Default: info
    Expected pattern: trace|debug|info|warning|error
  - setMaxConnections
```
public KinesisProducerConfiguration setMaxConnections(long val)
```
    Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections.
    Setting this too high may impact latency and consume additional resources without increasing throughput.
    Default: 24
    Minimum: 1
    Maximum (inclusive): 256
  - setMetricsGranularity
```
public KinesisProducerConfiguration setMetricsGranularity(String val)
```
    Controls the granularity of metrics that are uploaded to CloudWatch. Greater granularity produces more metrics.
    When "shard" is selected, metrics are emitted with the stream name and shard id as dimensions. On top of this, the same metric is also emitted with only the stream name dimension, and lastly, without the stream name. This means for a particular metric, 2 streams with 2 shards (each) will produce 7 CloudWatch metrics, one for each shard, one for each stream, and one overall, all describing the same statistics, but at different levels of granularity.
    When "stream" is selected, per shard metrics are not uploaded; when "global" is selected, only the total aggregate for all streams and all shards are uploaded.
    Consider reducing the granularity if you're not interested in shard-level metrics, or if you have a large number of shards.
    If you only have 1 stream, select "global"; the global data will be equivalent to that for the stream.
    Refer to the metrics documentation for details about each metric.
    Default: shard
    Expected pattern: global|stream|shard
  - setMetricsLevel
```
public KinesisProducerConfiguration setMetricsLevel(String val)
```
    Controls the number of metrics that are uploaded to CloudWatch.
    "none" disables all metrics.
    "summary" enables the following metrics: UserRecordsPut, KinesisRecordsPut, ErrorsByCode, AllErrors, BufferingTime.
    "detailed" enables all remaining metrics.
    Refer to the metrics documentation for details about each metric.
    Default: detailed
    Expected pattern: none|summary|detailed
  - setMetricsNamespace
```
public KinesisProducerConfiguration setMetricsNamespace(String val)
```
    The namespace to upload metrics under.
    If you have multiple applications running the KPL under the same AWS account, you should use a different namespace for each application.
    If you are also using the KCL, you may wish to use the application name you have configured for the KCL as the the namespace here. This way both your KPL and KCL metrics show up under the same namespace.
    Default: KinesisProducerLibrary
    Expected pattern: (?!AWS/).{1,255}
  - setMetricsUploadDelay
```
public KinesisProducerConfiguration setMetricsUploadDelay(long val)
```
    Delay (in milliseconds) between each metrics upload.
    For testing only. There is no benefit in setting this lower or higher in production.
    Default: 60000
    Minimum: 1
    Maximum (inclusive): 60000
  - setMinConnections
```
public KinesisProducerConfiguration setMinConnections(long val)
```
    Minimum number of connections to keep open to the backend.
    There should be no need to increase this in general.
    Default: 1
    Minimum: 1
    Maximum (inclusive): 16
  - setNativeExecutable
```
public KinesisProducerConfiguration setNativeExecutable(String val)
```
    Path to the native KPL binary. Only use this setting if you want to use a custom build of the native code.
  - setRateLimit
```
public KinesisProducerConfiguration setRateLimit(long val)
```
    Limits the maximum allowed put rate for a shard, as a percentage of the backend limits.
    The rate limit prevents the producer from sending data too fast to a shard. Such a limit is useful for reducing bandwidth and CPU cycle wastage from sending requests that we know are going to fail from throttling.
    Kinesis enforces limits on both the number of records and number of bytes per second. This setting applies to both.
    The default value of 150% is chosen to allow a single producer instance to completely saturate the allowance for a shard. This is an aggressive setting. If you prefer to reduce throttling errors rather than completely saturate the shard, consider reducing this setting.
    Default: 150
    Minimum: 1
    Maximum (inclusive): 9223372036854775807
  - setRecordMaxBufferedTime
```
public KinesisProducerConfiguration setRecordMaxBufferedTime(long val)
```
    Maximum amount of time (milliseconds) a record may spend being buffered before it gets sent. Records may be sent sooner than this depending on the other buffering limits.
    This setting provides coarse ordering among records - any two records will be reordered by no more than twice this amount (assuming no failures and retries and equal network latency).
    The library makes a best effort to enforce this time, but cannot guarantee that it will be precisely met. In general, if the CPU is not overloaded, the library will meet this deadline to within 10ms.
    Failures and retries can additionally increase the amount of time records spend in the KPL. If your application cannot tolerate late records, use the record_ttl setting to drop records that do not get transmitted in time.
    Setting this too low can negatively impact throughput.
    Default: 100
    Maximum (inclusive): 9223372036854775807
  - setRecordTtl
```
public KinesisProducerConfiguration setRecordTtl(long val)
```
    Set a time-to-live on records (milliseconds). Records that do not get successfully put within the limit are failed.
    This setting is useful if your application cannot or does not wish to tolerate late records. Records will still incur network latency after they leave the KPL, so take that into consideration when choosing a value for this setting.
    If you do not wish to lose records and prefer to retry indefinitely, set record_ttl to a large value like INT_MAX. This has the potential to cause head-of-line blocking if network issues or throttling occur. You can respond to such situations by using the metrics reporting functions of the KPL. You may also set fail_if_throttled to true to prevent automatic retries in case of throttling.
    Default: 30000
    Minimum: 100
    Maximum (inclusive): 9223372036854775807
  - setRegion
```
public KinesisProducerConfiguration setRegion(String val)
```
    Which region to send records to.
    If you do not specify the region and are running in EC2, the library will use the region the instance is in.
    The region is also used to sign requests.
    Expected pattern: ^([a-z]+-([a-z]+-)?[a-z]+-[0-9])?$
  - setRequestTimeout
```
public KinesisProducerConfiguration setRequestTimeout(long val)
```
    The maximum total time (milliseconds) elapsed between when we begin a HTTP request and receiving all of the response. If it goes over, the request will be timed-out.
    Note that a timed-out request may actually succeed at the backend. Retrying then leads to duplicates. Setting the timeout too low will therefore increase the probability of duplicates.
    Default: 6000
    Minimum: 100
    Maximum (inclusive): 600000
  - setTempDirectory
```
public KinesisProducerConfiguration setTempDirectory(String val)
```
    Temp directory into which to extract the native binaries. The KPL requires write permissions in this directory.
    If not specified, defaults to /tmp in Unix. (Windows TBD)
  - setVerifyCertificate
```
public KinesisProducerConfiguration setVerifyCertificate(boolean val)
```
    Verify SSL certificates. Always enable in production for security.
    Default: true
  - setProxyHost
```
public KinesisProducerConfiguration setProxyHost(String val)
```
    If you have users going through a proxy, set the host here.
    For example: "https://proxy.example.com" or IP address "192.168.0.1"
    Default: ""
  - setProxyPort
```
public KinesisProducerConfiguration setProxyPort(long val)
```
    If you have users going through a proxy, set the port here.
    Default: 443
    Minimum: 1
    Maximum (inclusive): 65535
  - setProxyUserName
```
public KinesisProducerConfiguration setProxyUserName(String val)
```
    If you have users going through a proxy, set the user name here.
    Default: ""
  - setProxyPassword
```
public KinesisProducerConfiguration setProxyPassword(String val)
```
    If you have users going through a proxy, set the password here.
    Default: ""
  - setThreadingModel
```
public KinesisProducerConfiguration setThreadingModel(KinesisProducerConfiguration.ThreadingModel threadingModel)
```
    Sets the threading model that the native process will use. See getThreadingModel() for more information
    
    Parameters:
    
    threadingModel - the threading model to use
    
    Returns:
    
    this configuration object
  - setThreadingModel
```
public KinesisProducerConfiguration setThreadingModel(String threadingModel)
```
    Sets the threading model that the native process will use.
    See getThreadingModel() for more information
    Valid inputs: PER_REQUEST - Tells the native process to create a thread per request. POOLED - Tells the native process to use a thread pool. The size of the pool can be controlled by ThreadPoolSize.
    
    Parameters:
    
    threadingModel - the String representation of the threading model to use.
    
    Returns:
    
    this configuration object
  - setThreadPoolSize
```
public KinesisProducerConfiguration setThreadPoolSize(int threadPoolSize)
```
    Sets the maximum number of threads that the native process' thread pool will be configured with. See getThreadPoolSize() for more information
    
    Parameters:
    
    threadPoolSize - the maximum number of threads that the thread pool can use.
    
    Returns:
    
    this configuration object
    
    Throws:
    
    IllegalArgumentException - if threadPoolSize is less than 0
  - setUserRecordTimeoutInMillis
```
public KinesisProducerConfiguration setUserRecordTimeoutInMillis(long userRecordTimeoutInMillis)
```
    Set the value in millis when the user submitted records will be timed out at the Java layer. Please be careful around setting this value and not to set it too low which can cause high amount records timing out.
    There should be normally no need to adjust this and by default this will be off (value set to 0). But if you are seeing too much outstanding records causing memory problems you can adjust this value based on your readings from getOldestRecordTimeInMillis and when your application starts to have memory problems.
    
    Parameters:
    
    userRecordTimeoutInMillis - the value in millis when the user submitted records will be timed out at the Java layer
    
    Returns:
    
    this configuration object
    
    Throws:
    
    IllegalArgumentException - if userRecordTimeoutInMillis is less than 0
  - toProtobufMessage
```
protected com.amazonaws.services.kinesis.producer.protobuf.Messages.Message toProtobufMessage()
```

Class KinesisProducerConfiguration

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KinesisProducerConfiguration

Method Detail

addAdditionalMetricsDimension

getCredentialsProvider

setCredentialsProvider

getMetricsCredentialsProvider

setMetricsCredentialsProvider

getGlueSchemaRegistryConfiguration

setGlueSchemaRegistryConfiguration

getGlueSchemaRegistryPropertiesFilePath

setGlueSchemaRegistryPropertiesFilePath

getGlueSchemaRegistryCredentialsProvider

setGlueSchemaRegistryCredentialsProvider

fromPropertiesFile

fromProperties

setCaCertPath

getCaCertPath

additionalConfigsToProtobuf

isAggregationEnabled

getAggregationMaxCount

getAggregationMaxSize

getCloudwatchEndpoint

getCloudwatchPort

getCollectionMaxCount

getCollectionMaxSize

getConnectTimeout

getCredentialsRefreshDelay

isEnableCoreDumps

isFailIfThrottled

getKinesisEndpoint

getKinesisPort

getLogLevel

getMaxConnections

getMetricsGranularity

getMetricsLevel

getMetricsNamespace

getMetricsUploadDelay

getMinConnections

getNativeExecutable

getRateLimit

getRecordMaxBufferedTime

getRecordTtl

getRegion

getRequestTimeout

getTempDirectory

isVerifyCertificate

getProxyHost

getProxyPort

getProxyUserName

getProxyPassword

getThreadingModel

getThreadPoolSize

getUserRecordTimeoutInMillis

setAggregationEnabled

setAggregationMaxCount

setAggregationMaxSize

setCloudwatchEndpoint

setCloudwatchPort

setCollectionMaxCount

setCollectionMaxSize

setConnectTimeout

setCredentialsRefreshDelay

setEnableCoreDumps

setFailIfThrottled

setKinesisEndpoint

setKinesisPort

setLogLevel

setMaxConnections

setMetricsGranularity

setMetricsLevel

setMetricsNamespace

setMetricsUploadDelay

setMinConnections

setNativeExecutable