Class: IoTAnalyticsConfig

aws-greengrass-core-sdk.StreamManager~IoTAnalyticsConfig(identifier, iotChannel, iotMsgIdPrefix, batchSize, batchIntervalMillis, priority, startSequenceNumber, disabled)

Configuration object for IoT Analytics export destination.

Constructor

new IoTAnalyticsConfig(identifier, iotChannel, iotMsgIdPrefix, batchSize, batchIntervalMillis, priority, startSequenceNumber, disabled)

Parameters:
Name Type Default Description
identifier String null A unique identifier to identify this individual upload stream. Must be an alphanumeric string including spaces, commas, periods, hyphens, and underscores with length between 1 and 255.
iotChannel String null The name of the IoT Analytics Channel that this exporter should upload to.
iotMsgIdPrefix String null A string prefixed to each unique message id. After this prefix, StreamManager may append more data to make the message ID unique. This prefix must be less than 32 characters.
batchSize Number null The maximum size of a batch to send to IoT Analytics. Messages will be queued until the batch size is reached, after which they will then be uploaded. If unspecified the default will be 100. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The batch size must be between 1 and 100.
batchIntervalMillis Number null The time in milliseconds between the earliest un-uploaded message and the current time. If this time is exceeded, messages will be uploaded in the next batch. If unspecified messages will be eligible for upload immediately. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The minimum value is 60000 milliseconds and the maximum is 9223372036854 milliseconds.
priority Number null Priority for this upload stream. Lower values are higher priority. If not specified it will have the lowest priority.
startSequenceNumber Number null The sequence number of the message to use as the starting message in the export. Default is 0. The sequence number provided should be less than the newest sequence number in the stream, i.e., sequence number of the last messaged appended. To find the newest sequence number, describe the stream and then check the storage status of the returned MessageStreamInfo object.
disabled Boolean null Enable or disable this export. Default is false.
Source:

Members

batchIntervalMillis

The time in milliseconds between the earliest un-uploaded message and the current time. If this time is exceeded, messages will be uploaded in the next batch. If unspecified messages will be eligible for upload immediately. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The minimum value is 60000 milliseconds and the maximum is 9223372036854 milliseconds.
Source:

batchIntervalMillis

Source:

batchSize

The maximum size of a batch to send to IoT Analytics. Messages will be queued until the batch size is reached, after which they will then be uploaded. If unspecified the default will be 100. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The batch size must be between 1 and 100.
Source:

batchSize

Source:

disabled

Enable or disable this export. Default is false.
Source:

disabled

Source:

identifier

A unique identifier to identify this individual upload stream. Must be an alphanumeric string including spaces, commas, periods, hyphens, and underscores with length between 1 and 255.
Source:

identifier

Source:

iotChannel

The name of the IoT Analytics Channel that this exporter should upload to.
Source:

iotChannel

Source:

iotMsgIdPrefix

A string prefixed to each unique message id. After this prefix, StreamManager may append more data to make the message ID unique. This prefix must be less than 32 characters.
Source:

iotMsgIdPrefix

Source:

priority

Priority for this upload stream. Lower values are higher priority. If not specified it will have the lowest priority.
Source:

priority

Source:

startSequenceNumber

The sequence number of the message to use as the starting message in the export. Default is 0. The sequence number provided should be less than the newest sequence number in the stream, i.e., sequence number of the last messaged appended. To find the newest sequence number, describe the stream and then check the storage status of the returned MessageStreamInfo object.
Source:

startSequenceNumber

Source:

Methods

withBatchIntervalMillis(value) → {aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig}

Parameters:
Name Type Description
value Number The time in milliseconds between the earliest un-uploaded message and the current time. If this time is exceeded, messages will be uploaded in the next batch. If unspecified messages will be eligible for upload immediately. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The minimum value is 60000 milliseconds and the maximum is 9223372036854 milliseconds.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig

withBatchSize(value) → {aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig}

Parameters:
Name Type Description
value Number The maximum size of a batch to send to IoT Analytics. Messages will be queued until the batch size is reached, after which they will then be uploaded. If unspecified the default will be 100. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The batch size must be between 1 and 100.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig

withDisabled(value) → {aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig}

Parameters:
Name Type Description
value Boolean Enable or disable this export. Default is false.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig

withIdentifier(value) → {aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig}

Parameters:
Name Type Description
value String A unique identifier to identify this individual upload stream. Must be an alphanumeric string including spaces, commas, periods, hyphens, and underscores with length between 1 and 255.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig

withIotChannel(value) → {aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig}

Parameters:
Name Type Description
value String The name of the IoT Analytics Channel that this exporter should upload to.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig

withIotMsgIdPrefix(value) → {aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig}

Parameters:
Name Type Description
value String A string prefixed to each unique message id. After this prefix, StreamManager may append more data to make the message ID unique. This prefix must be less than 32 characters.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig

withPriority(value) → {aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig}

Parameters:
Name Type Description
value Number Priority for this upload stream. Lower values are higher priority. If not specified it will have the lowest priority.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig

withStartSequenceNumber(value) → {aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig}

Parameters:
Name Type Description
value Number The sequence number of the message to use as the starting message in the export. Default is 0. The sequence number provided should be less than the newest sequence number in the stream, i.e., sequence number of the last messaged appended. To find the newest sequence number, describe the stream and then check the storage status of the returned MessageStreamInfo object.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.IoTAnalyticsConfig