Constructor
new IoTSiteWiseConfig(identifier, 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. |
batchSize |
Number
|
null
|
The maximum size of a batch to send to the destination. Messages will be queued until the batch size is reached, after which they will then be uploaded. If unspecified the default will be 10.
If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met.
The minimum batch size is 1 and the maximum is 10. |
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 the destination. Messages will be queued until the batch size is reached, after which they will then be uploaded. If unspecified the default will be 10.
If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met.
The minimum batch size is 1 and the maximum is 10.
- 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:
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
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.IoTSiteWiseConfig
Parameters:
| Name |
Type |
Description |
value |
Number
|
The maximum size of a batch to send to the destination. Messages will be queued until the batch size is reached, after which they will then be uploaded. If unspecified the default will be 10.
If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met.
The minimum batch size is 1 and the maximum is 10. |
- Source:
Returns:
-
Type
-
aws-greengrass-core-sdk.StreamManager.IoTSiteWiseConfig
Parameters:
| Name |
Type |
Description |
value |
Boolean
|
Enable or disable this export. Default is false. |
- Source:
Returns:
-
Type
-
aws-greengrass-core-sdk.StreamManager.IoTSiteWiseConfig
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.IoTSiteWiseConfig
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.IoTSiteWiseConfig
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.IoTSiteWiseConfig