Package software.amazon.awssdk.services.iotfleetwise.model

Interface SignalInformation.Builder

    • Method Detail

      • name

        SignalInformation.Builder name​(String name)

        The name of the signal.

        Parameters:
        name - The name of the signal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxSampleCount

        SignalInformation.Builder maxSampleCount​(Long maxSampleCount)

        The maximum number of samples to collect.

        Parameters:
        maxSampleCount - The maximum number of samples to collect.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • minimumSamplingIntervalMs

        SignalInformation.Builder minimumSamplingIntervalMs​(Long minimumSamplingIntervalMs)

        The minimum duration of time (in milliseconds) between two triggering events to collect data.

        If a signal changes often, you might want to collect data at a slower rate.

        Parameters:
        minimumSamplingIntervalMs - The minimum duration of time (in milliseconds) between two triggering events to collect data.

        If a signal changes often, you might want to collect data at a slower rate.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataPartitionId

        SignalInformation.Builder dataPartitionId​(String dataPartitionId)

        The ID of the data partition this signal is associated with.

        The ID must match one of the IDs provided in dataPartitions. This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type.

        If you upload a signal as a condition for a campaign's data partition, the same signal must be included in signalsToCollect.

        Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

        Parameters:
        dataPartitionId - The ID of the data partition this signal is associated with.

        The ID must match one of the IDs provided in dataPartitions. This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type.

        If you upload a signal as a condition for a campaign's data partition, the same signal must be included in signalsToCollect.

        Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.